tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeProxySupportParam

Last updated: 2024-01-30 10:26:14

    1. API Description

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

    This API is used to query the supported proxy versions and parameters for an instance.

    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: DescribeProxySupportParam.
    Version Yes String Common Params. The value used for this API: 2017-03-20.
    Region No String Common Params. This parameter is not required for this API.
    InstanceId Yes String Instance ID

    3. Output Parameters

    Parameter Name Type Description
    ProxyVersion String The supported maximum proxy version Note: This field may return null, indicating that no valid values can be obtained.
    SupportPool Boolean Whether to support the connection pool Note: This field may return null, indicating that no valid values can be obtained.
    PoolMin Integer Minimum connections in the connection pool Note: This field may return null, indicating that no valid values can be obtained.
    PoolMax Integer Maximum connections in the connection pool Note: This field may return null, indicating that no valid values can be obtained.
    SupportTransSplit Boolean Whether to support transaction splitting Note: This field may return null, indicating that no valid values can be obtained.
    SupportPoolMinVersion String Minimum proxy version supporting connection pool Note: This field may return null, indicating that no valid values can be obtained.
    SupportTransSplitMinVersion String Minimum proxy version supporting transaction splitting Note: This field may return null, indicating that no valid values can be obtained.
    SupportReadOnly Boolean Whether read-only mode is supported Note: This field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the supported proxy versions and parameters for an instance

    Input Example

    POST / HTTP/1.1Host: cdb.tencentcloudapi.comContent-Type: application/jsonX-TC-Action: DescribeProxySupportParam<common request parameters>{    "InstanceId": "cdb-xxx"}

    Output Example

    {
    "Response": {
        "RequestId": "xx-xxx-xxx",
        "ProxyVersion": "1.3.1",
        "SupportPool": true,
        "PoolMin": 1,
        "PoolMax": 10,
        "SupportTransSplit": true,
        "SupportTransSplitMinVersion": "1.3.1",
        "SupportPoolMinVersion": "1.1.1",
        "SupportReadOnly": true
    }
}

    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
    InternalError.DBRecordNotExistError The database record does not exist.
    InternalError.ExecHttpRequestError Failed to execute the HTTP request
    InternalError.UnknownError Unknown error
    InvalidParameter.ControllerNotFoundError This API was not found.
    OperationDenied.OperationDeniedError Operation denied
    ResourceNotFound.InstanceNotFoundError High-availability instance doesn’t exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy