DisIsolateDBInstances

Last updated: 2021-06-02 17:25:37

1. API Description

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

This API is used to remove one or more instances from isolation.

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: DisIsolateDBInstances.
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 Resource ID list
Period No Integer The valid period (in months) of the monthly-subscribed instance when removing it from isolation
AutoVoucher No Boolean Whether to use vouchers. Valid values: true (yes), false (no). Default value: false.
VoucherIds.N No Array of String Voucher ID list

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 Removing an instance from isolation

Input Example

https://postgres.tencentcloudapi.com/?Action=DisIsolateDBInstances
&DBInstanceIdSet.0=postgres-xxxxxxxx
&Period=1
&AutoVoucher=false
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "ad1ca88b-5cc8-4c4c-ab10-a882123f8daa"
  }
}

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.
FailedOperation.CamAuthFailed CAM authentication failed.
FailedOperation.CamCheckResourceError Failed to get permissions. Please try again later. If the problem persists, please contact customer service.
FailedOperation.CamCheckResourceFailed Failed to check resource permissions through CAM.
FailedOperation.CamSigAndAuthError Authentication failed. Please try again later. If the problem persists, please contact customer service.
FailedOperation.DatabaseAccessError Failed to access database management service. Please try again later. If the problem persists, please contact customer service.
FailedOperation.FailedOperationError Operation failed. Please try again later.
FailedOperation.FlowCreateError Failed to create a task. Please try again later. If the problem persists, please contact customer service.
FailedOperation.InvalidTradeOperate Billing error. Corresponding purchase/renewal/configuration change operations are not allowed for the current instance.
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.
InvalidInstanceStatus Incorrect instance status.
InvalidOrderNum Billing error: invalid order type ID.
InvalidParameter Parameter error.
InvalidParameter.ParameterCheckError Failed to check the parameter.
InvalidParameter.TradeAccessDeniedError Incorrect PID
InvalidParameterValue.InvalidParameterValueError Incorrect parameter value
InvalidParameterValue.ParameterCharacterLimitError The parameter is invalid. Please modify it and try again.
InvalidParameterValue.ParameterLengthLimitError The length of parameter exceeds the limit.
InvalidParameterValue.StructParseFailed An error occurred while parsing parameters.
InvalidTradeOperate Billing error: such operations as purchase, renewal, and configuration change are not allowed for the instance.
LimitExceeded Quota limit exceeded.
LimitOperation Operations are not allowed on the instance.
MissingParameter Missing parameters.
OperationDenied.CamDeniedError This operation cannot be performed.
OperationDenied.InstanceAccessDeniedError You do not have the permission to operate this resource.
OperationDenied.InstanceStatusDeniedError This operation cannot be performed on an instance in this status.
OperationDenied.InstanceStatusLimitError This operation cannot be performed on an instance in this status.
OperationDenied.InstanceStatusLimitOpError This operation cannot be performed on an instance in this status.
ResourceNotFound Resource not found.
ResourceNotFound.InstanceNotFoundError The instance does not exist.
UnknownParameter Unknown parameter error.