IsolateDBInstance

Last updated: 2018-10-12 16:08:51

PDF

1. API Description

Domain name for API request: cdb.tencentcloudapi.com.

This API (IsolateDBInstance) is used to terminate a database instance. A terminated database cannot be accessed via the IP or the port. Postpaid instances become deactivated upon termination.

Prepaid instances cannot be terminated via this API.

A maximum of 20 requests can be initiated per second for this API.

Note: This API supports Finance regions. Since Finance regions and non-Finance regions are isolated and not interconnected. If the common parameter Region is a Finance region (such as ap-shanghai-fsi), you need to specify a domain name containing the Finance region that should be identical to the value of Region field, for example: cdb.ap-shanghai-fsi.tencentcloudapi.com.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: IsolateDBInstance
Version Yes String Common parameter. The value used for this API: 2017-03-20
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
InstanceId Yes String Instance ID, such as: cdb-c1nl9rpv. It is identical to the instance ID displayed in the database console page and can be obtained via API Query Instance List. Its value equals the InstanceId field value in the output parameters.

3. Output Parameters

Parameter Name Type Description
AsyncRequestId String ID of an async task request, which can be used to query the execution result of an async task.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code Description
InvalidParameter Parameter error.
InvalidParameter.InstanceNotFound The instance does not exist.
OperationDenied The operation is not allowed.
OperationDenied.ActionNotSupport Unsupported operation.
OperationDenied.WrongStatus The backend task status is invalid.

5. Example

Example 1 Isolate a database instance

Input example

https://cdb.tencentcloudapi.com/?Action=IsolateDBInstance
&InstanceIds=cdb-ezq1vzem
&<Common request parameters>

Output example

{
  "Response": {
    "AsyncRequestId": "b4a719b5-ffb34ab6-816c43c1-8c6a23eb",
    "RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
  }
}

6. Other Resources

Cloud API 3.0 comes with the following development tools to make it easier to call the API.