Queries detailed information about an ApsaraDB for Redis instance.

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.

InstanceId String Yes r-bp1zxszhcgatnx****

The ID of the instance.
RegionId String No cn-hangzhou

The ID of the region where the instance is deployed.

Response parameters

Parameter Type Example Description
Instances Array of DBInstanceAttribute

The returned information about the instance.
DBInstanceAttribute
ArchitectureType String standard

The architecture of the ApsaraDB for Redis instance. Valid values:

  • cluster: indicates a cluster instance.
  • standard: indicates a standard instance.
  • rwsplit: indicates a read/write splitting instance.
AuditLogRetention String 15

The retention period of the audit logs in days. The value 0 indicates that the audit log feature is disabled. For more information, see Activate audit logs.

AvailabilityValue String 100%

The availability metrics in the current month.
Bandwidth Long 10

The bandwidth of the instance in MB/s.
Capacity Long 1024

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 {\"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 Parameter descriptions.

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

The endpoint of the instance.
Connections Long 10000

The maximum number of connections supported by the instance.
CreateTime String 2019-03-06T10:42:03Z

The time when the instance was created. Specify the time in the yyyy-MM-ddTHH:mm:ssZ format. The time must be in UTC.

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

The time when the subscription instance expires. Specify the time in the yyyy-MM-ddTHH:mmZ format. The time must be in UTC.

Engine String Redis

The database type. The returned value is Redis.

EngineVersion String 4.0

The database version. Valid values: 2.8, 4.0, 5.0, or 6.0.

HasRenewChangeOrder String false

Indicates whether the Alibaba Cloud account has pending renewal or scaling orders. Valid values. Valid values:

  • true: yes.
  • false: no.
InstanceClass String redis.master.small.default

The instance type.
InstanceId String r-bp1d72gwl41z7f****

The ID of the instance.
InstanceName String apitest

The name of the instance.
InstanceReleaseProtection Boolean false

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

  • true: The release protection feature is enabled.
  • false: The release protection feature is disabled.
InstanceStatus String Normal

The status of the instance.
InstanceType String Redis

The engine type of the instance.
IsRds Boolean true

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

  • true: yes.
  • false: no.
MaintainEndTime String 22:00Z

The end of the maintenance window. Specify the time in the HH:mmZ format.

MaintainStartTime String 18:00Z

The start of the maintenance window. Specify the time in the HH:mmZ format.

NetworkType String CLASSIC

The network type. Valid values:

  • CLASSIC: The instance runs in a classic network.
  • VPC: The instance runs in a virtual private cloud (VPC).
NodeType String double

The type of node. Valid values:

  • double: the master-replica node.
  • single: the single replica node. The node type is phased out.
PackageType String standard

The plan type. Valid values:

  • standard: the standard plan.
  • customized: the custom plan. The plan is phased out.
Port Long 6379

The service port of the Apsara for Redis instance.
PrivateIp String xxx.xxx.xxx.222

The internal IP address of the instance.
QPS Long 100000

The theoretical maximum queries per second (QPS).
RegionId String cn-hongkong

The ID of the region.
ReplicaId String bls-awxxxxxxxxxxxxx

The ID of the replica.
ReplicationMode String master-slave

The replication mode. Valid values:

  • master-slave: the standard mater-replica architecture.
  • cluster: the cluster architecture, including the read/write splitting or cluster instances.
ResourceGroupId String rg-acfmyiu4ekp****

The ID of the resource group to which the ApsaraDB for Redis instance belongs.
SecurityIPList String 127.0.0.1

The IP address whitelist.
ShardCount Integer 2

The number of shards.
Tags Array of Tag

The details of tags.
Tag
Key String tagkey

The tag key.
Value String tagvalue

The tag value.
VSwitchId String vsw-bp1e7clcw529l773d****

The ID of the vSwitch.
VpcAuthMode String Open

VPC authentication mode. Valid values:
VpcCloudInstanceId String r-bp1d72gwl41z7f****

The ID of the VPC where the instance is running.
VpcId String vpc-bp1nme44gek34slfc****

The ID of the VPC.
ZoneId String cn-hongkong-b

The ID of the zone.
RequestId String CA40C261-EB72-4EDA-AC57-958722162595

The ID of the request.

Examples

Sample requests

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

Sample success responses

XML format 

<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>
                  <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>Community Edition testing</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 

{
	"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",
				"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": "MasterReplicaCommunity50",
				"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.