tencent cloud

Feedback

DescribeCDBProxy

Last updated: 2022-08-17 15:58:27

1. API Description

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

This API is used to query database proxy. It will be deprecated and replaced by the QueryCDBProxy API.

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: DescribeCDBProxy.
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.
InstanceId Yes String Instance ID
ProxyGroupId No String Proxy group ID

3. Output Parameters

Parameter Name Type Description
BaseGroup BaseGroupInfo Basic information of the proxy group
Note: this field may return null, indicating that no valid value can be found.
Address Address Address information of the proxy group
Note: this field may return null, indicating that no valid value can be found.
ProxyNode ProxyNodeInfo Node information of the proxy group
Note: this field may return null, indicating that no valid value can be found.
RWInstInfo RWInfo Read/Write separation information
Note: this field may return null, indicating that no valid value can be found.
ConnectionPoolInfo ConnectionPoolInfo Connection pool information
Note: this field may return null, indicating that no valid value can be found.
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 ProxyGroup 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 information of database proxy

Input Example

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

{
    "InstanceId": "xx",
    "ProxyGroupId": "xx"
}

Output Example

{
    "Response": {
        "Count": 1,
        "RWInstInfo": {
            "MaxDelay": 1,
            "AutoAddRo": true,
            "IsKickOut": true,
            "FailOver": true,
            "RWInstInfo": {},
            "MinCount": 1,
            "WeightMode": "xx",
            "InstCount": 1
        },
        "ProxyNode": {
            "ProxyNodeId": "xx",
            "ProxyNodeMem": 1,
            "ProxyNodeConnections": 1,
            "ProxyNodeCpu": 1,
            "ProxyStatus": "xx"
        },
        "ConnectionPoolInfo": {
            "ConnectionPoolType": "xx",
            "PoolConnectionTimeOut": 0,
            "ConnectionPool": true
        },
        "RequestId": "xx",
        "Address": {
            "UniqVpcId": "xx",
            "VPort": 1,
            "Vip": "xx",
            "UniqSubnet": "xx",
            "Desc": "xx"
        },
        "ProxyGroup": [
            {
                "ConnectionPoolInfo": {
                    "ConnectionPoolType": "xx",
                    "PoolConnectionTimeOut": 0,
                    "ConnectionPool": false
                },
                "RWInstInfo": {
                    "MaxDelay": 1,
                    "AutoAddRo": true,
                    "IsKickOut": true,
                    "FailOver": true,
                    "RWInstInfo": {},
                    "MinCount": 1,
                    "WeightMode": "xx",
                    "InstCount": 1
                },
                "BaseGroup": {
                    "Status": "xx",
                    "CurrentProxyVersion": "xx",
                    "ProxyGroupId": "xx",
                    "Zone": "xx",
                    "Region": "xx",
                    "NodeCount": 1,
                    "SupportUpgradeProxyVersion": "xx",
                    "OpenRW": true
                },
                "ProxyNode": {
                    "ProxyNodeId": "xx",
                    "ProxyNodeMem": 1,
                    "ProxyNodeConnections": 1,
                    "ProxyNodeCpu": 1,
                    "ProxyStatus": "xx"
                },
                "Address": {
                    "UniqVpcId": "xx",
                    "VPort": 1,
                    "Vip": "xx",
                    "UniqSubnet": "xx",
                    "Desc": "xx"
                }
            }
        ],
        "BaseGroup": {
            "Status": "xx",
            "CurrentProxyVersion": "xx",
            "ProxyGroupId": "xx",
            "Zone": "xx",
            "Region": "xx",
            "NodeCount": 1,
            "SupportUpgradeProxyVersion": "xx",
            "OpenRW": 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
FailedOperation.DescribeProxyGroupError Failed to query database proxy.
InternalError.DBRecordNotExistError The database record does not exist.
InternalError.InternalHttpServerError An exception occurred while executing the request.
InternalError.UnknownError Unknown error
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