Queries the details 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 Yes cn-hangzhou

The region ID the instance.

Note If you set Tag.N.Key and Tag.N.Value when you call this operation, you must specify RegionId.
InstanceIds String No r-bp1zxszhcgatnx****

The IDs of instances.

Note If you specify multiple instance IDs, separate the instance IDs with commas (,).
InstanceStatus String No Normal

The state of the instance. Valid values:

  • Normal: The instance is normal.
  • Creating: The instance is being created.
  • Changing: The configurations of the instance are being changed.
  • Inactive: The instance is disabled.
  • Flushing: The instance is being released.
  • Released: The instance is released.
  • Transforming: The instance is being transformed.
  • Unavailable: The instance is suspended.
  • Error: The instance cannot 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.
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: classic network
  • VPC: Virtual Private Cloud (VPC)
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 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. Maximum value: 50. Default value: 10.

InstanceType String No Redis

The category of the instance. Valid values:

  • Tair
  • Redis
  • Memcache
SearchKey String No apitest

The keyword used for fuzzy search. The keyword can be based on an instance name or an instance ID.

ArchitectureType String No standard

The architecture of the instance. Valid values:

  • cluster: The instance is a cluster instance.
  • standard: The instance is a standard instance.
  • rwsplit: The instance is a read/write splitting instance.
Expired String No false

Specifies whether the instance has expired. Valid values:

  • true: The instance has expired.
  • false: The instance has not expired.
ZoneId String No cn-hongkong-b

The zone ID of the instance.

ResourceGroupId String No rg-acfmyiu4ekp****

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

Note You can query resource group IDs by using the ApsaraDB for Redis console or by calling the ListResourceGroups operation. For more information, see View basic information of a resource group.
GlobalInstance Boolean No true

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

  • true: Only child instances are returned.
  • false: Child instances are not returned.
EditionType String No Enterprise

The edition of the instance. Valid values:

  • Community: Community Edition
  • Enterprise: Enhance Edition (Tair)
PrivateIp String No 172.16.49.***

The private IP address of the instance.

Tag.N.Key String No Storage type

The key of tag N of the instance. A tag is a key-value pair.

Note Valid values of N: 1 to 5.
Tag.N.Value String No Local disk

The value of tag N of the instance.

Response parameters

Parameter Type Example Description
RequestId String 1E83311F-0EE4-4922-A3BF-730B312B****

The ID of the request.

PageNumber Integer 1

The page number of the returned page.

PageSize Integer 30

The number of entries returned per page.

TotalCount Integer 1

The total number of instances that were queried.

Instances Array of KVStoreInstance

Details about the instances.

KVStoreInstance
VpcId String vpc-bp1nme44gek34slfc****

The ID of the VPC.

PrivateIp String 172.16.49.***

The private IP address of the instance.

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.

ReplacateId String grr-bp11381ebc16****

The logical ID of the replica instance.

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.

IsRds Boolean true

Indicates whether the instance is managed by ApsaraDB RDS. Valid values:

  • true: The instance is managed by ApsaraDB RDS.
  • false: The instance is not managed by ApsaraDB RDS.
ChargeType String PostPaid

The billing method of the instance. Valid values:

  • PrePaid: subscription
  • PostPaid: pay-as-you-go
ArchitectureType String cluster

The architecture of the instance. Valid values:

  • cluster: The instance is a cluster instance.
  • standard: The instance is a standard instance.
  • SplitRW: The instance is a read/write splitting instance.
  • NULL: The instance can be a cluster instance, standard instance, or read/write splitting instance.
NetworkType String CLASSIC

The network type of the instance. Valid values:

  • CLASSIC: classic network
  • VPC: VPC
ConnectionMode String Standard

The connection mode of the instance. Valid values:

  • Standard: standard mode
  • Safe: the proxy mode
Port Long 6379

The service port of the instance.

SecondaryZoneId String cn-hangzhou-h

The ID of the secondary zone.

Note If multiple zones are returned for ZoneId such as cn-hangzhou-MAZ10(h,i), this parameter is ignored.
EngineVersion String 4.0

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

PackageType String standard

The plan type. Valid values:

  • standard: standard plan
  • customized: a custom plan
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 configurations of the instance. For more information, see Modify parameters of an instance.

Bandwidth Long 96

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

InstanceName String apitest

The name of the instance.

ShardCount Integer 3

The number of data shards in the instance.

Note This parameter is returned only when the instance is a cluster master-replica instance that uses cloud disks.
UserName String r-bp1zxszhcgatnx****

The username that is used to connect to the instance. By default, the username that is named after the instance ID is returned.

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.
QPS Long 100000

The expected maximum queries per second (QPS).

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

The instance type.

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

The time when the instance was deleted.

InstanceId String r-bp1zxszhcgatnx****

The ID of the instance.

InstanceType String Redis

The category of the instance. Valid values:

  • Tair
  • Redis
  • Memcache
HasRenewChangeOrder Boolean false

Indicates whether your Alibaba Cloud account has pending orders for renewal and configuration change. Valid values:

  • true: Your Alibaba Cloud account has pending orders for renewal and configuration change.
  • false: Your Alibaba Cloud account has no pending orders for renewal and configuration change.
RegionId String cn-hangzhou

The region ID of the cluster.

SearchKey String apitest

The keyword used for fuzzy search. The keyword can be based on an instance ID or an instance description.

EndTime String 2019-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.

NodeType String double

The node type. Valid values:

  • double: The instance contains a master node and a replica node.
  • single: The instance contains only a master node. This node type is phrased out.
Connections Long 20000

The maximum number of connections supported by the instance.

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:

  • Normal: The instance is normal.
  • Creating: The instance is being created.
  • Changing: The configurations of the instance are being changed.
  • Inactive: The instance is disabled.
  • Flushing: The instance is being released.
  • Released: The instance is released.
  • Transforming: The instance is being transformed.
  • Unavailable: The instance is suspended.
  • Error: The instance cannot 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.
CloudType String cloudbox

This parameter is displayed only when the instance is in a cloud box.

EditionType String Enterprise

The edition of the instance. Valid values:

  • Community: Community Edition
  • Enterprise: Enhance Edition (Tair)
Tags Array of Tag

Details about the tags.

Tag
Key String key1

The key of the tag.

Value String value1

The value of the tag.

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

<DescribeInstancesResponse>
    <Instances>
        <KVStoreInstance>
            <Connections>10000</Connections>
            <ResourceGroupId>rg-acfmyiu4ekp****</ResourceGroupId>
            <Config>{&quot;EvictionPolicy&quot;:&quot;volatile-lru&quot;,&quot;hash-max-ziplist-entries&quot;:512,&quot;zset-max-ziplist-entries&quot;:128,&quot;list-max-ziplist-entries&quot;:512,&quot;list-max-ziplist-value&quot;:64,&quot;zset-max-ziplist-value&quot;:64,&quot;set-max-intset-entries&quot;:512,&quot;hash-max-ziplist-value&quot;: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 the Community Edition 50</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

HTTP/1.1 200 OK
Content-Type:application/json

{
  "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 the Community Edition 50",
      "VpcId" : "vpc-bp1opxu1zkhn00gzv****",
      "ChargeType" : "PostPaid",
      "NodeType" : "double",
      "RegionId" : "cn-hangzhou"
    } ]
  },
  "TotalCount" : 1,
  "RequestId" : "78DDAA9A-B09E-4BE0-AEAE-10A22924****",
  "PageSize" : 30,
  "PageNumber" : 1
}

Error codes

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