Queries information of one or more ApsaraDB for Redis instances.

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 DescribeInstances

The operation that you want to perform. Set the value to DescribeInstances.

RegionId String No cn-hangzhou

The ID of the region where the instance is deployed.

InstanceIds String No r-bp1zxszhcgatnx****

The ID of the instance.

Note Separate multiple IDs with commas (,).
InstanceStatus String No Normal

The status of the instance. Valid values:

  • Normal: The instance runs as expected.
  • Creating: The instance is being created.
  • Changing: The configurations of the instance is being changed.
  • Inactive: The instance is disabled.
  • Flushing: The data of the instance is being flushed.
  • Released: The instance is released.
  • Transforming: The instance is being transformed.
  • Unavailable: The service is unavailable.
  • Error: Failed to create the instance.
  • Migrating: The instance is being migrated.
  • BackupRecovering: The instance is being backed up or restored.
  • MinorVersionUpgrading: The minor version is being upgraded.
  • NetworkModifying: The network is being changed.
  • SSLModifying: The SSL feature is being changed.
  • MajorVersionUpgrading: The major version is being upgraded and the service is available.
ChargeType String No PostPaid

The billing method of the instance. Valid values:

  • PrePaid: subscription
  • PostPaid: pay-as-you-go
NetworkType String No CLASSIC

The network type of the instance. Valid values:

  • CLASSIC
  • VPC
EngineVersion String No 4.0

The 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 VPC.

VSwitchId String No vsw-bp1e7clcw529l773d****

The ID of the VSwitch.

PageNumber Integer No 1

The number of the page to return. Pages start from page 1. Default value: 1.

PageSize Integer No 10

The number of entries to return on each page. Valid values: 1 to 50. Default value: 10.

InstanceType String No Redis

The type of the engine. Valid values:

  • Redis.
  • Memcache.
SearchKey String No apitest

The name of the instance.

ArchitectureType String No standard

The type of the architecture. Valid values:

  • cluster: the cluster edition.
  • standard: the standard edition.
  • rwsplit: the read/write splitting edition.
Expired String No false

Specifies whether to return expired instances. Valid values:

  • true: Return expired instances.
  • false: Do not return expired instances.
ZoneId String No cn-hongkong-b

The ID of the zone.

Tag.N.Key String No {“key1”:”value1”,“key2”:”value2”}

The key of the tag. The key-value pairs of a tag consist of a key and a value. The value of this parameter must be in the {"key1":"value1","key2":"value2"} format.

Note You can specify up to five key-value pairs at a time.
Tag.N.Value String No {“key1”:”value1”,“key2”:”value2”}

The value of the tag. The key-value pairs of a tag consist of a key and a value.

ResourceGroupId String No rg-acfmyiu4ekp****

The ID of the resource group.

Note You can call the ListResourceGroups operation or log on to the console to obtain the IDs of resource groups. For more information, see View basic information about a resource group.
GlobalInstance Boolean No true

Specifies whether to filter the child instances of the distributed instance. Valid values:

  • true: Only the information about child instances are returned.
  • false: The information about child instances is not returned.
EditionType String No Enterprise

The engine type of the instance. Valid values:

  • Community: Community Edition.
  • Enterprise: Enhanced Edition.

Response parameters

Parameter Type Example Description
TotalCount Integer 1

The total number of instances that were queried.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 30

The number of entries returned per page.

Instances Array of KVStoreInstance

The information about the instances that were queried.

KVStoreInstance
ArchitectureType String cluster

The type of the architecture. Valid values:

  • cluster: the cluster edition.
  • standard: the standard edition.
  • SplitRW: the read/write splitting edition.
  • NULL : all architecture types. This is the default value.
Bandwidth Long 96

The bandwidth of the instance. Unit: MB/s.

Capacity Long 4096

The storage capacity of the instance. Unit: MB.

ChargeType String PostPaid

The billing method of the instance. Valid values:

  • PrePaid: subscription
  • PostPaid: pay-as-you-go
