tencent cloud

All product documents
APIs
DocumentationAPIsTDSQL-C for MySQLDatabase Proxy APIsDescribeProxies
DescribeProxies
Last updated: 2024-07-19 15:12:00
DescribeProxies
Last updated: 2024-07-19 15:12:00

1. API Description

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

This API is used to query the list of database proxies.

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: DescribeProxies.
Version Yes String Common Params. The value used for this API: 2019-01-07.
Region Yes String Common Params. For more information, please see the list of regions supported by the product.
ClusterId No String Cluster ID
Limit No Integer Number of returned results. Default value: 20. Maximum value: 100,
Offset No Integer Record offset. Default value: 0.
OrderBy No String Sorting field. Valid values:
  • CREATETIME: Creation time
  • PERIODENDTIME: Expiration time
    		•
    OrderByType No String Sorting order. Valid values:
  • ASC: Ascending.
  • DESC: Descending
    		•
    Filters.N No Array of QueryParamFilter Filter. If there are more than one filter, the logical relationship between these filters is AND.

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of database proxy groups
    ProxyGroupInfos Array of ProxyGroupInfo List of database proxy groups
    Note: This field may return null, indicating that no valid values can be obtained.
    ProxyNodeInfos Array of ProxyNodeInfo Database proxy node
    Note: This field may return null, indicating that no valid values can be obtained.
    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 Querying the list of the database proxies

    This example shows you how to query the information of database proxy.

    Input Example

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

{
    "OrderBy": "createTime",
    "ClusterId": "cynosdbmysql-xx",
    "Limit": 0,
    "Filters": [
        {
            "Values": [
                "proxyGroupId"
            ],
            "Names": [
                "cynosdbmysql-proxy-xx"
            ],
            "ExactMatch": true
        }
    ],
    "Offset": 0,
    "OrderByType": "desc"
}

    Output Example

    {
    "Response": {
        "TotalCount": 0,
        "ProxyGroupInfos": [
            {
                "ProxyGroup": {
                    "ProxyGroupId": "abc",
                    "ProxyNodeCount": 0,
                    "Status": "abc",
                    "Region": "abc",
                    "Zone": "abc",
                    "CurrentProxyVersion": "abc",
                    "ClusterId": "abc",
                    "AppId": 0,
                    "OpenRw": "abc"
                },
                "ProxyGroupRwInfo": {
                    "ConsistencyType": "abc",
                    "ConsistencyTimeOut": 0,
                    "WeightMode": "abc",
                    "FailOver": "abc",
                    "AutoAddRo": "abc",
                    "InstanceWeights": [
                        {
                            "InstanceId": "abc",
                            "Weight": 0
                        }
                    ],
                    "OpenRw": "abc"
                },
                "ProxyNodes": [
                    {
                        "ProxyNodeId": "abc",
                        "ProxyNodeConnections": 0,
                        "Cpu": 0,
                        "Mem": 0,
                        "Status": "abc",
                        "ProxyGroupId": "abc",
                        "ClusterId": "abc",
                        "AppId": 0,
                        "Region": "abc",
                        "Zone": "abc"
                    }
                ],
                "ConnectionPool": {
                    "OpenConnectionPool": "abc",
                    "ConnectionPoolType": "abc",
                    "ConnectionPoolTimeOut": 0
                },
                "NetAddrInfos": [
                    {
                        "Vip": "abc",
                        "Vport": 0,
                        "WanDomain": "abc",
                        "WanPort": 0,
                        "NetType": "abc",
                        "UniqSubnetId": "abc",
                        "UniqVpcId": "abc",
                        "Description": "abc",
                        "WanIP": "abc",
                        "WanStatus": "abc"
                    }
                ],
                "Tasks": [
                    {
                        "TaskId": 0,
                        "TaskType": "abc",
                        "TaskStatus": "abc",
                        "ObjectId": "abc",
                        "ObjectType": "abc"
                    }
                ]
            }
        ],
        "ProxyNodeInfos": [
            {
                "ProxyNodeId": "abc",
                "ProxyNodeConnections": 0,
                "Cpu": 0,
                "Mem": 0,
                "Status": "abc",
                "ProxyGroupId": "abc",
                "ClusterId": "abc",
                "AppId": 0,
                "Region": "abc",
                "Zone": "abc"
            }
        ],
        "RequestId": "abc"
    }
}

    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.CamCheckResourceError Failed to get permissions. Please try again later. If the problem persists, please contact customer service.
    FailedOperation.DatabaseAccessError Failed to access the database. Please try again later. If the problem persists, please contact customer service.
    FailedOperation.OperationFailedError Operation failed. Try again later. If the problem persists, contact customer service.
    InternalError.DbOperationFailed Failed to query the database.
    InternalError.SystemError Internal system error.
    InvalidParameterValue.IllegalOrderBy Invalid sort by field.
    InvalidParameterValue.InvalidParameterValueError Invalid parameter value.
    InvalidParameterValue.ParamBothSetError These two parameters cannot be set at the same time.
    UnauthorizedOperation.PermissionDenied CAM authentication failed.
    Was this page helpful?
    You can also Contact Sales or Submit a Ticket for help.
    Yes
    No

    Feedback

    Contact Us

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

    Contact Us
    Technical Support

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

    Submit a Ticket
    7x24 Phone Support
    Hong Kong, China
    +852 800 906 020 (Toll Free)
    United States
    +1 844 606 0804 (Toll Free)
    United Kingdom
    +44 808 196 4551 (Toll Free)
    Canada
    +1 888 605 7930 (Toll Free)
    Australia
    +61 1300 986 386 (Toll Free)
    EdgeOne hotline
    +852 300 80699
    More local hotlines coming soon