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 DescribeInstanceAttribute

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

RegionId String No cn-hangzhou

The region ID of the instance. You can call the DescribeRegions operation to query the most recent region list.

InstanceId String Yes r-bp1zxszhcgatnx****

The ID of the instance.

Response parameters

Parameter Type Example Description
RequestId String CA40C261-EB72-4EDA-AC57-958722162595

The ID of the request.

Instances Array of DBInstanceAttribute

Details about the instances.

DBInstanceAttribute
VpcId String vpc-bp1nme44gek34slfc****

The ID of the virtual private cloud (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 1024

The storage capacity of the instance. Unit: MB.

CreateTime String 2019-03-06T10:42:03Z

The time when the instance was created. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

ConnectionDomain String r-bp1d72gwl41z7f****.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
VpcAuthMode String Open

The VPC authentication mode. Valid values:

  • Open: enables password authentication.
  • Close: disables password authentication and enables password-free access. For more information, see Enable password-free access.
ArchitectureType String 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.
AvailabilityValue String 100%

The availability metric of the current month.

NetworkType String CLASSIC

The network type of the instance. Valid values:

  • CLASSIC: classic network
  • VPC: VPC
Port Long 6379

The service port of the instance.

SecondaryZoneId String cn-hongkong-h

The ID of the secondary zone.

Note This parameter is returned only if the instance has a secondary zone ID.
PackageType String standard

The plan type. Valid values:

  • standard: standard plan.
  • customized: custom plan. This plan type is phased out.
EngineVersion String 4.0

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

Config String {\"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}

The parameter configurations of the instance in the JSON format. For more information, see Modify the parameters of an ApsaraDB for Redis instance.

VpcCloudInstanceId String r-bp1d72gwl41z7f****

The ID of the instance that is deployed in the VPC.

Bandwidth Long 10

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

InstanceName String apitest

The name of the instance.

SecurityIPList String 127.0.0.1

The IP address whitelist of the instance.

ShardCount Integer 2

The number of shards. This parameter is available only for ApsaraDB for Redis instances that are purchased on the China site (aliyun.com).

GlobalInstanceId String gr-bp14rkqrhac****

The ID of the distributed instance to which the instance belongs.

Note This parameter is returned only if the instance is a child instance of the distributed instance.
QPS Long 100000

The expected maximum queries per second (QPS).

AuditLogRetention String 15

The retention period of audit logs. Unit: days. A value of 0 indicates that the audit log feature is disabled. For more information about how to enable the audit log feature, see Enable the new audit log feature.

ZoneType String singlezone

The deployment type of the instance. Valid values:

  • singlezone: The instance is deployed in a single zone.
  • doublezone: The instance is deployed in two zones of the same region.
MaintainStartTime String 18:00Z

The start time of the maintenance window. The time is in the HH:mmZ format. The time is displayed in UTC.

InstanceClass String redis.master.small.default

The instance type. For more information, see Instance types.

MaintainEndTime String 22:00Z

The end time of the maintenance window. The time is in the HH:mmZ format. The time is displayed in UTC.

InstanceId String r-bp1d72gwl41z7f****

The ID of the instance.

InstanceType String Redis

The database engine of the instance. Valid values:

  • Tair
  • Redis
  • Memcache
HasRenewChangeOrder String 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 does not have pending orders for renewal and configuration change.
InstanceReleaseProtection Boolean false

Indicates whether the release protection feature is enabled for the instance. Valid values:

  • true: The feature is enabled.
  • false: The feature is disabled.
ReplicationMode String master-slave

The replication architecture of the instance. Valid values:

  • master-slave: the standard mater-replica architecture.
  • cluster: the cluster architecture, which includes the read/write splitting instances or cluster instances.
RegionId String cn-hangzhou

The region ID of the instance.

EndTime String 2019-04-06T10:42:03Z

The time when the subscription expires. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

VSwitchId String vsw-bp1e7clcw529l773d****

The ID of the vSwitch.

ReplicaId String bls-awxxxxxxxxxxxxx

The ID of the replica node.

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 10000

The maximum number of connections supported by the instance.

BackupLogStartTime String 2021-07-06T05:49:55Z

The earliest point in time to which you can restore data. The time follows the ISO 8601 standard in the yyyy-MM-ddTHH:mm:ssZ format. The time is displayed in UTC.

Note
  • This parameter is returned only when the data flashback feature is enabled for the instance. For more information, see Use data flashback to restore data by point in time.
  • When you call the RestoreInstance operation to implement data flashback, you can determine the earliest point in time for data flashback based on the return value of this parameter. The preceding earliest point in time is also the earliest point in time that can be specified by the RestoreTime parameter.
ResourceGroupId String rg-acfmyiu4ekp****

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

ZoneId String cn-hongkong-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.
Engine String Redis

The database engine of the instance. The return value is Redis.

CloudType String cloudbox

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

Tags Array of Tag

Details about the tags.

Tag
Key String tagkey

The tag key of the instance.

Value String tagvalue

The tag value of the instance

Examples

Sample requests

https://r-kvstore.aliyuncs.com/?Action=DescribeInstanceAttribute
&InstanceId=r-bp1zxszhcgatnx****
&<Common request parameters>

Sample success responses

XML format 

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

<DescribeInstanceAttributeResponse>
    <Instances>
        <DBInstanceAttribute>
            <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>
            <ZoneType>singlezone</ZoneType>
            <ConnectionDomain>r-bp1wcw2rlw76acc5k****.redis.rds.aliyuncs.com</ConnectionDomain>
            <MaintainEndTime>22:00Z</MaintainEndTime>
            <Capacity>1024</Capacity>
            <QPS>100000</QPS>
            <PrivateIp>172.16.49.***</PrivateIp>
            <SecurityIPList>127.0.0.1</SecurityIPList>
            <InstanceStatus>Normal</InstanceStatus>
            <NetworkType>VPC</NetworkType>
            <Bandwidth>10</Bandwidth>
            <PackageType>standard</PackageType>
            <InstanceReleaseProtection>false</InstanceReleaseProtection>
            <InstanceType>Redis</InstanceType>
            <AvailabilityValue>100.0%</AvailabilityValue>
            <Engine>Redis</Engine>
            <MaintainStartTime>18:00Z</MaintainStartTime>
            <Tags>
                <Tag>
                    <Value>Community Edition</Value>
                    <Key>Type</Key>
                </Tag>
            </Tags>
            <ArchitectureType>standard</ArchitectureType>
            <EngineVersion>5.0</EngineVersion>
            <ZoneId>cn-hangzhou-f</ZoneId>
            <InstanceId>r-bp1wcw2rlw76ac****</InstanceId>
            <VSwitchId>vsw-bp1w9ouei2nm66qlz****</VSwitchId>
            <CreateTime>2020-03-31T14:56:22Z</CreateTime>
            <InstanceClass>redis.master.small.default</InstanceClass>
            <AuditLogRetention>7</AuditLogRetention>
            <IsRds>true</IsRds>
            <ReplicationMode>master-slave</ReplicationMode>
            <InstanceName>Master-replica instances of Community Edition 50</InstanceName>
            <VpcId>vpc-bp1opxu1zkhn00gzv****</VpcId>
            <ChargeType>PostPaid</ChargeType>
            <VpcAuthMode>Open</VpcAuthMode>
            <NodeType>double</NodeType>
            <VpcCloudInstanceId>r-bp1wcw2rlw76ac****</VpcCloudInstanceId>
            <RegionId>cn-hangzhou</RegionId>
        </DBInstanceAttribute>
    </Instances>
    <RequestId>D67A69DF-C1FC-4B01-B239-B17888CCFD2A</RequestId>
</DescribeInstanceAttributeResponse>

JSON format 

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

{
  "Instances" : {
    "DBInstanceAttribute" : [ {
      "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",
      "ZoneType" : "singlezone",
      "ConnectionDomain" : "r-bp1wcw2rlw76acc5k****.redis.rds.aliyuncs.com",
      "MaintainEndTime" : "22:00Z",
      "Capacity" : 1024,
      "QPS" : 100000,
      "PrivateIp" : "172.16.49.***",
      "SecurityIPList" : "127.0.0.1",
      "InstanceStatus" : "Normal",
      "NetworkType" : "VPC",
      "Bandwidth" : 10,
      "PackageType" : "standard",
      "InstanceReleaseProtection" : false,
      "InstanceType" : "Redis",
      "AvailabilityValue" : "100.0%",
      "Engine" : "Redis",
      "MaintainStartTime" : "18:00Z",
      "Tags" : {
        "Tag" : [ {
          "Value": "Community Edition",
          "Key" : "Type"
        } ]
      },
      "ArchitectureType" : "standard",
      "EngineVersion" : "5.0",
      "ZoneId" : "cn-hangzhou-f",
      "InstanceId" : "r-bp1wcw2rlw76ac****",
      "VSwitchId" : "vsw-bp1w9ouei2nm66qlz****",
      "CreateTime" : "2020-03-31T14:56:22Z",
      "InstanceClass" : "redis.master.small.default",
      "AuditLogRetention" : "7",
      "IsRds" : true,
      "ReplicationMode" : "master-slave",
      "InstanceName": "Master-replica instances of Community Edition 50",
      "VpcId" : "vpc-bp1opxu1zkhn00gzv****",
      "ChargeType" : "PostPaid",
      "VpcAuthMode" : "Open",
      "NodeType" : "double",
      "VpcCloudInstanceId" : "r-bp1wcw2rlw76ac****",
      "RegionId" : "cn-hangzhou"
    } ]
  },
  "RequestId" : "D67A69DF-C1FC-4B01-B239-B17888CCFD2A"
}

Error codes

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