Config String {\"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\"}

The parameter configuration of the instance. For more information, see Set parameters.

ConnectionDomain String r-bp1zxszhcgatnx****.redis.rds.aliyuncs.com

The internal endpoint of the instance.

ConnectionMode String Standard

The connection mode of the instance. Valid values:

  • Standard: the standard mode.
  • Safe: the database proxy mode.
Connections Long 20000

The maximum number of connections supported by the instance.

CreateTime String 2018-11-07T08:49:00Z

The time when the instance was created.

DestroyTime String 2019-04-28T10:03:01Z

The time when the instance was destroyed.

EndTime String 2019-06-13T16:00:00Z

The expiration time of the subscription instance.

EngineVersion String 4.0

The engine version of the instance. Valid values: 2.8, 4.0, and 5.0.

HasRenewChangeOrder Boolean false

Indicates whether there was an order of renewal with configuration change that had not taken effect. Valid values:

  • true
  • false
InstanceClass String redis.logic.sharding.2g.2db.0rodb.4proxy.default

The specifications of the instance.

InstanceId String r-bp1zxszhcgatnx****

The ID of the instance.

InstanceName String apitest

The name of the instance.

InstanceStatus String Normal

The state of the instance.

InstanceType String Redis

The type of the instance.

IsRds Boolean true

Indicates whether the instance is managed by Relational Database Service (RDS). Valid values:

  • true
  • false
NetworkType String CLASSIC

The network type of the instance. Valid values:

  • CLASSIC
  • VPC
NodeType String double

The type of the node. Valid values:

  • double: master-replica instances.
  • single: single-replica instances (phased out).
PackageType String standard

The type of the instance plan. Valid values:

  • standard: the standard plan.
  • customized: the custom plan.
Port Long 6379

The service port of the instance.

PrivateIp String 172.16.49.***

The internal IP address of the instance.

QPS Long 100000

The queries per second (QPS) supported by the instance.

RegionId String cn-hongkong

The ID of the region.

ReplacateId String grr-bp11381ebc16****

The logical ID of the replica instance.

ResourceGroupId String rg-acfmyiu4ekp****

The ID of the resource group to which the instance belongs.

SearchKey String apitest

The keyword that is used in the fuzzy match based on the ID or description of the instance.

ShardCount Integer 3

The number of data nodes on the instance.

Note This parameter is returned only when the ApsaraDB for Redis instance is a cluster instance.
Tags Array of Tag

The details of tags.

Tag
Key String key1

The key of the tag.

Value String value1

The value of the tag.

UserName String r-bp1zxszhcgatnx****

The username that is used to connect to the instance. By default, it contains a username that is named by the instance ID.

VSwitchId String vsw-bp1e7clcw529l773d****

The ID of the VSwitch.

VpcId String vpc-bp1nme44gek34slfc****

The ID of the VPC.

ZoneId String cn-hongkong-b

The ID of the zone.

RequestId String 1E83311F-0EE4-4922-A3BF-730B312B****

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format

<DescribeInstancesResponse>
      <Instances>
            <KVStoreInstance>
                  <Connections>10000</Connections>
                  <ResourceGroupId>rg-acfmyiu4ekp****</ResourceGroupId>
                  <Config>{"EvictionPolicy":"volatile-lru","hash-max-ziplist-entries":512,"zset-max-ziplist-entries":128,"list-max-ziplist-entries":512,"list-max-ziplist-value":64,"zset-max-ziplist-value":64,"set-max-intset-entries":512,"hash-max-ziplist-value":64}</Config>
                  <Port>6379</Port>
                  <HasRenewChangeOrder>false</HasRenewChangeOrder>
                  <ConnectionDomain>r-bp1wcw2rlw76acc5k****.redis.rds.aliyuncs.com</ConnectionDomain>
                  <Capacity>1024</Capacity>
                  <QPS>80000</QPS>
                  <PrivateIp>172.16.49. ***</PrivateIp>
                  <InstanceStatus>Normal</InstanceStatus>
                  <NetworkType>VPC</NetworkType>
                  <Bandwidth>10</Bandwidth>
                  <PackageType>standard</PackageType>
                  <InstanceType>Redis</InstanceType>
                  <Tags>
                        <Tag>
                              <Value>Community Edition</Value>
                              <Key>type</Key>
                        </Tag>
                  </Tags>
                  <ArchitectureType>standard</ArchitectureType>
                  <UserName>r-bp1wcw2rlw76ac****</UserName>
                  <EngineVersion>5.0</EngineVersion>
                  <ZoneId>cn-hangzhou-f</ZoneId>
                  <InstanceId>r-bp1wcw2rlw76ac****</InstanceId>
                  <VSwitchId>vsw-bp1w9ouei2nm66qlz****</VSwitchId>
                  <CreateTime>2020-03-31T06:56:22Z</CreateTime>
                  <InstanceClass>redis.master.small.default</InstanceClass>
                  <IsRds>true</IsRds>
                  <InstanceName>Master-replica instances of Community Edition 5.0</InstanceName>
                  <VpcId>vpc-bp1opxu1zkhn00gzv****</VpcId>
                  <ChargeType>PostPaid</ChargeType>
                  <NodeType>double</NodeType>
                  <RegionId>cn-hangzhou</RegionId>
            </KVStoreInstance>
      </Instances>
      <TotalCount>1</TotalCount>
      <RequestId>78DDAA9A-B09E-4BE0-AEAE-10A22924****</RequestId>
      <PageSize>30</PageSize>
      <PageNumber>1</PageNumber>
</DescribeInstancesResponse>

JSON format

{
	"Instances": {
		"KVStoreInstance": [
			{
				"Connections": 10000,
				"ResourceGroupId": "rg-acfmyiu4ekp****",
				"Config": "{\"EvictionPolicy\":\"volatile-lru\",\"hash-max-ziplist-entries\":512,\"zset-max-ziplist-entries\":128,\"list-max-ziplist-entries\":512,\"list-max-ziplist-value\":64,\"zset-max-ziplist-value\":64,\"set-max-intset-entries\":512,\"hash-max-ziplist-value\":64}",
				"Port": 6379,
				"HasRenewChangeOrder": false,
				"ConnectionDomain": "r-bp1wcw2rlw76acc5k****.redis.rds.aliyuncs.com",
				"Capacity": 1024,
				"QPS": 80000,
				"PrivateIp": "172.16.49. ***",
				"InstanceStatus": "Normal",
				"NetworkType": "VPC",
				"Bandwidth": 10,
				"PackageType": "standard",
				"InstanceType": "Redis",
				"Tags": {
					"Tag": [
						{
							"Value": "Community Edition",
							"Key": "type"
						}
					]
				},
				"ArchitectureType": "standard",
				"UserName": "r-bp1wcw2rlw76ac****",
				"EngineVersion": "5.0",
				"ZoneId": "cn-hangzhou-f",
				"InstanceId": "r-bp1wcw2rlw76ac****",
				"VSwitchId": "vsw-bp1w9ouei2nm66qlz****",
				"CreateTime": "2020-03-31T06:56:22Z",
				"InstanceClass": "redis.master.small.default",
				"IsRds": true,
				"InstanceName": "Master-replica instances of Community Edition 5.0",
				"VpcId": "vpc-bp1opxu1zkhn00gzv****",
				"ChargeType": "PostPaid",
				"NodeType": "double",
				"RegionId": "cn-hangzhou"
			}
		]
	},
	"TotalCount": 1,
	"RequestId": "78DDAA9A-B09E-4BE0-AEAE-10A22924****",
	"PageSize": 30,
	"PageNumber": 1
}

Error codes

HttpCode Error code Error message Description
400 InvalidInstanceIds.Malformed The Specified parameter "InstanceIds" is not valid. The error message returned because the value of the InstanceIds parameter is invalid.

For a list of error codes, visit the API Error Center.