DescribeNodeIds--缓存数据库 Redis 版-火山引擎

文档中心

立即注册

导航

DescribeNodeIds

最近更新时间：2024.07.18 22:55:12首次发布时间：2022.08.05 11:55:16

调用 DescribeNodeIds 接口查询目标 Redis 实例中的所有 Proxy 和 Server 节点 ID 列表。

请求类型

同步请求。

请求参数

参数	类型	是否必选	示例值	描述
InstanceId	String	是	redis-cn02sg5o56sbs****	实例 ID。说明您可以调用 DescribeDBInstances 接口查询目标地域下所有 Redis 实例的基本信息，包括实例 ID。

返回参数

参数	类型	示例值	描述
NodeIds	String[]	[ "server-redis-cn02sg5o56sbs**-0-0", "server-redis-cn02sg5o56sbs-0-1", "proxy-redis-cn02sg5o56sbs-0", "proxy-redis-cn02sg5o56sbs**-1" ]	节点 ID 列表。

示例

请求示例

POST https://redis.volcengineapi.com/?Action=DescribeNodeIds&Version=2020-12-07 HTTP/1.1
Host: redis.volcengineapi.com
Content-Type: application/json; charset=utf-8
X-Date: 20201103T104027Z
Authorization: HMAC-SHA256 Credential=AK****/20201103/cn-beijing/Redis/request,SignedHeaders=content-type;host;x-date,Signature=****
{
    "InstanceId":"redis-cn0212gzmh2xs****"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022072614403501017424420200AB****",
        "Action": "DescribeNodeIds",
        "Version": "2020-12-07",
        "Service": "Redis",
        "Region": "cn-beijing"
    },
    "Result": {
        "NodeIds": [
            "server-redis-cn02sg5o56sbs****-0-0",
            "server-redis-cn02sg5o56sbs****-0-1",
            "proxy-redis-cn02sg5o56sbs****-0",
            "proxy-redis-cn02sg5o56sbs****-1"
        ]
    }
}

错误码

更多详情，请参见错误码。