Jump to

• Request
• Response
• Examples

Delete a Service Instance

put

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

Delete a MySQL Cloud Service instance.

Request

Supported Media Types

• application/vnd.com.oracle.oracloud.provisioning.Service+json

Path Parameters

• identityDomainId: string
  Name of the identity domain for the MySQL Cloud Service account.
• serviceId: string
  The user-defined name of the Oracle MySQL Cloud Service instance.

Header Parameters

• X-ID-TENANT-NAME: string
  Name of the identity domain for the MySQL Cloud Service account.

Body ()

The request body is reserved for options, although no options exist at this time. Instead, pass in an empty object, such as {}.

Root Schema : Delete Operation Request Body

Type: object

Title: Delete Operation Request Body

The request body defines options for this delete MySQL instance operation. There are no available options.

Show Source

• options(optional): object options
  This operation does not yet accept any options; you are required to define this as an empty object '{}'.

{
    "title":"Delete Operation Request Body",
    "description":"The request body defines options for this delete MySQL instance operation. There are no available options.",
    "properties":{
        "options":{
            "type":"object",
            "description":"This operation does not yet accept any options; you are required to define this as an empty object '{}'.",
            "items":{
                "type":"string"
            }
        }
    }
}

Nested Schema : options

Type: object

This operation does not yet accept any options; you are required to define this as an empty object '{}'.

Show Source

• [0]: string

{
    "type":"object",
    "description":"This operation does not yet accept any options; you are required to define this as an empty object '{}'.",
    "items":{
        "type":"string"
    }
}

Response

Supported Media Types

• application/json

202 Response

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

Body ()

Root Schema : Response Body

Type: object

Title: Response Body

The response body contains information about the operation.

Show Source

• jobId(optional): string
  Job ID for the operation.
• message(optional): string
  System message that describes the operation. For example: Snapshot a service [{serviceId}] is submitted as an asynchronous job.

{
    "title":"Response Body",
    "description":"The response body contains information about the operation.",
    "properties":{
        "message":{
            "description":"System message that describes the operation. For example: <code>Snapshot a service [{serviceId}] is submitted as an asynchronous job.</code>",
            "type":"string"
        },
        "jobId":{
            "description":"Job ID for the operation.",
            "type":"string"
        }
    }
}

Examples

The following example shows how to delete a MySQL Cloud Service instance by submitting a PUT request on the REST endpoint using cURL.

Note: The command in this example uses the URL structure https://rest_server_url/resource-path, where rest_server_url is the Oracle Public Cloud or Oracle Cloud Machine REST server to contact for your identity domain or tenant name. See Send Requests for the appropriate URL structure to use on Oracle Public Cloud or Oracle Cloud Machine.

Note: Sending a request body is always required, but it may be empty as demonstrated in this example.

cURL Command

curl -i -X PUT \
  -u "username:password" \
  -H "X-ID-TENANT-NAME: ExampleIdentityDomain" \
  -H "Accept: application/json" \
  -H "Content-Type: application/vnd.com.oracle.oracloud.provisioning.Service+json" \
  -d "{}" \
   https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/MyTestInstance

Example of Response Header

The following shows an example of the response header.

HTTP/1.1 202 Accepted
Date: Wed, 30 Nov 2016 23:30:48 GMT
Transfer-Encoding: chunked
Location: https://rest_server_url:443/paas/api/v1.1/activitylog/ExampleIdentityDomain/job/3495
Content-Type: application/json
Access-Control-Allow-Headers: Content-Type, api_key, Authorization
Service-URI:  https://rest_server_url/paas/api/v1.1/instancemgmt/ExampleIdentityDomain/services/MySQLCS/instances/MyTestInstance
Retry-After: 60
Access-Control-Allow-Methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
X-ORACLE-DMS-ECID: b786ee72-63d7-4cd6-830d-39c2388b9b68-0003123b
Access-Control-Allow-Origin: *
X-Frame-Options: DENY

Example of Response Body

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

{
  "details": {
    "message": "Submitted job to delete service [MyTestInstance] in domain [ExampleIdentityDomain].",
    "jobId": "3495"
  }
}