有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: redis.tencentcloudapi.com 。

本接口(DescribeInstanceNodeInfo)用于查询实例节点信息。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstanceNodeInfo。
Version String 公共参数,本接口取值:2018-04-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 指定实例 ID。例如:crs-xjhsdj****。请登录Redis控制台在实例列表复制实例 ID。
示例值:crs-asdasdas
Limit Integer 列表大小。每页输出的节点信息大小。默认为 20,最多输出1000条。该字段已不再使用,请忽略。
示例值:100
Offset Integer 分页偏移量,取Limit整数倍。计算公式:offset=limit*(页码-1)。该字段已不再使用,请忽略。
示例值:0

3. 输出参数

参数名称 类型 描述
ProxyCount Integer Proxy节点数量。
示例值:10
Proxy Array of ProxyNodes Proxy节点信息。
注意:此字段可能返回 null,表示取不到有效值。
RedisCount Integer Redis节点数量。
示例值:10
Redis Array of RedisNodes Redis节点信息。
注意:此字段可能返回 null,表示取不到有效值。
TendisCount Integer 该参数不再使用,请忽略。
示例值:5
Tendis Array of TendisNodes 该参数不再使用,请忽略。
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

查询节点信息

输入示例

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

{
    "InstanceId": "crs-mufy7q15"
}

输出示例

