tencent cloud

Feedback

QueryCDBProxy

Last updated: 2023-06-21 10:03:28
This document is currently invalid. Please refer to the documentation page of the product.

    1. API Description

    This API will be disused soon.

    Planned disuse time: 2023-07-17 19:48:43

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

    This API has been deprecated and replaced with DescribeCdbProxyInfo.

    This API is used to query the proxy details.

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

    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: QueryCDBProxy.
    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
    ProxyGroupId No String Proxy ID

    3. Output Parameters

    Parameter Name Type Description
    Count Integer Number of instances in the proxy group
    Note: this field may return null, indicating that no valid value can be found.
    ProxyGroup Array of ProxyGroups Proxy information
    Note: this field may return null, indicating that no valid value can be found.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the proxy details

    Input Example

    POST / HTTP/1.1
    Host: cdb.tencentcloudapi.com
    Content-Type: application/json
    X-TC-Action: QueryCDBProxy
    <Common request parameters>
    
    {
        "InstanceId": "cdb-test",
        "ProxyGroupId": "proxy-test"
    }
    

    Output Example

    {
        "Response": {
            "Count": 1,
            "ProxyGroup": [
                {
                    "Address": [
                        {
                            "Desc": "",
                            "UniqSubnet": "subnet-test",
                            "UniqVpcId": "vpc-test",
                            "VPort": 3306,
                            "Vip": "172.16.48.49"
                        }
                    ],
                    "BaseGroup": {
                        "CurrentProxyVersion": "1.0.1",
                        "NodeCount": 2,
                        "OpenRW": false,
                        "ProxyGroupId": "proxy-test",
                        "Region": "ap-guangzhou",
                        "Status": "online",
                        "SupportUpgradeProxyVersion": "1.0.1",
                        "Zone": "ap-guangzhou-6"
                    },
                    "ConnectionPoolInfo": {
                        "ConnectionPool": false,
                        "ConnectionPoolType": "",
                        "PoolConnectionTimeOut": 0
                    },
                    "ProxyNode": [
                        {
                            "ProxyNodeConnections": 2,
                            "ProxyNodeId": "proxynode-test",
                            "ProxyStatus": "online"
                        },
                        {
                            "ProxyNodeConnections": 2,
                            "ProxyNodeId": "proxynode-test",
                            "ProxyStatus": "online"
                        }
                    ],
                    "RWInstInfo": {
                        "AutoAddRo": false,
                        "FailOver": false,
                        "InstCount": 0,
                        "IsKickOut": false,
                        "MaxDelay": 0,
                        "MinCount": 0,
                        "RWInstInfo": [],
                        "WeightMode": ""
                    }
                }
            ],
            "RequestId": "733f71d8-6c3a-419e-830f-4471c5bc2791"
        }
    }
    

    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.HttpError Exceptional HTTP request
    InternalError.UnknownError Unknown error
    InvalidParameter.ExceptionParam Parameter exception.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support