IsolateDBInstances

Last updated: 2021-08-06 16:23:13

1. API Description

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

This API is used to isolate one or more instances.

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

Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: postgres.ap-shanghai-fsi.tencentcloudapi.com

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

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: IsolateDBInstances.
Version Yes String Common parameter. The value used for this API: 2017-03-12.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
DBInstanceIdSet.N Yes Array of String Instance ID set

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Isolating an instance

Input Example

https://postgres.tencentcloudapi.com/?Action=IsolateDBInstances
&DBInstanceIdSet.0=postgres-xxxxxxxx
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "d43b2a9f-070c-480b-a0bb-7c210428cfe8"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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

Error Code Description
AuthFailure CAM signature/authentication error.
AuthFailure.UnauthorizedOperation Authentication failed.
DBError Backend database execution error.
FailedOperation.DatabaseAccessError Failed to access database management service. Please try again later. If the problem persists, please contact customer service.
FailedOperation.GetInstanceByResourceIdError Failed to query the instance information. Please try again later.
FailedOperation.InvalidAccountStatus The account status is incorrect, so the operation is not allowed.
FailedOperation.QueryTradeStatusError Failed to query the order status.
FailedOperation.TradeAccessError Failed to access the billing platform. Please try again later. If the problem persists, please contact customer service.
FailedOperation.TradeCreateError Failed to request the billing platform to create an order.
FailedOperation.TradePayOrdersError Failed to request to pay for the order.
FailedOperation.TradeQueryOrderError Failed to query order information. Please try again later. If the problem persists, please contact customer service.
FailedOperation.TradeQueryPriceError Failed to query pricing information. Please try again later. If the problem persists, please contact customer service.
InstanceNotExist The current instance does not exist.
InternalError.InstanceDataError Failed to access database management service. Please contact customer service.
InvalidInstanceStatus Incorrect instance status.
InvalidParameter Parameter error.
InvalidParameter.TradeAccessDeniedError Incorrect PID
InvalidParameterValue Invalid parameter value.
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
InvalidVoucherId Billing error: the specified voucher is invalid.
LimitExceeded Quota limit exceeded.
LimitOperation Operations are not allowed on the instance.
MissingParameter Missing parameters.
OperationDenied.CamDeniedError This operation cannot be performed.
OperationDenied.DTSInstanceStatusError The target instance failed the status check.
OperationDenied.InstanceAccessDeniedError You do not have the permission to operate this resource.
OperationDenied.InstanceStatusLimitOpError This operation cannot be performed on an instance in this status.
RegionNotSupported The region is not supported.
RequestLimitExceeded The number of requests exceeds the frequency limit.
ResourceNotFound.InstanceNotFoundError The instance does not exist.