云缓存 Redis

云缓存 Redis

产品文档

云缓存 Redis

帮助中心 > OpenAPI & SDK > 云缓存 Redis > describeClusterInfo
搜本产品

describeClusterInfo

描述

查询Redis实例的集群内部信息

请求方式

GET

请求地址

https://redis.jdcloud-api.com/v1/regions/{regionId}/cacheInstance/{cacheInstanceId}/clusterInfo

名称 类型 是否必需 默认值 描述
regionId String True 缓存Redis实例所在区域的Region ID。目前有华北-北京、华南-广州、华东-上海三个区域，Region ID分别为cn-north-1、cn-south-1、cn-east-2
cacheInstanceId String True 缓存Redis实例ID，是访问实例的唯一标识

请求参数

无

返回参数

名称 类型 描述
result Result 结果
requestId String 本次请求ID

Result

名称 类型 描述
info ClusterInfo 集群内部信息

ClusterInfo

名称 类型 描述
proxies Proxy[ ] 代理列表
shards Shard[ ] 分片列表
redis Redis[ ] redis列表

Redis

名称 类型 描述
id String

Shard

名称 类型 描述
id String

Proxy

名称 类型 描述
id String

返回码

HTTP状态码 错误码 描述
200 OK

请求示例

GET

@Test
public void testGetClusterInfo() {
  // 1. 设置请求参数
  DescribeClusterInfoRequest request = new DescribeClusterInfoRequest();
  request.regionId("cn-north-1").cacheInstanceId("redis-1234");

  // 2. 发起请求
  DescribeClusterInfoResponse response = redisClient.describeClusterInfo(request);

  // 3. 处理响应结果
  System.out.println(new Gson().toJson(response));
}

返回示例

{
    "requestId": "c3o9ip1087ivavankn482asfnpcpei45", 
    "result": {
        "info": {
            "proxies": [
                {
                    "id": "redis-1234-proxy-0"
                }, 
                {
                    "id": "redis-1234-proxy-1"
                }
            ], 
            "redis": [
                {
                    "id": "redis-1234-master-0"
                }, 
                {
                    "id": "redis-1234-slave-0"
                }, 
                {
                    "id": "redis-1234-shard-0"
                }
            ], 
            "shards": [
                {
                    "id": "redis-1234-shard-0"
                }
            ]
        }
    }
}
更新时间：2022-07-18 18:54:00
feedback