调用DescribeRoleZoneInfo查询Redis实例中各节点的详细信息,包含类型、小版本、带宽和所属的可用区等信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeRoleZoneInfo |
系统规定参数。取值:DescribeRoleZoneInfo。 |
RegionId | String | 否 | cn-hangzhou |
实例所属的地域ID,可调用DescribeRegions接口获取。 |
InstanceId | String | 是 | r-t4nlenc2p04uvb**** |
实例ID,可调用DescribeInstances接口获取。 |
QueryType | Integer | 否 | 0 |
查询的目标节点类型,取值:
|
PageNumber | Integer | 否 | 1 |
页码,大于0且不超过Integer数据类型的最大值,默认值为1。 |
PageSize | Integer | 否 | 10 |
每页可展示的记录数,取值:10、20、50,默认值为10. |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
RequestId | String | 224B97FB-A275-4EAC-86E9-8922FEA2**** |
请求ID。 |
PageNumber | Integer | 1 |
页码。 |
PageSize | Integer | 10 |
每页可展示的记录数。 |
TotalCount | Integer | 2 |
总记录数。 |
Node | Array of NodeInfo |
Redis实例中各节点的详细信息。 |
|
NodeInfo | |||
DefaultBandWidth | Long | 96 |
节点默认的默认带宽,单位为MB/s。 |
CurrentMinorVersion | String | redis-5.0_0.3.10 |
节点当前的小版本。 |
CurrentBandWidth | Long | 100 |
节点当前的带宽,单位为MB/s,由节点的默认带宽和增加的带宽组成。 说明
|
InsType | Integer | 3 |
是否为只读节点,如果为只读节点,本参数返回值为3。 说明 如果不是只读节点,不返回本参数。
|
IsLatestVersion | Integer | 1 |
是否为最新的小版本,返回值:
说明 如需升级小版本,请调用ModifyInstanceMinorVersion接口。
|
InsName | String | r-t4nlenc2p04uvb**** |
节点ID。 |
NodeType | String | normal |
节点类型,返回值:
|
ZoneId | String | cn-hangzhou-b |
可用区ID。 |
IsOpenBandWidthService | Boolean | true |
该节点是否增加了带宽,取值:
|
CustinsId | String | 30381**** |
数据分片节点ID。 |
Role | String | master |
节点角色,返回值:
|
NodeId | String | 10065**** |
本参数仅作为Redis实例内部维护使用。 |
示例
请求示例
https://r-kvstore.aliyuncs.com/?Action=DescribeRoleZoneInfo
&InstanceId=r-t4nlenc2p04uvb****
&<公共请求参数>
正常返回示例
XML
格式
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeRoleZoneInfoResponse>
<TotalCount>2</TotalCount>
<RequestId>224B97FB-A275-4EAC-86E9-8922FEA2****</RequestId>
<PageSize>10</PageSize>
<PageNumber>1</PageNumber>
<Node>
<NodeInfo>
<Role>slave</Role>
<IsLatestVersion>1</IsLatestVersion>
<ZoneId>cn-hangzhou-b</ZoneId>
<NodeType>normal</NodeType>
<IsOpenBandWidthService>true</IsOpenBandWidthService>
<NodeId>10065****</NodeId>
<CurrentMinorVersion>redis-5.0_0.3.10</CurrentMinorVersion>
<CustinsId>30381****</CustinsId>
<DefaultBandWidth>96</DefaultBandWidth>
<InsName>r-t4nlenc2p04uvb****</InsName>
<CurrentBandWidth>100</CurrentBandWidth>
</NodeInfo>
<NodeInfo>
<Role>master</Role>
<IsLatestVersion>1</IsLatestVersion>
<ZoneId>cn-hangzhou-b</ZoneId>
<NodeType>normal</NodeType>
<IsOpenBandWidthService>true</IsOpenBandWidthService>
<NodeId>10065****</NodeId>
<CurrentMinorVersion>redis-5.0_0.3.10</CurrentMinorVersion>
<CustinsId>30381****</CustinsId>
<DefaultBandWidth>96</DefaultBandWidth>
<InsName>r-t4nlenc2p04uvb****</InsName>
<CurrentBandWidth>100</CurrentBandWidth>
</NodeInfo>
</Node>
</DescribeRoleZoneInfoResponse>
JSON
格式
HTTP/1.1 200 OK
Content-Type:application/json
{
"TotalCount" : 2,
"RequestId" : "224B97FB-A275-4EAC-86E9-8922FEA2****",
"PageSize" : 10,
"PageNumber" : 1,
"Node" : {
"NodeInfo" : [ {
"Role" : "slave",
"IsLatestVersion" : 1,
"ZoneId" : "cn-hangzhou-b",
"NodeType" : "normal",
"IsOpenBandWidthService" : true,
"NodeId" : "10065****",
"CurrentMinorVersion" : "redis-5.0_0.3.10",
"CustinsId" : "30381****",
"DefaultBandWidth" : 96,
"InsName" : "r-t4nlenc2p04uvb****",
"CurrentBandWidth" : 100
}, {
"Role" : "master",
"IsLatestVersion" : 1,
"ZoneId" : "cn-hangzhou-b",
"NodeType" : "normal",
"IsOpenBandWidthService" : true,
"NodeId" : "10065****",
"CurrentMinorVersion" : "redis-5.0_0.3.10",
"CustinsId" : "30381****",
"DefaultBandWidth" : 96,
"InsName" : "r-t4nlenc2p04uvb****",
"CurrentBandWidth" : 100
} ]
}
}
错误码
访问错误中心查看更多错误码。