tencent cloud

PrevNext

文档反馈

请输入关键字

Recent Pages

文档
文档

DescribeProxyNodes

最后更新时间：2023-08-23 14:23:05

1. API Description

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

This API is used to query the list of proxy nodes.

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: DescribeProxyNodes.
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.
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 QueryFilter 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 the database proxy nodes
    ProxyNodeInfos Array of ProxyNodeInfo List of the database proxy nodes
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Querying the list of database proxy nodes

    Input Example

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

{}

    Output Example

    {
    "Response": {
        "ProxyNodeInfos": [],
        "RequestId": "d5ec3b85-ce7d-43b3-855f-dec59d11f3e1",
        "TotalCount": 0
    }
}

    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.DatabaseAccessError Failed to access the database. Please try again later. If the problem persists, please contact customer service.
    InvalidParameterValue.InvalidParameterValueError Invalid parameter value.
    UnauthorizedOperation.PermissionDenied CAM authentication failed.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    隐私条款服务条款缓存条款