All Products
Search
Document Center

Data Management:DeleteInstance

Last Updated:Oct 21, 2024

Removes a database instance from Data Management (DMS).

Operation description

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

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
TidlongNo

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

3***
HoststringYes

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

xxx.mysql.rds.aliyuncs.com
PortintegerYes

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.

3306
SidstringNo

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

testSid

Response parameters

ParameterTypeDescriptionExample
object
RequestIdstring

The ID of the request.

B4B07137-F6AE-4756-8474-7F92BB6C4E04
ErrorCodestring

The error code that is returned.

UnknownError
ErrorMessagestring

The error message that is returned.

UnknownError
Successboolean

Indicates whether the request was successful. Valid values:

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

Examples

Sample success responses

JSONformat

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

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change timeSummary of changesOperation
No change history