AI 助理
备案控制台
文档
输入文档关键字查找
首页

DescribeGlobalDistributeCache - 查询分布式实例的详细信息

更新时间：
我的收藏

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

调试

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

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
kvstore:DescribeGlobalDistributeCacheget
  • DBInstance
    acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}
    无
无

请求参数

名称类型必填描述示例值
GlobalInstanceIdstring否

分布式实例 ID。

gr-bp14rkqrhac****
PageNumberstring否

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

1
PageSizestring否

每页记录数。

20
SubInstanceIdstring否

子实例 ID。

gr-bp1zcjlobkyrq****

返回参数

名称类型描述示例值
object
PageSizeinteger

每页可展示的记录数。

20
RequestIdstring

请求 ID。

F3F44BE3-5419-4B61-9BAC-E66E295A****
PageNumberinteger

页码。

1
TotalRecordCountinteger

总记录数。

1
GlobalDistributeCachesarray<object>

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

GlobalDistributeCacheobject
Statusstring

分布式实例状态，返回值：

  • Normal：运行中。
  • Changing：修改中。
  • Creating：创建中。
Normal
GlobalInstanceIdstring

分布式实例 ID。

gr-bp14rkqrhac****
SubInstancesarray<object>

子实例详细信息列表。

SubInstanceobject
InstanceStatusstring

子实例状态，返回值：

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

子实例 ID。

r-bp1zxszhcgatnx****
InstanceClassstring

子实例规格。更多信息，请参见：

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

分布式实例 ID。

gr-bp14rkqrhac****
RegionIdstring

地域 ID。

cn-hangzhou

示例

正常返回示例

JSON格式

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

错误码

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