Delete a Service Instance
/api/v1.1/instances/{identityId}/{serviceId}
Request
- application/json
- identityId
-
Type:
string
Required:true
Name of the identity domain for the Oracle Cloud Service account.- serviceId
Type:string
Required:true
ID of the service instance.
- dbaName
-
Type:
string
Required:true
Username for the Oracle Database Cloud - Database as a Service instance administrator. - dbaPassword
-
Type:
string
Required:true
Password for the Oracle Database Cloud - Database as a Service administrator. - forceDelete
-
Type:
boolean
Flag that specifies whether you want to force the removal of the service instance even if the database instance cannot be reached to delete the database schemas. If set totrue
, you may need to delete the associated database schemas manually on the database instance if they are not deleted as part of the service instance delete operation. This value defaults tofalse
. - skipBackupOnTerminate
-
Type:
boolean
Flag that specifies whether you want to skip backing up the service instance before deleting it. This value defaults to true.
Response
- application/json
- text/plain
- text/html
- auto-update
-
Type:
string
Flag that specifies whether updates to the Oracle Cloud Tools are automatically applied to the Oracle SOA Cloud Service instance during the maintenance window. The Oracle Cloud Tools are used to manage the lifecycle of your service instance. - compliance_status
-
Type:
string
Status indicating whether the version of Oracle Cloud Tools is out of compliance. Oracle uses Oracle Cloud Tools to manage the lifecycle of your service instance. If the Oracle Cloud Tools are out of compliance, this attribute is set to one of the following status values:NEW_VERSION
: Indicates a new version of Oracle Cloud Tools is available. Oracle strongly recommends that you apply this update as soon as possible.DEPRECATED
: Indicates that the current version of Oracle Cloud Tools is deprecated. Apply the latest Oracle Cloud Tools update to avoid any disruption of service in the future.UNSUPPORTED
: Indicates that the current version of Oracle Cloud Tools is not supported. Apply the latest patch to resume normal operations.
If the Oracle Cloud Tools are up-to-date, this attribute is blank.
- compliance_status_desc
-
Type:
string
Description that provides more details about the compliance status of the Oracle Cloud Tools, used to manage the lifecycle of your Oracle SOA Cloud Service instance. If the service instance is out of compliance, this attribute is set to one of the following descriptions, based on the status value:If the Oracle Cloud Tools are out of compliance, this attribute is set to one of the following status values:NEW_VERSION
: A newer version of Oracle toolslatestVersion
is available. This update includes critical fixes to Oracle Cloud Tools. Oracle uses cloud tools to manage lifecycle of your service. Oracle strongly recommends that customers apply this update as soon as possible.DEPRECATED
: This service is currently in a deprecated state because the Oracle tools versiondeprecatedVersion
is deprecated. Apply the latest Oracle tools update as this version may not be supported in the future.UNSUPPORTED
: This service is currently in an unsupported state because the Oracle tools versionunsupportedVersion
is obsolete. Apply the latest patch to resume normal operations.
If the Oracle Cloud Tools are up-to-date, this attribute is blank.
- created_by
-
Type:
string
Name of the account used to create the Oracle SOA Cloud Service instance. - creation_time
-
Type:
string
Date and time the Oracle SOA Cloud Service instance was created. - description
-
Type:
string
Free-form text that provides additional information about the service instance. - error_status_desc
-
Type:
string
Error status that describes the reason that the Oracle SOA Cloud Service instance is in an erroneous state. The following provides an example of the description:This service is currently in an erroneous state as the tools are in an inconsistent state. Reason - error details. Apply the latest tools patch to resume normal operations on this service.
- identity_domain
-
Type:
string
Identity domain name. - last_modified_time
-
Type:
string
Date and time the Oracle SOA Cloud Service instance was last modified. - service_name
-
Type:
string
Name of Oracle SOA Cloud Service instance. - service_url
-
Type:
string
Resource URL of the Oracle SOA Cloud Service instance. - status
-
Type:
string
Flag that specifies the status of the Oracle SOA Cloud Service instance at the time the delete operation was requested. Valid values include:Running
,In Progress
,Terminating
, andFailed
. - version
-
Type:
string
Oracle Fusion Middleware software version. Valid values include:12cR3
and11g
. - wlsVersion
-
Type:
string
Oracle WebLogic Server software version. Valid values include:12.1.3.0.4
and10.3.6.0.9
.
Examples
The following example shows how to delete an Oracle SOA Cloud Service instance by submitting a PUT request on the REST resource using cURL. For more information, see Use cURL.
See also Deleting an Oracle SOA Cloud Service Instance.
cURL Command
curl -i -X PUT -u joe@example.com:Welcome1! -d @delete.json -H "Content-Type:application/json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://api-host/paas/service/soa/api/v1.1/instances/ExampleIdentityDomain/ExampleInstance
Example of Request Body
The following shows an example of the request body in JSON format.
{ "dbaName": "SYS", "dbaPassword": "Weblogic123#", "forceDelete": true }
Example of Response Header
The following shows an example of the response header.
The Location header returns the REST resource that can be used to access the status of the delete service instance request. For more information, see Get Service Provisioning Status.
HTTP/1.1 202 Accepted Date: Wed, 24 Jun 2015 19:52:03 GMT Server: Oracle-Application-Server-11g Location: https://api-host/paas/service/soa/api/v1.1/instances/ExampleInstance/status/delete/job/100900
Example of Response Body
The following shows an example of the response body in JSON format.
{ "service_name":"ExampleInstance", "version":"12cR3", "wlsVersion":"12.1.3.0.4", "status":"Terminating", "error_status_desc": "", "compliance_status": "", "compliance_status_desc": "", "auto_update" : "true", "description":"An example service instance", "identity_domain":"ExcapleIdentityDomain", "creation_time":"Mon Aug 18 20:22:54 GMT 2014", "last_modified_time":"Mon Aug 18 20:22:54 GMT 2014", "created_by":"joe@example.com", "service_uri":"https:\/\/api-host\/paas\/service\/soa\/api\/v1.1\/instances\/ExampleIdentityDomain\/ExampleInstance" }