Use DescribeGlobalDistributeCache to query distributed instance details - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Queries the details of a distributed Tair (Redis OSS-compatible) instance.

Operation description

Debugging

OpenAPI Explorer automatically calculates the signature value. You can call this operation in OpenAPI Explorer, which dynamically generates sample code for different SDKs.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

kvstore:DescribeGlobalDistributeCache

get

*DBInstance

acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
GlobalInstanceId	string	No	The ID of the distributed instance.	gr-bp14rkqrhac****
PageNumber	string	No	The page number to return. The value must be an integer greater than 0. Default value: 1.	1
PageSize	string	No	The number of entries to return per page.	20
SubInstanceId	string	No	The ID of the child instance attached to the distributed instance.	gr-bp1zcjlobkyrq****

Response elements

Element	Type	Description	Example
	object
PageSize	integer	The number of entries returned per page.	20
RequestId	string	The ID of the request.	F3F44BE3-5419-4B61-9BAC-E66E295A****
PageNumber	integer	The page number of the returned page.	1
TotalRecordCount	integer	The total number of entries returned.	1
GlobalDistributeCaches	array<object>	Details of the distributed instance.
	array<object>
Status	string	The state of the distributed instance. Valid values: Normal: The instance is normal. Changing: The instance configurations are being changed. Creating: The instance is being created.	Normal
GlobalInstanceId	string	The ID of the distributed instance.	gr-bp14rkqrhac****
SubInstances	array<object>	Details of the child instances.
	object
InstanceStatus	string	The state of the child instance. Valid values: Normal: The instance is normal. Creating: The instance is being created. Changing: The instance configurations 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, see Instance states and impacts.	Normal
InstanceID	string	The ID of the child instance.	r-bp1zxszhcgatnx****
InstanceClass	string	The instance type of the child instance. For more information, see: Standard DRAM-based instances Cluster DRAM-based instances Read/write splitting DRAM-based instances	redis.amber.logic.sharding.2g.2db.0rodb.6proxy.multithread
GlobalInstanceId	string	The ID of the distributed instance.	gr-bp14rkqrhac****
RegionId	string	The ID of the region.	cn-hangzhou

Examples

Success response

JSON format

{
  "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"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.