DestroyDBInstance

Last updated: 2020-12-01 20:30:26

1. API Description

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

This API is used to terminate the instance corresponding to a specified DBInstanceId.

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: DestroyDBInstance.
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.
DBInstanceId Yes String ID of the instance to be deleted

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 Terminating a TencentDB for PostgreSQL instance

Input Example

https://postgres.tencentcloudapi.com/?Action=DestroyDBInstance
&DBInstanceId=postgres-19nmz2xb
&<Common request parameters>

Output Example

{
  "Response": {
    "RequestId": "6ace8140-6b9e-4e81-a8ad-ef3f92b2aa90"
  }
}

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
AccountNotExist The current account does not exist.
AuthFailure.UnauthorizedOperation Authentication failed.
FailedOperation.LimitOperation Operations are not allowed on the instance.
FailedOperation.QueryPriceFailed Failed to query the price.
InternalError.DBError Backend database execution error.
InternalError.FlowError Failed to create the flow.
InternalError.SystemError System error. When this error occurs, please contact customer service for assistance.
InvalidAccountStatus The current account status is incorrect, so the operation is not allowed.
InvalidInstanceStatus Incorrect instance status.
InvalidParameter Parameter error.
InvalidParameterValue.IllegalInstanceChargeType Incorrect billing mode.
InvalidParameterValue.InstanceNotExist The current instance does not exist.
InvalidParameterValue.StructParseFailed An error occurred while parsing parameters.
LimitOperation Operations are not allowed on the instance.
ResourceUnavailable.InvalidInstanceStatus Incorrect instance status.
StructParseFailed An error occurred while parsing parameters.
SystemError System error. When this error occurs, please contact customer service for assistance.
UnknownError Unknown error. When this error occurs, please contact customer service for assistance.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help