调用DescribeRoleZoneInfo查询Redis实例中各节点的角色、类型、小版本和所属的可用区。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeRoleZoneInfo |
系统规定参数,取值:DescribeRoleZoneInfo。 |
InstanceId | String | 是 | r-bp1zxszhcgatnx**** |
实例ID,可调用DescribeInstances接口获取。 |
RegionId | String | 否 | cn-hangzhou |
实例所属的地域ID,可调用DescribeRegions接口获取。 |
QueryType | Integer | 否 | 0 |
查询的目标节点类型,取值:
|
PageNumber | Integer | 否 | 1 |
页码,大于0且不超过Integer数据类型的最大值,默认值为1。 |
PageSize | Integer | 否 | 10 |
每页可展示的记录数,取值:10、20、50,默认值为10. |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
Node | Array of NodeInfo |
Redis实例中各节点的详细信息。 |
|
NodeInfo | |||
CurrentMinorVersion | String | redis-5.0_0.3.10 |
节点当前的小版本。 |
CustinsId | String | 38707894 |
本参数仅作为Redis实例内部维护使用。 |
InsName | String | r-bp1bjmqwlelmkh****-db-0 |
节点ID。 |
InsType | Integer | 3 |
是否为只读节点,如果为只读节点,本参数返回值为3。 说明 如果不是只读节点,不返回本参数。
|
IsLatestVersion | Integer | 1 |
是否为最新的小版本,返回值:
说明 如需升级小版本,请调用ModifyInstanceMinorVersion接口。
|
NodeId | String | 1595**** |
本参数仅作为Redis实例内部维护使用。 |
NodeType | String | db |
节点类型,返回值:
|
Role | String | master |
节点角色,返回值:
|
ZoneId | String | cn-hangzhou-b |
可用区ID。 |
PageNumber | Integer | 1 |
页码。 |
PageSize | Integer | 10 |
每页可展示的记录数。 |
RequestId | String | 224B97FB-A275-4EAC-86E9-8922FEA2**** |
请求ID。 |
TotalCount | Integer | 4 |
总记录数。 |
示例
请求示例
https://r-kvstore.aliyuncs.com/?Action=DescribeRoleZoneInfo
&InstanceId=r-bp1zxszhcgatnx****
&<公共请求参数>
正常返回示例
XML
格式
<DescribeRoleZoneInfoResponse>
<TotalCount>4</TotalCount>
<RequestId>224B97FB-A275-4EAC-86E9-8922FEA2****</RequestId>
<Node>
<NodeInfo>
<Role>master</Role>
<IsLatestVersion>1</IsLatestVersion>
<ZoneId>cn-hangzhou-b</ZoneId>
<NodeType>db</NodeType>
<NodeId>1595****</NodeId>
<CurrentMinorVersion>redis-5.0_0.3.10</CurrentMinorVersion>
<CustinsId>3870****</CustinsId>
<InsName>r-bp1bjmqwlelmkh****-db-0</InsName>
</NodeInfo>
<NodeInfo>
<Role>slave</Role>
<IsLatestVersion>1</IsLatestVersion>
<ZoneId>cn-hangzhou-b</ZoneId>
<NodeType>db</NodeType>
<NodeId>1595****</NodeId>
<CurrentMinorVersion>redis-5.0_0.3.10</CurrentMinorVersion>
<CustinsId>3870****</CustinsId>
<InsName>r-bp1bjmqwlelmkh****-db-0</InsName>
</NodeInfo>
<NodeInfo>
<Role>master</Role>
<IsLatestVersion>1</IsLatestVersion>
<ZoneId>cn-hangzhou-b</ZoneId>
<NodeType>db</NodeType>
<NodeId>1595****</NodeId>
<CurrentMinorVersion>redis-5.0_0.3.10</CurrentMinorVersion>
<CustinsId>3870****</CustinsId>
<InsName>r-bp1bjmqwlelmkh****-db-1</InsName>
</NodeInfo>
<NodeInfo>
<Role>slave</Role>
<IsLatestVersion>1</IsLatestVersion>
<ZoneId>cn-hangzhou-b</ZoneId>
<NodeType>db</NodeType>
<NodeId>1595****</NodeId>
<CurrentMinorVersion>redis-5.0_0.3.10</CurrentMinorVersion>
<CustinsId>3870****</CustinsId>
<InsName>r-bp1bjmqwlelmkh****-db-1</InsName>
</NodeInfo>
</Node>
</DescribeRoleZoneInfoResponse>
JSON
格式
{
"TotalCount": 4,
"RequestId": "224B97FB-A275-4EAC-86E9-8922FEA2****",
"Node": {
"NodeInfo": [
{
"Role": "master",
"IsLatestVersion": 1,
"ZoneId": "cn-hangzhou-b",
"NodeType": "db",
"NodeId": "1595****",
"CurrentMinorVersion": "redis-5.0_0.3.10",
"CustinsId": "3870****",
"InsName": "r-bp1bjmqwlelmkh****-db-0"
},
{
"Role": "slave",
"IsLatestVersion": 1,
"ZoneId": "cn-hangzhou-b",
"NodeType": "db",
"NodeId": "1595****",
"CurrentMinorVersion": "redis-5.0_0.3.10",
"CustinsId": "3870****",
"InsName": "r-bp1bjmqwlelmkh****-db-0"
},
{
"Role": "master",
"IsLatestVersion": 1,
"ZoneId": "cn-hangzhou-b",
"NodeType": "db",
"NodeId": "1595****",
"CurrentMinorVersion": "redis-5.0_0.3.10",
"CustinsId": "3870****",
"InsName": "r-bp1bjmqwlelmkh****-db-1"
},
{
"Role": "slave",
"IsLatestVersion": 1,
"ZoneId": "cn-hangzhou-b",
"NodeType": "db",
"NodeId": "1595****",
"CurrentMinorVersion": "redis-5.0_0.3.10",
"CustinsId": "3870****",
"InsName": "r-bp1bjmqwlelmkh****-db-1"
}
]
}
}
错误码
访问错误中心查看更多错误码。
在文档使用中是否遇到以下问题
更多建议
匿名提交