Domain name for API request: cdb.tencentcloudapi.com.
This API is used to isolate a TencentDB instance, which will no longer be accessible via IP and port. The isolated instance can be started up in the recycle bin. If it is isolated due to arrears, please top up your account as soon as possible.
A maximum of 20 requests can be initiated per second for this API.
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 Params. The value used for this API: IsolateDBInstance. |
Version | Yes | String | Common Params. The value used for this API: 2017-03-20. |
Region | No | String | Common Params. This parameter is not required for this API. |
InstanceId | Yes | String | Instance ID in the format of cdb-c1nl9rpv. It is the same as the instance ID displayed on the TencentDB Console page. You can use the instance list querying API to query the ID, whose value is the InstanceId value in output parameters. |
Parameter Name | Type | Description |
---|---|---|
AsyncRequestId | String | Async task request ID, which can be used to query the execution result of an async task. (This returned field has been disused. You can query the isolation status of an instance through the DescribeDBInstances API.)Note: this field may return null, indicating that no valid values can be obtained. |
RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: cdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: IsolateDBInstance
<Common request parameters>
{
"InstanceId": "cdb-ezq1vzem"
}
{
"Response": {
"AsyncRequestId": "e48eb1e9-0ca0ecae-c0dac9c7-60d12864",
"RequestId": "6EF60BEC-0242-43AF-BB20-270359FB54A7"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation.CdbInstanceLockFailError | Failed to lock the instance while performing exclusive operations. Please try again later. |
InternalError.DBError | Database exception |
InternalError.ExecHttpRequestError | Failed to execute the HTTP request |
InternalError.HttpError | Exceptional HTTP request |
InternalError.TradeError | Transaction system error. |
InternalError.UnknownError | Unknown error |
InvalidParameter | Parameter error. |
InvalidParameter.ControllerNotFoundError | This API was not found. |
InvalidParameter.ExceptionParam | Parameter exception. |
InvalidParameter.InstanceNotFound | The instance does not exist. |
InvalidParameter.JsonUnmarshalError | Failed to deserialize JSON. |
OperationDenied | Operation denied. |
OperationDenied.ActionNotSupport | Unsupported operation. |
OperationDenied.InstanceLockerConflict | Instance locks are in conflict. Please try again later. |
OperationDenied.InstanceStatusError | Exceptional instance status |
OperationDenied.UnSupportRefundError | This instance is not refundable. |
OperationDenied.UserHasNoStrategy | This account is not authorized to access the requested resource. |
OperationDenied.WrongStatus | The backend task status is invalid. |
ResourceNotFound.CdbInstanceNotFoundError | The instance cannot be found. Please check whether your instance status is normal. |
本页内容是否解决了您的问题?