Removes a database instance from Data Management (DMS).

Note: You can call this operation only to remove a database instance from the instance list of DMS. The instance is not deleted or shut down.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DeleteInstance

The operation that you want to perform. Set the value to DeleteInstance.

Tid Long Yes 3***

The ID of the tenant. You can call the GetUserActiveTenant operation to obtain the tenant ID.

Host String Yes xxx.mysql.rds.aliyuncs.com

The endpoint of the database instance. You can call the ListInstances or GetInstance operation to obtain the endpoint.

Port Integer Yes 3306

The port number that is used to connect to the database instance. You can call the ListInstances or GetInstance operation to obtain the port number.

Sid String No testSid

The system ID (SID) of the database instance. You can call the ListInstances or GetInstance operation to obtain the SID.

RegionId String No cn-hangzhou

The ID of the region in which DMS is activated. For more information, see RegionID parameter.

Response parameters

Parameter Type Example Description
RequestId String B4B07137-F6AE-4756-8474-7F92BB6C4E04

The ID of the request.

ErrorCode String UnknownError

The error code that is returned.

ErrorMessage String UnknownError

The error message that is returned.

Success Boolean true

Indicates whether the request was successful. Valid values:

  • true: The request was successful.
  • false: The request failed.

Examples

Sample request

http(s)://dms-enterprise.aliyuncs.com/?Action=DeleteInstance
&Tid=3***
&Host=xxx.mysql.rds.aliyuncs.com
&Port=3306
&Sid=testSid
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<DeleteInstanceResponse>
    <RequestId>B4B07137-F6AE-4756-8474-7F92BB6C4E04</RequestId>
    <Success>true</Success>
</DeleteInstanceResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "B4B07137-F6AE-4756-8474-7F92BB6C4E04",
  "Success" : true
}

Error codes

For a list of error codes, visit the API Error Center.