Jump to

• Request
• Response
• Examples

Disable or Enable the Oracle Managed Load Balancer

put

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

This endpoint is not available on Oracle Cloud Infrastructure.

This endpoint applies only to Oracle SOA Cloud Service instances where Oracle Identity Cloud Service is configured for user authentication and administration of users, groups, and roles.

Disables or enables the Oracle-managed load balancer for an Oracle SOA Cloud Service instance.

Request

Supported Media Types

• application/json

Path Parameters

• command: string
  Command to manage the state of the Oracle-managed load balancer. Valid values: disable and enable
• identityDomainId: string
  Identity domain ID for the Oracle SOA Cloud Service account.
• serviceId: string
  Name of the Oracle SOA Cloud Service instance.

Header Parameters

• X-ID-TENANT-NAME: string
  Identity domain ID for the Oracle SOA Cloud Service account.

Body ()

Root Schema : managedlb-request

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

Back to Top

Response

Supported Media Types

• application/json

202 Response

Accepted.

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

Body ()

Root Schema : managedlb-response

Type: object

The response body contains information about the operation.

Show Source

• details: object details
  Groups the details of the operation.

{
    "required":[
        "details"
    ],
    "description":"The response body contains information about the operation.",
    "properties":{
        "details":{
            "type":"object",
            "required":[
                "jobId",
                "message"
            ],
            "description":"Groups the details of the operation.",
            "properties":{
                "jobId":{
                    "type":"string",
                    "description":"Job ID for the operation."
                },
                "message":{
                    "type":"string",
                    "description":"System message that describes the operation."
                }
            }
        }
    }
}

Nested Schema : details

Type: object

Groups the details of the operation.

Show Source

• jobId: string
  Job ID for the operation.
• message: string
  System message that describes the operation.

{
    "type":"object",
    "required":[
        "jobId",
        "message"
    ],
    "description":"Groups the details of the operation.",
    "properties":{
        "jobId":{
            "type":"string",
            "description":"Job ID for the operation."
        },
        "message":{
            "type":"string",
            "description":"System message that describes the operation."
        }
    }
}

Back to Top

Examples

The following example shows how to disable or enable the Oracle-managed 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:userPassword1! -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/SOA/instances/ExampleInstance/loadbalancer/public/disable

curl -i -X PUT -u username:userPassword1! -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/SOA/instances/ExampleInstance/loadbalancer/public/enable

Note: No parameters are supported in the request payload at this time.

Example of Response Header

The following example shows the response header. The Location header returns the URI that can be used to view the job status.

HTTP/1.1 202 Accepted
Date: Tue, 26 Sep 2019 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/SOA/instances/ExampleInstance
Retry-After: 60Date: Mon, 17 Apr 2019 22:46:03 GMT

Example of Response Body

The following example shows the response body in JSON format.

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

Back to Top