{
    "Response": {
        "Proxy": [
            {
                "NodeId": "de1d54148ed79f11c3b4a49c878b29c7218a6a30",
                "ZoneId": 100006
            },
            {
                "NodeId": "4b44ac3482e32ad1636b0d873f4fe795e1ace115",
                "ZoneId": 100006
            },
            {
                "NodeId": "524cc561f6621bc90d726dc62e15c66523754351",
                "ZoneId": 100006
            },
            {
                "NodeId": "5a0b7dfd340e8938762a3fabd390fed0e3635bb2",
                "ZoneId": 100006
            },
            {
                "NodeId": "71506b68e9ee8657b117846f66d66b8dd93a1344",
                "ZoneId": 100006
            },
            {
                "NodeId": "d4d3c819851952b01bd64e9ed7b3ada279b98ff7",
                "ZoneId": 100006
            },
            {
                "NodeId": "183a26e4ca59f98487276ce303ba50a2d71a423b",
                "ZoneId": 100006
            },
            {
                "NodeId": "002293180829fa0b2ab75b4ecd46d39194cabbfb",
                "ZoneId": 100006
            },
            {
                "NodeId": "6cd3f7b5cf412d1e93ab423c959c667e9ff6b75c",
                "ZoneId": 100006
            },
            {
                "NodeId": "52dd9608df1a0b8db6a28510866071f6638855bf",
                "ZoneId": 100006
            },
            {
                "NodeId": "6b62f8239e0851f8a2660cd13dd58bf171cb0f49",
                "ZoneId": 100006
            },
            {
                "NodeId": "6643b7242ad3c47c8b8622f28bf241db0a7b0dde",
                "ZoneId": 100006
            },
            {
                "NodeId": "dc78e5013a6cfd886eb16a49c2248b956551e77c",
                "ZoneId": 100004
            },
            {
                "NodeId": "d89e53a50448b3d61433317bc090625217cdeaf1",
                "ZoneId": 100004
            },
            {
                "NodeId": "156aebf190383685303ff68978c91adcd308ef27",
                "ZoneId": 100004
            },
            {
                "NodeId": "b8ebc56c5c346b6f79d75f81e6ee5d5f739c75f1",
                "ZoneId": 100004
            },
            {
                "NodeId": "ebbc08014c2c8c53132a541c7321dbf9cef8d09f",
                "ZoneId": 100004
            },
            {
                "NodeId": "e7c18f48e024bdd938a970a67fea207c6cf77138",
                "ZoneId": 100004
            },
            {
                "NodeId": "755d3a3ffc28786b92c2615bde8f17e37e861e57",
                "ZoneId": 100004
            },
            {
                "NodeId": "bb160769730dc46e8408c1d7ebddc8cdd6c1a0f8",
                "ZoneId": 100004
            },
            {
                "NodeId": "4ecab8b25acc46e6bd82dc469328a50fb9568656",
                "ZoneId": 100004
            },
            {
                "NodeId": "27bdbc76b6f714764fb48ff4ddc26db6a20796f5",
                "ZoneId": 100004
            },
            {
                "NodeId": "833f13e8d33ed1b5e8e87a935d0e48c4025af8c3",
                "ZoneId": 100004
            },
            {
                "NodeId": "81c2bd2f68215c5a5020fa900f481894e3b95eca",
                "ZoneId": 100004
            }
        ],
        "ProxyCount": 24,
        "Redis": [
            {
                "ClusterId": 0,
                "NodeId": "cc1e7c5ca61f52252df1ca6562db22e2af6eaa1f",
                "NodeRole": "master",
                "ZoneId": 100006
            },
            {
                "ClusterId": 0,
                "NodeId": "7b567e0bf382294e03ca88c33ef536f4a0412c7c",
                "NodeRole": "master",
                "ZoneId": 100006
            },
            {
                "ClusterId": 0,
                "NodeId": "78dd8883679ecda91293ded3051db82eec220da3",
                "NodeRole": "master",
                "ZoneId": 100006
            },
            {
                "ClusterId": 0,
                "NodeId": "134940b760fcfa727cc030b5a5e622e88b00af5c",
                "NodeRole": "slave",
                "ZoneId": 100004
            },
            {
                "ClusterId": 0,
                "NodeId": "58b509ea080e53d5aa71776688d2b70b23c63341",
                "NodeRole": "slave",
                "ZoneId": 100006
            },
            {
                "ClusterId": 0,
                "NodeId": "b451eafdfe3fa6fcd2f309b3a874414e255fc7e9",
                "NodeRole": "slave",
                "ZoneId": 100006
            },
            {
                "ClusterId": 0,
                "NodeId": "eb7baf3b620417f2ac7b2e61db47494bfe944a20",
                "NodeRole": "slave",
                "ZoneId": 100006
            },
            {
                "ClusterId": 0,
                "NodeId": "1f4fc3cf0f5dd641896fab7346c19486854b91cf",
                "NodeRole": "slave",
                "ZoneId": 100006
            },
            {
                "ClusterId": 0,
                "NodeId": "365e4bd53d1b22b7b11a478e59bedd7b36664168",
                "NodeRole": "slave",
                "ZoneId": 100004
            },
            {
                "ClusterId": 0,
                "NodeId": "6906d69a5378dc368da4cc3b0a924608ded3033a",
                "NodeRole": "slave",
                "ZoneId": 100006
            },
            {
                "ClusterId": 0,
                "NodeId": "7bf8f6080c14b449a617cff4ad4fd2b326198314",
                "NodeRole": "slave",
                "ZoneId": 100006
            },
            {
                "ClusterId": 0,
                "NodeId": "14f01a4ae7aa67aa163494bbc6e8c084961b3ca2",
                "NodeRole": "slave",
                "ZoneId": 100004
            },
            {
                "ClusterId": 0,
                "NodeId": "165bc741b8f9e929b382a6ea14ce8e9d243b4ad9",
                "NodeRole": "slave",
                "ZoneId": 100006
            },
            {
                "ClusterId": 0,
                "NodeId": "aaafa08a670047eaed7662b09ddac78e2a449590",
                "NodeRole": "slave",
                "ZoneId": 100006
            },
            {
                "ClusterId": 0,
                "NodeId": "cc37908d0829a977727ebccbac393e1e6eacb7b6",
                "NodeRole": "slave",
                "ZoneId": 100006
            }
        ],
        "RedisCount": 15,
        "RequestId": "eba33751-49d1-43a8-a4c5-5a3596b41f06",
        "Tendis": [],
        "TendisCount": 0
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.SystemError 内部系统错误,和业务无关。
InternalError.InternalError 内部错误。
InvalidParameter.PermissionDenied 接口没有cam权限。
ResourceNotFound.InstanceNotExists 根据 serialId 没有找到对应 redis。