tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DeleteServerlessDBInstance

Last updated: 2024-06-17 14:25:59

    1. API Description

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

    This API is used to delete a PostgreSQL for Serverless instance.

    A maximum of 100 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: DeleteServerlessDBInstance.
    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.
    DBInstanceName No String Instance name. Either instance name or instance ID (or both) must be passed in. If both are passed in, the instance ID will prevail.
    DBInstanceId No String Instance ID. Either instance name or instance ID (or both) must be passed in. If both are passed in, the instance ID will prevail.

    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 Deleting PostgreSQL for Serverless instance by ID

    This example shows you how to delete a PostgreSQL for Serverless instance by specifying its ID, such as "postgres-xxxxx".

    Input Example

    POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteServerlessDBInstance
<Common request parameters>

{
    "DBInstanceId": "postgres-xxxxx"
}

    Output Example

    {
    "Response": {
        "RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d"
    }
}

    Example2 Deleting PostgreSQL for Serverless instance by name

    This example shows you how to delete a PostgreSQL for Serverless instance by specifying its name, such as "serverlessdb-test".

    Input Example

    POST / HTTP/1.1
Host: postgres.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DeleteServerlessDBInstance
<Common request parameters>

{
    "DBInstanceName": "serverlessdb-test"
}

    Output Example

    {
    "Response": {
        "RequestId": "08fdf411-5d39-44f2-8e1d-a58ee60b237d"
    }
}

    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.UnauthorizedOperation Authentication failed.
    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.
    InternalError Internal error.
    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.
    InternalError.UnknownError Unknown error. When this error occurs, please contact customer service for assistance.
    InvalidInstanceStatus Incorrect instance status.
    InvalidParameter Parameter error.
    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.
    OperationDenied.CamDeniedError This operation cannot be performed.
    OperationDenied.InstanceStatusLimitOpError This operation cannot be performed on an instance in this status.
    RegionNotSupported The region is not supported.
    ResourceNotFound.InstanceNotFoundError The instance does not exist.
    ResourceUnavailable.InvalidInstanceStatus Incorrect instance status.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy