查询代理节点列表

最近更新时间：2024-03-12 01:23:24

我的收藏

本页目录：

接口请求域名： cynosdb.tencentcloudapi.com 。

本接口（DescribeProxyNodes）用于查询代理节点列表。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeProxyNodes。
Version	是	String	公共参数，本接口取值：2019-01-07。
Region	是	String	公共参数，详见产品支持的地域列表，本接口仅支持其中的: ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-nanjing, ap-seoul, ap-shanghai, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley 。
Limit	否	Integer	返回数量，默认为 20，最大值为 100 示例值：100
Offset	否	Integer	记录偏移量，默认值为0 示例值：0
OrderBy	否	String	排序字段，取值范围： CREATETIME：创建时间 PERIODENDTIME：过期时间示例值："CREATETIME"
OrderByType	否	String	排序类型，取值范围： ASC：升序排序 DESC：降序排序示例值："desc"
Filters.N	否	Array of QueryFilter	搜索条件，若存在多个Filter时，Filter间的关系为逻辑与（AND）关系。

参数名称	类型	描述
TotalCount	Integer	数据库代理节点总数示例值：100
ProxyNodeInfos	Array of ProxyNodeInfo	数据库代理节点列表
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

POST / HTTP/1.1
Host: cynosdb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeProxyNodes
<公共请求参数>

{}

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

腾讯云 API 平台是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。

云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
FailedOperation.DatabaseAccessError	数据库访问失败，请稍后重试。如果持续不成功，请联系客服进行处理。
InvalidParameterValue.InvalidParameterValueError	参数值无效。
UnauthorizedOperation.PermissionDenied	CAM鉴权不通过。