Call DescribeInstancesOverview to query instance overview - Tair (Redis® OSS-Compatible) - Alibaba Cloud - Tair (Redis® OSS-Compatible)

Queries the overview information of one or more ApsaraDB for Tair (Redis® OSS-Compatible) database instances.

Operation description

If you do not specify any request parameters, the overview information of all instances is returned.

Note

This operation does not support pagination for the returned results.

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:DescribeInstancesOverview

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID of the instance. You can call the DescribeRegions operation to query the region ID.	cn-hangzhou
InstanceIds	string	No	The IDs of the instances that you want to query. Note By default, all instances under the current account are queried. To specify multiple instance IDs, separate them with commas (,).	r-bp1zxszhcgatnx****
InstanceStatus	string	No	The instance status. Valid values: Normal: The instance is running. Creating: The instance is being created. Changing: The instance is being modified. Inactive: The instance is disabled. Flushing: The instance is being purged. Released: The instance is released. Transforming: The instance is being transformed. Migrating: The instance is being migrated. BackupRecovering: The instance is being restored from a backup. MinorVersionUpgrading: A minor version upgrade is in progress. NetworkModifying: The network configuration is being modified. SSLModifying: The SSL configuration is being modified. MajorVersionUpgrading: A major engine version upgrade is in progress. The instance can be accessed normally. Note For more information about instance statuses, see Instance states and impacts.	Normal
ChargeType	string	No	The billing method. Valid values: PrePaid: subscription. PostPaid: pay-as-you-go.	PostPaid
NetworkType	string	No	The network type. Valid values: CLASSIC: classic network. VPC: virtual private cloud (VPC).	CLASSIC
EngineVersion	string	No	The Redis-compatible engine version of the instance. Valid values: 2.8, 4.0, 5.0, 6.0, and 7.0. Valid values: 4.0 : 4.0 5.0 : 5.0 6.0 : 6.0 7.0 : 7.0 2.8 : 2.8	6.0
InstanceClass	string	No	The instance type. For more information, see Instance types.	redis.master.small.default
VpcId	string	No	The VPC ID.	vpc-bp1nme44gek34slfc****
VSwitchId	string	No	The vSwitch ID.	vsw-bp1e7clcw529l773d****
InstanceType	string	No	The instance type. Valid values: Tair Redis Memcache	Redis
SearchKey	string	No	The keyword used for fuzzy search by instance ID or instance description.	apitest
ArchitectureType	string	No	The architecture type. Valid values: cluster: Cluster Edition. standard: Standard Edition. rwsplit: read/write splitting edition.	standard
ZoneId	string	No	The zone ID.	cn-hangzhou-b
ResourceGroupId	string	No	The resource group ID. Note You can invoke the ListResourceGroups operation or use the console to obtain the resource group ID. Related operations, see View basic information of a resource group.	rg-acfmyiu4ekp****
EditionType	string	No	The edition type. Valid values: Community: Community Edition. Enterprise: Enterprise Edition.	Enterprise
PrivateIp	string	No	The private IP address.	172.16.49.***

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	1E83311F-0EE4-4922-A3BF-730B312B****
TotalCount	integer	The total number of instances.	1
Instances	array<object>	The list of instances.
	object	The instance object.
VpcId	string	The VPC ID.	vpc-bp1nme44gek34slfc****
PrivateIp	string	The private IP address of the instance in a VPC. The IP address may change. Use ConnectionDomain (internal endpoint) to connect to the instance. Note This parameter is not returned if the network type of the instance is classic network. This parameter is not returned for cloud-native instances.	172.16.49.***
Capacity	integer	The storage capacity of the instance. Unit: MB.	4096
CreateTime	string	The time when the instance was created.	2018-11-07T08:49:00Z
ConnectionDomain	string	The internal endpoint of the instance.	r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com
ChargeType	string	The billing method. Valid values: PrePaid: subscription. PostPaid: pay-as-you-go.	PrePaid
ArchitectureType	string	The architecture type. Valid values: cluster: Cluster Edition. standard: Standard Edition. rwsplit: read/write splitting edition.	cluster
NetworkType	string	The network type. Valid values: CLASSIC: classic network. VPC: virtual private cloud (VPC).	CLASSIC
EngineVersion	string	The Redis-compatible engine version of the instance. Valid values: 2.8, 4.0, 5.0, 6.0, and 7.0.	6.0
InstanceName	string	The name of the instance.	apitest
GlobalInstanceId	string	The distributed instance ID. Note This parameter is returned only when the instance is a child instance of a distributed instance.	gr-bp14rkqrhac****
InstanceClass	string	The instance type.	redis.logic.sharding.2g.2db.0rodb.4proxy.default
InstanceId	string	The instance ID.	r-bp1zxszhcgatnx****
InstanceType	string	The instance type. Valid values: Tair: Tair (Enterprise Edition). Redis: Redis Community Edition. Memcache	Redis
NodeType	string
RegionId	string	The region ID.	cn-hangzhou
EndTime	string	The time when the subscription instance expires.	2022-06-13T16:00:00Z
VSwitchId	string	The vSwitch ID.	vsw-bp1e7clcw529l773d****
ResourceGroupId	string	The resource group ID to which the instance belongs.	rg-acfmyiu4ekp****
ZoneId	string	The zone ID.	cn-hangzhou-b
InstanceStatus	string	The instance status. Valid values: Normal: The instance is running. Creating: The instance is being created. Changing: The instance is being modified. Inactive: The instance is disabled. Flushing: The instance is being purged. Released: The instance is released. Transforming: The instance is being transformed. Unavailable: The instance is unavailable. Error: The instance failed to be created. Migrating: The instance is being migrated. BackupRecovering: The instance is being restored from a backup. MinorVersionUpgrading: A minor version upgrade is in progress. NetworkModifying: The network configuration is being modified. SSLModifying: The SSL configuration is being modified. MajorVersionUpgrading: A major engine version upgrade is in progress. The instance can be accessed normally.	Normal
SecondaryZoneId	string	The secondary zone ID. Note This parameter is returned only when the instance has a secondary zone.	cn-hangzhou-g

Examples

Success response

JSON format

{
  "RequestId": "1E83311F-0EE4-4922-A3BF-730B312B****",
  "TotalCount": 1,
  "Instances": [
    {
      "VpcId": "vpc-bp1nme44gek34slfc****",
      "PrivateIp": "172.16.49.***",
      "Capacity": 4096,
      "CreateTime": "2018-11-07T08:49:00Z",
      "ConnectionDomain": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
      "ChargeType": "PrePaid",
      "ArchitectureType": "cluster",
      "NetworkType": "CLASSIC",
      "EngineVersion": "6.0",
      "InstanceName": "apitest",
      "GlobalInstanceId": "gr-bp14rkqrhac****",
      "InstanceClass": "redis.logic.sharding.2g.2db.0rodb.4proxy.default",
      "InstanceId": "r-bp1zxszhcgatnx****",
      "InstanceType": "Redis",
      "NodeType": "",
      "RegionId": "cn-hangzhou",
      "EndTime": "2022-06-13T16:00:00Z",
      "VSwitchId": "vsw-bp1e7clcw529l773d****",
      "ResourceGroupId": "rg-acfmyiu4ekp****",
      "ZoneId": "cn-hangzhou-b",
      "InstanceStatus": "Normal",
      "SecondaryZoneId": "cn-hangzhou-g"
    }
  ]
}

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidInstanceIds.Malformed	The Specified parameter InstanceIds is not valid.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.