tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CloseCdbProxyAddress

Last updated: 2024-11-20 11:15:23

    1. API Description

    Domain name for API request: cdb.intl.tencentcloudapi.com.

    This API is used to disable the database proxy address.

    A maximum of 20 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: CloseCdbProxyAddress.
    Version Yes String Common Params. The value used for this API: 2017-03-20.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    ProxyGroupId Yes String Proxy group ID
    ProxyAddressId Yes String Address ID of the proxy group

    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 Disabling a database proxy address

    Input Example

    POST / HTTP/1.1Host: cdb.intl.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: CloseCdbProxyAddress<common request parameters>{    "ProxyGroupId": "proxy-il2nlsdn",    "ProxyAddressId": "proxyaddr-mc0efsw0"}

    Output Example

    {
    "Response": {
        "RequestId": "xxxx"
    }
}

    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
    FailedOperation.DescribeProxyGroupError Failed to query database proxy.
    InternalError.UnknownError Unknown error
    OperationDenied.ProxyAddressLimitError The number of the proxy addresses exceeds the limit.
    OperationDenied.ProxyAddressNotFund Proxy address is not found.
    OperationDenied.ProxyUpgradeTaskStatusError This operation is not allowed during database proxy upgrade task.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy