Queries the details about 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. Set the value to DescribeGlobalDistributeCache.

RegionId String No cn-hangzhou

The region ID of the distributed instance. You can call the DescribeRegions operation to query the most recent region list.

GlobalInstanceId String No gr-bp14rkqrhac****

The ID of the distributed instance.

PageNumber String No 1

The number of the page to return. Valid values: any non-zero positive integer. Default value: 1.

PageSize String No 20

The number of entries to return on 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
GlobalDistributeCaches Array of GlobalDistributeCache

An array that consists of the details about the distributed instance.

GlobalInstanceId String gr-bp14rkqrhac****

The ID of the distributed instance.

Status String Normal

The status of the distributed instance. Valid values:

  • Normal: The distributed instance is running as expected.
  • Changing: The specifications of the distributed instance are being changed.
  • Creating: The distributed instance is being created.
SubInstances Array of SubInstance

An array that consists of the details about the child instances that are attached to the distributed instance.

GlobalInstanceId String gr-bp14rkqrhac****

The ID of the distributed 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:

InstanceID String r-bp1zxszhcgatnx****

The ID of the child instance.

InstanceStatus String Normal

The status of the child instance. Valid values:

  • Normal: The child instance is running as expected.
  • Creating: The child instance is being created.
  • Changing: The specifications of the child instance are being changed.
  • Inactive: The child instance is disabled.
  • Flushing: The child instance is being released.
  • Released: The child instance is released.
  • Transforming: The child instance is being transformed.
  • Unavailable: The child instance is suspended.
  • Error: The child instance failed to be created.
  • Migrating: The child instance is being migrated.
  • BackupRecovering: The data of the child instance is being restored from a backup file.
  • MinorVersionUpgrading: The minor version of the child instance is being updated.
  • NetworkModifying: The network type of the child instance is being changed.
  • SSLModifying: The SSL certificate of the child instance is being modified.
  • MajorVersionUpgrading: The major version of the child instance is being upgraded. The child instance can be accessed during the upgrade process.
RegionId String cn-hangzhou

The region ID of the distributed instance.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 20

The number of entries returned per page.

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

The ID of the request.

TotalRecordCount Integer 1

The total number of entries returned.

Examples

Sample requests

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

Sample success responses

XML format

<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

{
	"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.