API 文档

有奖调研

查询实例节点信息

最近更新时间:2021-10-21 11:34:09

我的收藏

1. 接口描述

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

查询实例节点信息

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeInstanceNodeInfo。
Version String 公共参数,本接口取值:2018-04-12。
Region String 公共参数,详见产品支持的 地域列表
InstanceId String 实例ID
Limit Integer 列表大小
Offset Integer 偏移量

3. 输出参数

参数名称 类型 描述
ProxyCount Integer proxy节点数量
Proxy Array of ProxyNodes proxy节点信息
注意:此字段可能返回 null,表示取不到有效值。
RedisCount Integer redis节点数量
Redis Array of RedisNodes redis节点信息
注意:此字段可能返回 null,表示取不到有效值。
TendisCount Integer tendis节点数量
Tendis Array of TendisNodes tendis节点信息
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

https://redis.tencentcloudapi.com/?Action=DescribeInstanceNodeInfo
&InstanceId=crs-asdasdas
&<公共请求参数>

输出示例

{
  "Response": {
    "RequestId": "121d5b40-d2b8-11e9-8c40-ef686158cbd6",
    "ProxyCount": 10,
    "RedisCount": 10,
    "TendisCount": 5,
    "Proxy": [
      {
        "NodeId": "6abb7c308ed3d65930599d6f3d978971864cec77"
      }
    ],
    "Redis": [
      {
        "ClusterId": 0,
        "NodeId": "0f2ce0f969c4f43bc338bc1d6f60597d654bb3e4",
        "NodeRole": "slave"
      }
    ],
    "Tendis": [
      {
        "NodeId": "54dc6b83093359783abd2f0b07da61d3",
        "NodeRole": "master"
      }
    ]
  }
}

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。
目录