Queries the details of a distributed ApsaraDB for Redis instance.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeGlobalDistributeCache

The operation that you want to perform. The operation that you want to perform. Set the value to DescribeGlobalDistributeCache.

GlobalInstanceId String No gr-bp14rkqrhac****

The ID of the distributed instance.

PageNumber String No 1

The number of the page to return. The value must be an integer that is greater than 0. Default value: 1.

PageSize String No 20

The number of entries to return each page.

SubInstanceId String No gr-bp1zcjlobkyrq****

The ID of the child instance that is attached to the distributed instance.

Response parameters

Parameter Type Example Description
PageSize Integer 20

The number of entries returned per page.

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

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

TotalRecordCount Integer 1

The total number of entries returned.

GlobalDistributeCaches Array of GlobalDistributeCache

Details of the distributed instance.

Status String Normal

The state of the distributed instance. Valid values:

  • Normal: The instance is normal.
  • Changing: The configurations of the instance are being changed.
  • Creating: The instance is being created.
GlobalInstanceId String gr-bp14rkqrhac****

The ID of the distributed instance.

SubInstances Array of SubInstance

Details of the child instances.

InstanceStatus String Normal

The state of the child instance. Valid values:

  • Normal: The instance is normal.
  • Creating: The instance is being created.
  • Changing: The configurations of the instance are being changed.
  • Inactive: The instance is disabled.
  • Flushing: The instance is being released.
  • Released: The instance is released.
  • Transforming: The billing method of the instance is changing.
  • Unavailable: The instance is suspended.
  • Error: The instance failed to be created.
  • Migrating: The instance is being migrated.
  • BackupRecovering: The instance is being restored from a backup.
  • MinorVersionUpgrading: The minor version of the instance is being updated.
  • NetworkModifying: The network type of the instance is being changed.
  • SSLModifying: The SSL certificate of the instance is being changed.
  • MajorVersionUpgrading: The major version of the instance is being upgraded. The instance remains available during the upgrade.
Note For more information about instance states, see Instance states and impacts.
InstanceID String r-bp1zxszhcgatnx****

The ID of the child instance.

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

The instance type of the child instance. For more information, see the following topics:
GlobalInstanceId String gr-bp14rkqrhac****

The ID of the distributed instance.

RegionId String cn-hangzhou

The ID of the region.

Examples

Sample requests

https://r-kvstore.aliyuncs.com/?Action=DescribeGlobalDistributeCache
&<Common request parameters>

Sample success response

XML format 

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 format 

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
}

Error codes

For a list of error codes, visit the API Error Center.