REST API for Oracle Database Exadata Cloud Service (OCI-C)

Delete a Database Deployment

delete

/paas/service/dbcs/api/v1.1/instances/{identityDomainId}/{serviceId}

Deletes an Exadata Cloud Service database deployment.

Request

Supported Media Types

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

Path Parameters

identityDomainId: string
The value depends on the type of Exadata Cloud Service account that is used to make the request:
- For a Traditional Cloud Account, specify the Identity Domain Name that is associated with the service.
- For a Cloud Account with Identity Cloud Service, specify the Identity Service Id that is associated with the service, which has the format idcs-letters-and-numbers.
serviceId: string

Name of the Exadata Cloud Service database deployment.

Query Parameters

deleteBackup(optional): boolean

Flag that when set to true deletes all backups of the database from the Oracle Cloud Storage container. Use caution in specifying this option. If this option is specified, the database cannot be recovered as all backups will be deleted. Default value is false.

Header Parameters

Authorization: string

Base64 encoding of the user name and password of the user making the request. For more information, see Security, Authentication and Authorization.
X-ID-TENANT-NAME: string
The value depends on the type of Exadata Cloud Service account that is used to make the request:
- For a Traditional Cloud Account, specify the Identity Domain Name that is associated with the service.
- For a Cloud Account with Identity Cloud Service, specify the Identity Service Id that is associated with the service, which has the format idcs-letters-and-numbers.
For more information, see Security, Authentication and Authorization.

Response

Supported Media Types

application/json

202 Response

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

Root Schema : delete-response

Type: object

The response body contains information about the delete operation.

Show Source

serviceName(optional): string

The delete job poll location. Poll the job uri to track status of the delete operation.


{
    "description":"The response body contains information about the delete operation.",
    "properties":{
        "serviceName":{
            "type":"string",
            "description":"The delete job poll location. Poll the job uri to track status of the delete operation."
        }
    }
}

Examples

The following example shows how to delete an Exadata Cloud Service database instance by submitting a DELETE request on the REST endpoint using cURL.

In this example, the identity domain is usexample and the Oracle Cloud user name and password are serviceadmin and Pa55_word. The instance being deleted is named db12c.

cURL Command

curl -i -X DELETE --cacert ~/cacert.pem -u serviceadmin:Pa55_word -H "X-ID-TENANT-NAME:usexample"  https://dbaas.oraclecloud.com/paas/service/dbcs/api/v1.1/instances/usexample/db12c

HTTP Status Code and Response Headers

HTTP/2.0 202
server: Oracle-Application-Server-11g
strict-transport-security: max-age=31536000;includeSubDomains
location: https://dbaas.oraclecloud.com:443/paas/service/dbcs/api/v1.1/instances/usexample/status/delete/job/12245977
content-language: en
access-control-allow-origin: *
access-control-allow-headers: Content-Type, api_key, Authorization, X-ID-TENANT-NAME, X-USER-IDENTITY-DOMAIN-NAME
retry-after: 30
access-control-allow-methods: GET, POST, DELETE, PUT, OPTIONS, HEAD
x-oracle-dms-ecid: 005KCULmdiu6uHFpR05Eid0007dd0002vm
x-oracle-dms-ecid: 005KCULmdiu6uHFpR05Eid0007dd0002vm
service-uri: https://dbaas.oraclecloud.com:443/paas/service/dbcs/api/v1.1/instances/usexample/db12c
x-frame-options: DENY
content-type: application/json
vary: user-agent
date: Wed, 31 May 2017 01:10:26 GMT

Response Body

{
	"service_name": "db12c",
	"version": "12.1.0.2",
	"status": "Terminating",
	"description": "db12c",
	"identity_domain": "usexample",
	"creation_time": "2017-05-31T00:31:51.283+0000",
	"last_modified_time": "2017-05-31T00:31:51.263+0000",
	"created_by": "serviceadmin",
	"sm_plugin_version": "17.2.3-539",
	"tools_version": "17.2.3-539",
	"service_uri": "https:\/\/dbaas.oraclecloud.com:443\/paas\/service\/dbcs\/api\/v1.1\/instances\/usexample\/db12c",
	"database_id": "0"
}

Oracle Account