REST API for Oracle SOA Cloud Service

Delete a Service Instance

put

/paas/api/v1.1/instancemgmt/{domainName}/services/SOA/instances/{serviceName}

Deletes an Oracle SOA Cloud Service instance.

If the service instance uses IP reservations on WebLogic Managed Server nodes (and local load balancer nodes, if OTD is configured), those IP reservations are released and returned to the pool of pre-allocated IP reservations with the status of UNUSED. Released IP reservations are not deleted when the service instance is deleted.

You cannot delete a service instance as long as the instance is associated with one or more cloned instances.

Request

Supported Media Types

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

Path Parameters

domainName: string

Name of the identity domain for the Oracle Cloud Service account.
serviceName: string

Name of the Oracle SOA Cloud Service instance.

Provision Payload

Root Schema : InstanceDeProvisionPayload

Type: object

Show Source

dbaName: string

This attribute is valid when component type is set to weblogic only.
Username for the Oracle Database Cloud - Database as a Service instance administrator.
For service instances based on Oracle WebLogic Server 11g (10.3.6), this value must be set to a database user with DBA role. You can use the default user SYSTEM or a user that has been granted the DBA role.
For service instances based on Oracle WebLogic Server 12c (12.1.3), this value must be set to a database user with SYSDBA system privileges. You can use the default user SYS or a user that has been granted the SYSDBA privilege.
dbaPassword: string

This attribute is valid when component type is set to weblogic only.
Password for the Oracle Database Cloud - Database as a Service instance administrator.
forceDelete: boolean

Boolean indicating whether the Instance is deleted forcefully on errors.
skipBackupOnTerminate: boolean

Boolean indicating whether the Backup termination should be skipped.

{
    "required":[
        "dbaName",
        "dbaPassword",
        "skipBackupOnTerminate",
        "forceDelete"
    ],
    "type":"object",
    "properties":{
        "dbaName":{
            "type":"string",
            "description":"This attribute is valid when component <code>type</code> is set to <code>weblogic</code> only.<p>Username for the Oracle Database Cloud - Database as a Service instance administrator.<p>For service instances based on Oracle WebLogic Server 11<i>g</i> (10.3.6), this value must be set to a database user with DBA role. You can use the default user <code>SYSTEM</code> or a user that has been granted the <code>DBA</code> role.<p>For service instances based on Oracle WebLogic Server 12<i>c</i> (12.1.3), this value must be set to a database user with SYSDBA system privileges. You can use the default user <code>SYS</code> or a user that has been granted the <code>SYSDBA</code> privilege."
        },
        "dbaPassword":{
            "type":"string",
            "description":"This attribute is valid when component <code>type</code> is set to <code>weblogic</code> only.<p>Password for the Oracle Database Cloud - Database as a Service instance administrator."
        },
        "skipBackupOnTerminate":{
            "type":"boolean",
            "description":"Boolean indicating whether the Backup termination should be skipped."
        },
        "forceDelete":{
            "type":"boolean",
            "description":"Boolean indicating whether the Instance is deleted forcefully on errors."
        }
    }
}

Response

Supported Media Types

application/json

202 Response

Accepted.

Root Schema : delete-response

Type: object

The response body contains information about the Delete operation.

Show Source

details: object details

The details of the Delete operation.

{
    "required":[
        "details"
    ],
    "description":"The response body contains information about the Delete operation.",
    "properties":{
        "details":{
            "type":"object",
            "description":"The details of the Delete operation.",
            "properties":{
                "jobId":{
                    "type":"string",
                    "description":"Job ID for the Delete operation."
                },
                "message":{
                    "type":"string",
                    "description":"System message that describes the operation. For example: <code>Submitted job to delete service...</code>"
                }
            }
        }
    }
}

Nested Schema : details

Type: object

The details of the Delete operation.

Show Source

jobId(optional): string

Job ID for the Delete operation.
message(optional): string

System message that describes the operation. For example: Submitted job to delete service...

{
    "type":"object",
    "description":"The details of the Delete operation.",
    "properties":{
        "jobId":{
            "type":"string",
            "description":"Job ID for the Delete operation."
        },
        "message":{
            "type":"string",
            "description":"System message that describes the operation. For example: <code>Submitted job to delete service...</code>"
        }
    }
}

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.

cURL Command

curl -i -X PUT -u username:Password1! -d @delete.json -H "Content-type:application/vnd.com.oracle.oracloud.provisioning.Service+json" -H "X-ID-TENANT-NAME:ExampleIdentityDomain" https://rest-server_url/paas/api/v1.1/instancemgmt/{identityDomainId}/services/SOA/instances/{serviceName}

Example of Response Header

The following example shows the response header:

-u '{userName}:{password}'
Content-type:application/vnd.com.oracle.oracloud.provisioning.Service+json
X-ID-TENANT-NAME: {identityDomainId}

Example of Request Body

The following example shows the request body in JSON format.

{
  "dbaName": "<dbaName>",
  "dbaPassword": "<dbaPassword>",
  "skipBackupOnTerminate": "true",
  "forceDelete": "true"
}

Example of Response Body

The following example shows the response body in JSON format.

{
  "details": {
    "message": "Submitted job to delete service [<InstanceName>] in domain [<DomainName>].",
    "jobId": "27618"
  }
}