Queries the information about one or more Tair (Redis OSS-compatible) instances.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| kvstore:DescribeInstances | list | DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/*DBInstance acs:kvstore:{#regionId}:{#accountId}:instance/{#instanceId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| RegionId | string | Yes | The region ID of the instance. Note
When you call this operation and specify the Tag parameter, you must also specify this parameter.
| cn-hangzhou |
| InstanceIds | string | No | The IDs of the instances that you want to query. Note
If you want to specify multiple instance IDs, separate the instance IDs with commas (,). You can specify a maximum of 30 instance IDs in a single request.
| r-bp1zxszhcgatnx**** |
| InstanceStatus | string | No | The state of the instance. Valid values:
Note
For more information about instance states, see Instance states and impacts.
| Normal |
| ChargeType | string | No | The billing method of the instance. Valid values:
| PostPaid |
| NetworkType | string | No | The network type. Valid values:
| CLASSIC |
| EngineVersion | string | No | The database engine version of the instance. Valid values: 2.8, 4.0, 5.0, 6.0, and 7.0. Enumerated values:
| 4.0 |
| InstanceClass | string | No | The instance type of the instance. For more information, see Instance types. | redis.master.small.default |
| VpcId | string | No | The ID of the VPC. | vpc-bp1nme44gek34slfc**** |
| VSwitchId | string | No | The ID of the vSwitch. | vsw-bp1e7clcw529l773d**** |
| PageNumber | integer | No | The page number. Pages start from page 1. Default value: 1. | 1 |
| PageSize | integer | No | The number of entries per page. Maximum value: 50. Default value: 30. | 10 |
| InstanceType | string | No | The database engine. Valid values:
| Redis |
| SearchKey | string | No | The keyword used for fuzzy search. The keyword can be based on an instance name or an instance ID. | apitest |
| ArchitectureType | string | No | The architecture of the instance. Valid values:
| standard |
| Expired | string | No | Specifies whether the instance has expired. Valid values:
| false |
| ZoneId | string | No | The zone ID of the instance. | cn-hongkong-b |
| ResourceGroupId | string | No | The ID of the resource group to which the instance belongs. Note
You can query resource group IDs by using the Tair (Redis OSS-compatible) console or by calling the ListResourceGroups operation. For more information, see View basic information of a resource group.
| rg-acfmyiu4ekp**** |
| GlobalInstance | boolean | No | Specifies whether to return the child instances of distributed instances. Valid values:
| true |
| EditionType | string | No | The edition of the instance. Valid values:
| Enterprise |
| PrivateIp | string | No | The private IP address of the instance. | 172.16.49.*** |
| Tag | array<object> | No | The tags of the instance. | |
| object | No | The object. | ||
| Key | string | No | The tag key. A tag is a key-value pair. Note
A maximum of five key-value pairs can be specified at a time.
| Storage type |
| Value | string | No | The tag value. | Local disk |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "1E83311F-0EE4-4922-A3BF-730B312B****",
"PageNumber": 1,
"PageSize": 30,
"TotalCount": 1,
"Instances": {
"KVStoreInstance": [
{
"VpcId": "vpc-bp1nme44gek34slfc****",
"PrivateIp": "172.16.49.***",
"Capacity": 4096,
"ReplacateId": "grr-bp11381ebc16****",
"CreateTime": "2018-11-07T08:49:00Z",
"ConnectionDomain": "r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com",
"IsRds": true,
"ChargeType": "PostPaid",
"ArchitectureType": "cluster",
"NetworkType": "CLASSIC",
"ConnectionMode": "Standard",
"Port": 6379,
"SecondaryZoneId": "cn-hangzhou-h",
"EngineVersion": 4,
"PackageType": "standard",
"Config": "{\\\"maxmemory-policy\\\":\\\"volatile-lfu\\\",\\\"EvictionPolicy\\\":\\\"volatile-lru\\\",\\\"hash-max-ziplist-entries\\\":512,\\\"zset-max-ziplist-entries\\\":128,\\\"zset-max-ziplist-value\\\":64,\\\"set-max-intset-entries\\\":512,\\\"hash-max-ziplist-value\\\":64,\\\"#no_loose_disabled-commands\\\":\\\"flushall,flushdb\\\",\\\"lazyfree-lazy-eviction\\\":\\\"yes\\\"}",
"Bandwidth": 96,
"InstanceName": "apitest",
"ShardCount": 3,
"UserName": "r-bp1zxszhcgatnx****",
"GlobalInstanceId": "gr-bp14rkqrhac****",
"QPS": 100000,
"InstanceClass": "redis.logic.sharding.2g.2db.0rodb.4proxy.default",
"DestroyTime": "2019-04-28T10:03:01Z",
"InstanceId": "r-bp1zxszhcgatnx****",
"InstanceType": "Redis",
"HasRenewChangeOrder": false,
"RegionId": "cn-hangzhou",
"EndTime": "2019-06-13T16:00:00Z",
"VSwitchId": "vsw-bp1e7clcw529l773d****",
"NodeType": "double",
"Connections": 20000,
"ResourceGroupId": "rg-acfmyiu4ekp****",
"ZoneId": "cn-hangzhou-b",
"InstanceStatus": "Normal",
"ComputingType": "Ecs",
"CloudType": "cloudbox",
"EditionType": "Enterprise",
"Tags": {
"Tag": [
{
"Key": "key1",
"Value": "value1"
}
]
},
"ShardClass": "redis.shard.small.ce",
"ReplicaCount": 1,
"SlaveReplicaCount": 1,
"ReadOnlyCount": 1,
"SlaveReadOnlyCount": 1
}
]
}
}Error codes
| HTTP status code | Error code | Error message |
|---|---|---|
| 400 | InvalidInstanceIds.Malformed | The Specified parameter InstanceIds is not valid. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-03-25 | API Description Update. The Error code has changed | View Change Details |
| 2025-02-27 | The Error code has changed | View Change Details |
| 2024-10-09 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2024-06-19 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2023-04-13 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2022-03-07 | The Error code has changed. The response structure of the API has changed | View Change Details |
| 2022-03-07 | The Error code has changed. The response structure of the API has changed | View Change Details |