edit-icon download-icon


Last Updated: Apr 29, 2018


This API is used to query details of an instance.

Request parameters

Name Type Required Description
Common request parameters - Yes For more information, see Common request parameters.
Action String Yes Required parameter. Value: DescribeInstanceAttribute.
InstanceId String Yes Instance ID (globally unique)

Response parameters

Name Type Description
Instances List Array composed of DBInstanceAttributes

DBInstanceAttribute parameter structure

Name Type Description
InstanceId String Instance ID (globally unique)
InstanceName String Instance name
Capacity Long Capacity of the applied ApsaraDB for Redis instance. Unit: MB.
InstanceClass String Instance type
Bandwidth Long Instance bandwidth limit. Unit: Mbit/s.
Connections Long Instance connection quantity limit. Unit: count.
ConnectionDomain String Connection domain of the ApsaraDB for Redis instance (only Intranet access supported)
Port Int ApsaraDB for Redis connection port
RegionId String Region of the applied ApsaraDB for Redis instance. For more information, see DescribeRegions.
ZoneId String Lower-level zone ID of the RegionId. For more information, see DescribeRegions.
InstanceStatus String Instance status:
- Normal
- Creating
- Changing
- Inactive
ChargeType String Billing method. Supported values: PrePaid and PostPaid.
CreateTime String Instance creation time.
The time format follows the ISO8601 notation, and the UTC time is used in the format of YYYY-MM-DDThh:mm:ssZ.
EndTime String Expiration time for a pre-paid instance.
The time format follows the ISO8601 notation, and the UTC time is used in the format of YYYY-MM-DDThh:mm:ssZ.
NetworkType String Network type. Supported values: CLASSIC and VPC.
VpcId String VPC ID
VSwitchId String VSwitch ID
PrivateIpAddress String Private IP address
MaintainStartTime String Maintenance start time
MaintainEndTime String Maintenance end time
SecurityIPList String IP address whitelist
AvailabilityValue String Availability metrics of the current month

Note: In consideration of the historical compatibility, some returned fields (such as Config and Region) of the function are not mentioned in this document. Alibaba Cloud will delete these fields gradually in the future. In this case, do not rely on the returned fields not involved in this document when calling the APls.


Request example

  1. https://r-kvstore.aliyuncs.com
  2. ?<Common request parameters>
  3. &Action=DescribeInstanceAttribute
  4. &InstanceId=736538d0a6894665

Response example

  1. {
  2. {
  3. "Instances" : {
  4. " DBInstanceAttribute " : [{
  5. "Bandwidth" : 128,
  6. "Capacity" : 512,
  7. "ConnectionDomain" : "de5d88e34d004211.m.cnhzalicm10pub001.r-kvstore.aliyuncs.com.com",
  8. "Connections" : 300,
  9. "ZoneId" : "cn-qingdao-b",
  10. "InstanceId" : "de5d88e34d004211",
  11. "InstanceName" : "wl123456",
  12. "InstanceStatus" : "Available",
  13. "InstanceClass" : "redis.master.mid.default",
  14. "Port" : 11211,
  15. "QPS" : 4500,
  16. "RegionId" : "cn-qingdao",
  17. "ChargType""PostPaid",
  18. "NetworkType":"ClASSSIC"
  19. "MaintainStartTime""02:00Z"
  20. "MaintainEndTime""06:00Z"
  21. "SecurityIPList": ""
  22. "AvailabilityValue":"100%"
  23. }]
  24. }
  25. "RequestId" : "283746AF-82B3-4BFF-88CC-BF34CDE2732
  26. }
Thank you! We've received your feedback.