RESTful Edit Management Interface for Oracle WebLogic Server

GET A Create Form For This WLDF Scale Up Action Collection

get

/management/weblogic/{version}/edit/WLDFSystemResources/{name}/WLDFResource/watchNotification/scaleUpActionCreateForm

This resource returns a pre-populated WLDF scale up action model that can be customized then posted (using the POST method) to the scaleUpActions collection resource to create a new WLDF scale up action.

Request

Path Parameters

name(required): string

The name property of the instance in the collection.
version(required): string

The version of the WebLogic REST interface.

Query Parameters

excludeFields: string

The 'excludeFields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields whose name is not on the list will be returned. If not present, all fields are returned (unless the 'fields' query parameter is specified). Note: 'fields' must not be specified if 'excludeFields' is specified.
excludeLinks: string

The 'excludeLinks' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links whose relationship name is not on the list will be returned. If not present, all links are returned (unless the 'links' query parameter is specified). Note: 'links' must not be specified if 'excludeLinks' is specified.
fields: string

The 'fields' query parameter is used to restrict which fields are returned in the response. It is a comma separated list of field names. If present, only fields with matching names are returned. If not present, all fields are returned (unless the 'excludeFields' query parameter is specified). Note: 'excludeFields' must not be specified if 'fields' is specified.
links: string

The 'links' query parameter is used to restrict which links are returned in the response. It is a comma separated list of link relationship names. If present, only links with matching relationship names are returned. If not present, all links are returned (unless the 'excludeLinks' query parameter is specified). Note: 'excludeLinks' must not be specified if 'links' is specified.

Security

Admin: basic

Type: basic

Description: A user in the Admin security role.
Deployer: basic

Type: basic

Description: A user in the Deployer security role.
Monitor: basic

Type: basic

Description: A user in the Monitor security role.
Operator: basic

Type: basic

Description: A user in the Operator security role.

Response

Supported Media Types

application/json

200 Response

Returns this WLDF scale up action.

This method can return the following links:

rel=create uri=/management/weblogic/{version}/edit/WLDFSystemResources/{name}/WLDFResource/watchNotification/scaleUpActions
The collection resource for this create form resource.

Root Schema : WLDF Scale Up Action

Type: object

Show Source

clusterName: string
Indicates the name of the cluster to perform the scaling action on.
Constraints
- legal null
enabled: boolean

Default Value: true

Specifies whether this action is enabled.
id: integer(int64)

Read Only: true

Return the unique id of this bean instance.
name: string

Read Only: true

The name of the WebLogic Diagnostic Framework (WLDF) bean.
scalingSize: integer(int32)

Minimum Value: 1

Default Value: 1

Indicates the number of instances to scale by when the action is invoked.
timeout: integer(int32)

Minimum Value: 0

Default Value: 0

The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.

{
    "type":"object",
    "properties":{
        "clusterName":{
            "x-weblogic-legalNull":true,
            "type":"string",
            "description":"<p>Indicates the name of the cluster to perform the scaling action on.</p><p><h5>Constraints</h5></p><ul><li>legal null</li></ul>"
        },
        "enabled":{
            "default":true,
            "type":"boolean",
            "description":"<p>Specifies whether this action is enabled.</p>"
        },
        "id":{
            "readOnly":true,
            "type":"integer",
            "format":"int64",
            "description":"<p> Return the unique id of this bean instance.</p>"
        },
        "name":{
            "readOnly":true,
            "type":"string",
            "description":"<p>The name of the WebLogic Diagnostic Framework (WLDF) bean.</p>"
        },
        "scalingSize":{
            "default":"1",
            "minimum":"1",
            "type":"integer",
            "format":"int32",
            "description":"<p>Indicates the number of instances to scale by when the action is invoked.</p>"
        },
        "timeout":{
            "default":"0",
            "minimum":"0",
            "type":"integer",
            "format":"int32",
            "description":"<p>The length of time, in seconds, that an action has to complete execution. By default, the timeout period is 0, which disables the action timeout.</p>"
        }
    },
    "description":""
}