Queries the overview information of one or more ApsaraDB for Redis instances.
If you do not specify request parameters when you call this operation, the overview information of all instances is returned.
Debugging
Request parameters
Parameter | Type | Required | Example | Description |
---|---|---|---|---|
Action | String | Yes | DescribeInstancesOverview |
The operation that you want to perform. Set the value to DescribeInstancesOverview. |
RegionId | String | Yes | cn-hangzhou |
The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list. |
InstanceIds | String | No | r-bp1zxszhcgatnx**** |
The IDs of the instances. Note By default, all instances that belong to this account are queried. If you specify
multiple instance IDs, separate the instance IDs with commas (,).
|
InstanceStatus | String | No | Normal |
The state of the instance. Valid values:
|
ChargeType | String | No | PostPaid |
The billing method of the instance. Valid values:
|
NetworkType | String | No | CLASSIC |
The network type of the instance. Valid values:
|
EngineVersion | String | No | 4.0 |
The database engine version of the instance. Valid values: 2.8, 4.0, and 5.0. |
InstanceClass | String | No | redis.master.small.default |
The instance type. For more information, see Instance types. |
VpcId | String | No | vpc-bp1nme44gek34slfc**** |
The ID of the virtual private cloud (VPC). |
VSwitchId | String | No | vsw-bp1e7clcw529l773d**** |
The ID of the vSwitch. |
InstanceType | String | No | Redis |
The database engine of the instance. Valid values:
|
SearchKey | String | No | apitest |
The instance ID or description keyword that is used for fuzzy match. |
ArchitectureType | String | No | standard |
The architecture of the instance. Valid values:
|
ZoneId | String | No | cn-hangzhou-b |
The zone ID of the instance. |
ResourceGroupId | String | No | rg-acfmyiu4ekp**** |
The ID of the resource group. Note You can query the IDs of resource groups by using the ApsaraDB for Redis console or
by calling the ListResourceGroups operation. For more information, see View basic information of a resource group.
|
EditionType | String | No | Enterprise |
The edition of the instance. Valid values:
|
PrivateIp | String | No | 172.16.49.*** |
The IP address of the instance in the VPC. |
Response parameters
Parameter | Type | Example | Description |
---|---|---|---|
RequestId | String | 1E83311F-0EE4-4922-A3BF-730B312B**** |
The ID of the request. |
TotalCount | Integer | 1 |
The total number of instances that were queried. |
Instances | Array of KVStoreInstance |
The array of instances. |
|
VpcId | String | vpc-bp1nme44gek34slfc**** |
The ID of the VPC. |
PrivateIp | String | 172.16.49.*** |
The IP address of the instance in the VPC. Note This parameter is not returned when the instance is deployed in the classic network.
|
Capacity | Long | 4096 |
The storage capacity of the instance. Unit: MB. |
CreateTime | String | 2018-11-07T08:49:00Z |
The time when the instance was created. |
ConnectionDomain | String | r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com |
The internal endpoint of the instance. |
ChargeType | String | PostPaid |
The billing method of the instance. Valid values:
|
ArchitectureType | String | cluster |
The architecture of the instance. Valid values:
|
NetworkType | String | CLASSIC |
The network type. Valid values:
|
ConnectionMode | String | Standard |
The connection mode of the instance. Valid values:
|
Port | Long | 6379 |
The port of the instance. |
EngineVersion | String | 4.0 |
The database engine version of the instance. Valid values: 2.8, 4.0, and 5.0. |
InstanceName | String | apitest |
The name of the instance. |
GlobalInstanceId | String | gr-bp14rkqrhac**** |
The ID of the distributed instance to which the instance belongs. Note This parameter is returned only when the instance is a child instance of a distributed
instance.
|
InstanceClass | String | redis.logic.sharding.2g.2db.0rodb.4proxy.default |
The instance type. |
InstanceId | String | r-bp1zxszhcgatnx**** |
The ID of the instance. |
InstanceType | String | Redis |
The database engine of the instance. Valid values:
|
RegionId | String | cn-hangzhou |
The region ID of the instance. |
EndTime | String | 2022-06-13T16:00:00Z |
The time when the instance expires if the instance is charged based on the subscription billing method. |
VSwitchId | String | vsw-bp1e7clcw529l773d**** |
The ID of the vSwitch. |
ResourceGroupId | String | rg-acfmyiu4ekp**** |
The ID of the resource group to which the instance belongs. |
ZoneId | String | cn-hangzhou-b |
The zone ID of the instance. |
InstanceStatus | String | Normal |
The state of the instance. Valid values:
|
Examples
Sample requests
https://r-kvstore.aliyuncs.com/?Action=DescribeInstances
&RegionId=cn-hangzhou
&<Common request parameters>
Sample success responses
XML
format
HTTP/1.1 200 OK
Content-Type:application/xml
<DescribeInstancesOverviewResponse>
<Instances>
<ArchitectureType>cluster</ArchitectureType>
<Capacity>32768</Capacity>
<ChargeType>PrePaid</ChargeType>
<ConnectionDomain>r-bp1d****letsgv****.tairpena.rds.aliyuncs.com</ConnectionDomain>
<CreateTime>2021-11-11T06:52:52Z</CreateTime>
<EndTime>2021-12-11T16:00:00Z</EndTime>
<EngineVersion>1.0</EngineVersion>
<InstanceClass>tair.scm.cluster.sharding.common.ce</InstanceClass>
<InstanceId>r-bp1d****letsgv****</InstanceId>
<InstanceName>aep***-pull-cluster</InstanceName>
<InstanceStatus>Normal</InstanceStatus>
<InstanceType>tair_scm</InstanceType>
<NetworkType>VPC</NetworkType>
<PrivateIp>172.16.*.*</PrivateIp>
<RegionId>cn-hangzhou</RegionId>
<ResourceGroupId>rg-acfm22c********</ResourceGroupId>
<VSwitchId>vsw-bp1p9le7ibusm********</VSwitchId>
<VpcId>vpc-bp1jk5vwkcri2********</VpcId>
<ZoneId>cn-hangzhou-h</ZoneId>
</Instances>
<RequestId>E9848396-E363-5ECE-94D2-E0CF993*****</RequestId>
<TotalCount>1</TotalCount>
</DescribeInstancesOverviewResponse>
JSON
format
HTTP/1.1 200 OK
Content-Type:application/json
{
"Instances" : [ {
"ArchitectureType" : "cluster",
"Capacity" : 32768,
"ChargeType" : "PrePaid",
"ConnectionDomain" : "r-bp1d****letsgv****.tairpena.rds.aliyuncs.com",
"CreateTime" : "2021-11-11T06:52:52Z",
"EndTime" : "2021-12-11T16:00:00Z",
"EngineVersion" : "1.0",
"InstanceClass" : "tair.scm.cluster.sharding.common.ce",
"InstanceId" : "r-bp1d****letsgv****",
"InstanceName" : "aep***-pull-cluster",
"InstanceStatus" : "Normal",
"InstanceType" : "tair_scm",
"NetworkType" : "VPC",
"PrivateIp" : "172.16.*.*",
"RegionId" : "cn-hangzhou",
"ResourceGroupId" : "rg-acfm22c********",
"VSwitchId" : "vsw-bp1p9le7ibusm********",
"VpcId" : "vpc-bp1jk5vwkcri2********",
"ZoneId" : "cn-hangzhou-h"
} ],
"RequestId" : "E9848396-E363-5ECE-94D2-E0CF993*****",
"TotalCount" : 1
}
Error codes
For a list of error codes, visit the API Error Center.