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
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| dms:DeleteInstance | delete | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| Tid | long | No | The ID of the tenant. You can call the GetUserActiveTenant operation to obtain the tenant ID. | 3*** |
| Host | string | Yes | The endpoint of the database instance. You can call the ListInstances or GetInstance operation to obtain the endpoint. | xxx.mysql.rds.aliyuncs.com |
| Port | integer | Yes | 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 |
| Sid | string | No | The system ID (SID) of the database instance. You can call the ListInstances or GetInstance operation to obtain the SID. | testSid |
Response parameters
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 time | Summary of changes | Operation |
|---|