tencent cloud

文档反馈

DestroyDBInstance

最后更新时间:2024-07-30 17:32:10

    1. API Description

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

    This API is used to terminate an isolated instance by specifying the DBInstanceId parameter. The data of a terminated instance will be deleted and cannot be recovered. Be cautious with this API calling. Only the instance in isolation can be terminated.

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

    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 Params. The value used for this API: DestroyDBInstance.
    Version Yes String Common Params. The value used for this API: 2017-03-12.
    Region No String Common Params. This parameter is not required for this API.
    DBInstanceId Yes String The ID of the instance to be eliminated

    3. Output Parameters

    Parameter Name Type Description
    RequestId String The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

    4. Example

    Example1 Terminating a TencentDB for PostgreSQL instance

    This example shows you how to terminate the instance "postgres-19nmz2xb".

    Input Example

    POST / HTTP/1.1
    Host: postgres.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: DestroyDBInstance
    <Common request parameters>
    
    {
        "DBInstanceId": "postgres-19nmz2xb"
    }
    

    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.CMQResponseError Failed to access CMQ.
    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.DeleteResourceProjectTagError Failed to unbind resources from a project.
    FailedOperation.DeleteResourcesToTagError Failed to unbind the resource from the tag.
    FailedOperation.FailedOperationError Operation failed. Please try again later.
    FailedOperation.LimitOperation Operations are not allowed on the instance.
    FailedOperation.OperateFrequencyLimitedError The operation frequency limit is exceeded. Try again later. If the problem persists, contact customer service.
    FailedOperation.PostPaidUnblockError Failed to unfreeze the account of a pay-as-you-go instance. Please try again later. If the problem persists, please contact customer service.
    FailedOperation.QueryPriceFailed Failed to query the price.
    FailedOperation.TradeAccessError Failed to access the billing platform. Please try again later. If the problem persists, please contact customer service.
    InternalError.DBError Backend database execution error.
    InternalError.FlowError Failed to create the flow.
    InternalError.InternalHttpServerError An exception occurred while executing the request.
    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.InvalidParameterValueError Incorrect parameter value
    InvalidParameterValue.ParameterHandleError Failed to process the parameter. Please check if the parameter value is valid.
    InvalidParameterValue.StructParseFailed An error occurred while parsing parameters.
    LimitOperation Operations are not allowed on the instance.
    OperationDenied.CamDeniedError This operation cannot be performed.
    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.
    ResourceNotFound.InstanceNotFoundError The instance does not exist.
    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.
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持