调用DescribeGlobalDistributeCache查询分布式实例的详细信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeGlobalDistributeCache

系统规定参数。取值:DescribeGlobalDistributeCache

GlobalInstanceId String gr-bp14rkqrhac****

分布式实例ID。

PageNumber String 1

页码,取值为大于0且不超过Integer数据类型的最大值,默认值为1

PageSize String 20

每页记录数。

SubInstanceId String gr-bp1zcjlobkyrq****

子实例ID。

返回数据

名称 类型 示例值 描述
PageSize Integer 20

每页可展示的记录数。

RequestId String F3F44BE3-5419-4B61-9BAC-E66E295A****

请求ID。

PageNumber Integer 1

页码。

TotalRecordCount Integer 1

总记录数。

GlobalDistributeCaches Array of GlobalDistributeCache

分布式实例详细信息列表。

Status String Normal

分布式实例状态,返回值:

  • Normal:运行中。
  • Changing:修改中。
  • Creating:创建中。
GlobalInstanceId String gr-bp14rkqrhac****

分布式实例ID。

SubInstances Array of SubInstance

子实例详细信息列表。

InstanceStatus String Normal

子实例状态,返回值:

  • Normal:正常。
  • Creating:创建中。
  • Changing:修改中。
  • Inactive:被禁用。
  • Flushing:清除中。
  • Released:已释放。
  • Transforming:转换中。
  • Unavailable:服务停止。
  • Error:创建失败。
  • Migrating:迁移中。
  • BackupRecovering:备份恢复中。
  • MinorVersionUpgrading:小版本升级中。
  • NetworkModifying:网络变更中。
  • SSLModifying:SSL变更中。
  • MajorVersionUpgrading:大版本升级中,可正常访问。
说明 更多实例状态及详细信息,请参见实例状态与影响
InstanceID String r-bp1zxszhcgatnx****

子实例ID。

InstanceClass String redis.amber.logic.sharding.2g.2db.0rodb.6proxy.multithread

子实例规格。更多信息,请参见:

GlobalInstanceId String gr-bp14rkqrhac****

分布式实例ID。

RegionId String cn-hangzhou

地域ID。

示例

请求示例

https://r-kvstore.aliyuncs.com/?Action=DescribeGlobalDistributeCache
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeGlobalDistributeCacheResponse>
    <TotalRecordCount>1</TotalRecordCount>
    <GlobalDistributeCaches>
        <Status>Normal</Status>
        <SubInstances>
            <InstanceID>r-bp14of12k0f0lw****</InstanceID>
            <InstanceStatus>Normal</InstanceStatus>
            <GlobalInstanceId>gr-bp1zcjlobkyrq****</GlobalInstanceId>
            <InstanceClass>redis.amber.logic.sharding.2g.2db.0rodb.6proxy.multithread</InstanceClass>
            <RegionId>cn-hangzhou</RegionId>
        </SubInstances>
        <GlobalInstanceId>gr-bp1zcjlobkyrq****</GlobalInstanceId>
    </GlobalDistributeCaches>
    <RequestId>F3F44BE3-5419-4B61-9BAC-E66E295A****</RequestId>
    <PageSize>20</PageSize>
    <PageNumber>1</PageNumber>
</DescribeGlobalDistributeCacheResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "TotalRecordCount" : 1,
  "GlobalDistributeCaches" : [ {
    "Status" : "Normal",
    "SubInstances" : [ {
      "InstanceID" : "r-bp14of12k0f0lw****",
      "InstanceStatus" : "Normal",
      "GlobalInstanceId" : "gr-bp1zcjlobkyrq****",
      "InstanceClass" : "redis.amber.logic.sharding.2g.2db.0rodb.6proxy.multithread",
      "RegionId" : "cn-hangzhou"
    } ],
    "GlobalInstanceId" : "gr-bp1zcjlobkyrq****"
  } ],
  "RequestId" : "F3F44BE3-5419-4B61-9BAC-E66E295A****",
  "PageSize" : 20,
  "PageNumber" : 1
}

错误码

访问错误中心查看更多错误码。