REST API for Oracle Java Cloud Service

Delete a Component

put

/paas/api/v1.1/instancemgmt/{identityDomainId}/services/jaas/instances/{serviceId}/servicecomponent

Removes the Oracle Traffic Director node from the specified Oracle Java Cloud Service instance.

Request

Supported Media Types

application/json

Path Parameters

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 : deletecomponent-putrequestm

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.

Root Schema : accepted-responsem

Type: object

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

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 for warning messages.",
    "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 messages, if any.",
                    "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 messages, if any.
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 messages, if any.",
            "items":{
                "type":"string"
            }
        }
    },
    "required":[
        "jobId",
        "message"
    ]
}

Nested Schema : issues

Type: array

Groups strings of warning messages, if any.

Show Source

Array of: string

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

400 Response

Bad Request. Returned if the request payload contains bad or missing details.

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

Root Schema : badrequest-responsem

Type: object

The response body contains information about the request. It can include an issues array for validation error messages.

Show Source

details(optional): object details

Groups details of the request.

{
    "description":"The response body contains information about the request. It can include an <code>issues</code> array for validation error messages.",
    "properties":{
        "details":{
            "type":"object",
            "description":"Groups details of the request.",
            "properties":{
                "message":{
                    "type":"string",
                    "description":"System message that describes the request."
                },
                "issues":{
                    "type":"array",
                    "description":"Groups strings of validation error messages, if any.",
                    "items":{
                        "type":"string"
                    }
                }
            }
        }
    }
}

Nested Schema : details

Type: object

Groups details of the request.

Show Source

issues(optional): array issues

Groups strings of validation error messages, if any.
message(optional): string

System message that describes the request.

{
    "type":"object",
    "description":"Groups details of the request.",
    "properties":{
        "message":{
            "type":"string",
            "description":"System message that describes the request."
        },
        "issues":{
            "type":"array",
            "description":"Groups strings of validation error messages, if any.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : issues

Type: array

Groups strings of validation error messages, if any.

Show Source

Array of: string

{
    "type":"array",
    "description":"Groups strings of validation error messages, if any.",
    "items":{
        "type":"string"
    }
}

Examples

The following example shows how to remove the Oracle Traffic Director node by submitting a PUT request on the REST resource using cURL.

Note: The command in this 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 "{}" -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/servicecomponent

Example of Request Body

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

{
    
}

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
Location: https://rest_server_url/paas/api/v1.1/activitylog/ExampleIdentityDomain/job/45676
Content-Language: en
Service-URI: https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/jaas/instances/ExampleInstance
Content-Type: application/vnd.com.oracle.oracloud.provisioning.Service+json
Date: Wed, 15 Dec 2021 22:46:03 GMT

Example of Response Body

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

{
   "details":
   {
      "message":"Submitted job to delete service component for service [ExampleInstance] in domain [ExampleIdentityDomain].",
      "jobId":"45676"
   }
}