REST API for Oracle Java Cloud Service

Disable or Enable the Load Balancer

put

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/loadbalancer/public/{command}

Disables or enables the load balancer for the specified Oracle Java Cloud Service instance.

The load balancer for the service instance could be Oracle Traffic Director or an instance of Oracle Cloud Infrastructure Load Balancing Classic. An instance of Oracle Cloud Infrastructure Load Balancing cannot be disabled or enabled.

Request

Supported Media Types

application/json

Path Parameters

command: string

Command to manage the state of the load balancer. Valid values: disable and enable
identityDomainId: string

Identity domain ID for the Oracle Java Cloud Service account.
serviceId: string

Name of the Oracle Java Cloud Service instance.

Header Parameters

Authorization: string

Base64 encoded user name and password separated by a colon or OAuth access token obtained from Oracle Identity Cloud Service. See Authenticate.
X-ID-TENANT-NAME: string

Identity domain ID for the Oracle Java Cloud Service account.

The request consumes an application/json payload. However, no parameters are supported in the payload at this time.

Root Schema : loadbalancer-request

The request consumes an application/json payload. However, no parameters are supported in the payload at this time.

Response

Supported Media Types

application/json

202 Response

Accepted. The Location header returns a URI that can be used to view the job status. See View the Status of an Operation by Job Id.

See Status Codes for information about other possible HTTP status codes.

Root Schema : loadbalancer-response

Type: object

The response body contains information about the operation. It can include an issues array.

Show Source

details: object details

Groups details of the operation.

{
    "description":"The response body contains information about the operation. It can include an <code>issues</code> array.",
    "properties":{
        "details":{
            "type":"object",
            "description":"Groups details of the operation.",
            "properties":{
                "jobId":{
                    "type":"string",
                    "description":"Job ID for the operation. Not available if the response status code is 400."
                },
                "message":{
                    "type":"string",
                    "description":"System message that describes the operation."
                },
                "issues":{
                    "type":"array",
                    "description":"Groups strings of warning or error messages, if available.",
                    "items":{
                        "type":"string"
                    }
                }
            },
            "required":[
                "jobId",
                "message"
            ]
        }
    },
    "required":[
        "details"
    ]
}

Nested Schema : details

Type: object

Groups details of the operation.

Show Source

issues(optional): array issues

Groups strings of warning or error messages, if available.
jobId: string

Job ID for the operation. Not available if the response status code is 400.
message: string

System message that describes the operation.

{
    "type":"object",
    "description":"Groups details of the operation.",
    "properties":{
        "jobId":{
            "type":"string",
            "description":"Job ID for the operation. Not available if the response status code is 400."
        },
        "message":{
            "type":"string",
            "description":"System message that describes the operation."
        },
        "issues":{
            "type":"array",
            "description":"Groups strings of warning or error messages, if available.",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "jobId",
        "message"
    ]
}

Nested Schema : issues

Type: array

Groups strings of warning or error messages, if available.

Show Source

Array of: string

{
    "type":"array",
    "description":"Groups strings of warning or error messages, if available.",
    "items":{
        "type":"string"
    }
}

Examples

The following example shows how to disable or enable the load balancer by submitting a PUT request on the REST resource using cURL.

Note: The command in the example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the REST server to contact for your identity domain (or Cloud Account). See Send Requests.

cURL Command

curl -i -X PUT -u username:password -d @emptyfile.json -H "Content-Type:application/json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance/loadbalancer/public/disable

curl -i -X PUT -u username:password -d @emptyfile.json -H "Content-Type:application/json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance/loadbalancer/public/enable

Note: You can omit the -d option. No parameters are supported in the request payload at this time.

Example of Response Header

The following shows an example of the response header. The Location header returns the URI that can be used to view the job status. See View the Status of an Operation by Job Id.

HTTP/1.1 202 Accepted
Date: Tue, 26 Sep 2017 22:03:13 GMT
Location: https://rest_server_url/paas/api/v1.1/activitylog/ExampleIdentityDomain/job/52884
Content-Length: 169
Content-Type: application/vnd.com.oracle.oracloud.provisioning.Service+json
Access-Control-Allow-Headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME
Service-URI: https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance
Retry-After: 60Date: Mon, 17 Apr 2017 22:46:03 GMT

Example of Response Body

The following shows an example of the response body in JSON format.

{
   "details":{
      "message":"Submitted job to disable load balancer for service [ExampleInstance] in domain [ExampleIdentityDomain].",
      "jobId":"52884"
   }
}