DescribeCacheByRole

查询缓存服务的详细信息，展示出主从高可用/集群下的节点信息；

请求方式

GET

请求参数

关于所有操作需要的通用参数，参照请见－公共请求头

英文名称	中文名称	类型	是否必填	备注
Action	接口名称	String	是	固定值：DescribeCacheByRole
Version	接口版本	String	是	固定值：2016-07-01
AvailableZone	可用区	String	否	默认：对应机房的a区
CacheId	缓存服务ID	String	是	缓存服务ID
Proxy	节点角色	String	否	节点类型：MASTER、SLAVE、READONLY、PROXY

返回结果

英文名称	中文名称	类型	备注
RequestId	请求ID	String	请求标识
Data	返回数据信息	Array	参照请见－只读节点返回信息

只读节点返回信息：

英文名称	中文名称	类型	备注
instanceId	节点ID	String	节点ID
name	节点名称	String	节点名称
port	节点端口	Integer	节点端口
ip	节点IP	String	节点IP
status	节点状态	String	参照请见－缓存服务节点状态
createTime	创建时间	Date	创建时间
proxy	节点类型	String	节点类型
area	节点所在可用区	String	节点所在可用区

错误信息

关于所有操作返回的错误信息，参照请见－通用异常信息

请求示例

https://kcs.api.ksyun.com/?Action=DescribeCacheByRole&Version=2016-07-01&CacheId=6831d39b-18f2-40eb-bb28-2e7946e41c99&AvailableZone=cn-beijing-6c

响应示例

{
    "RequestId": "3988970f-b68b-4148-b47e-83af9a73281e",
    "Data": [
        {
            "instanceId": "6e70f301-40cf-4de3-a227-47c0dcfd960e",
            "name": "众里寻他千百度--readonly--4",
            "port": 6379,
            "ip": "10.123.71.44",
            "status": "running",
            "createTime": "2021-08-13 16:27:50",
            "proxy": "READONLY",
            "area": "可用区C"
        },
        {
            "instanceId": "7946d4c0-0510-4f99-8cc6-c6f5e229a7ad",
            "name": "众里寻他千百度--slave",
            "port": 6379,
            "ip": "10.123.71.39",
            "status": "running",
            "createTime": "2021-08-12 18:15:06",
            "proxy": "SLAVE",
            "area": "可用区C"
        },
        {
            "instanceId": "ce9c81bd-2a0b-4885-868b-9928cf25e459",
            "name": "众里寻他千百度--readonly--1",
            "port": 6379,
            "ip": "10.123.49.145",
            "status": "running",
            "createTime": "2021-08-12 18:15:06",
            "proxy": "READONLY",
            "area": "可用区C"
        },
        {
            "instanceId": "e9840e3c-d1c2-4522-a2d8-ffcf82e5e500",
            "name": "众里寻他千百度--readonly--3",
            "port": 6379,
            "ip": "10.123.69.44",
            "status": "running",
            "createTime": "2021-08-13 16:25:12",
            "proxy": "READONLY",
            "area": "可用区C"
        },
        {
            "instanceId": "f25daf2a-c712-40bb-bce9-3ca675e4b986",
            "name": "众里寻他千百度",
            "port": 6379,
            "ip": "10.123.70.39",
            "status": "running",
            "createTime": "2021-08-12 18:15:06",
            "proxy": "MASTER",
            "area": "可用区C"
        },
        {
            "instanceId": "fd7b4193-70c8-44c7-91d3-7a17bd3a4435",
            "name": "众里寻他千百度--readonly--0",
            "port": 6379,
            "ip": "10.123.68.40",
            "status": "running",
            "createTime": "2021-08-12 18:15:06",
            "proxy": "READONLY",
            "area": "可用区C"
        }
    ]
}

文档导读

上一篇：缓存服务解锁

下一篇：参数管理

纯净模式常规模式

纯净模式

点击可全屏预览文档内容