描述

用來查詢執行個體的詳細資料。

請求參數

表 1. 請求參數
名稱 類型 是否必須 描述
<公用請求參數> - 參見公用請求參數
Action String 系統規定參數,取值:DescribeInstanceAttribute
InstanceId String 執行個體 ID (全域唯一)

返回參數

表 2. 返回參數
名稱 類型 描述
Instances List 由 DBInstanceAttribute 組成的數組

DBInstanceAttribute 的參數構成

名稱 類型 描述
InstanceId String 執行個體 ID (全域唯一)
InstanceName String 執行個體名稱
Capacity Long 申請到的儲存執行個體容量; 單位:MB。
InstanceClass String 執行個體規格
Bandwidth Long 執行個體頻寬節流設定;單位:Mbps。
Connections Long 執行個體串連數限制;單位:個。
ConnectionDomain String Redis 執行個體的串連網域名稱(僅支援內網訪問)。
Port Int Redis 串連連接埠
RegionId String 申請的儲存執行個體所在地區。參見 DescribeRegions
ZoneId String RegionId 下的可用性區域編碼。參見 DescribeRegions
InstanceStatus String

執行個體狀態:

  • Normal:正常
  • Creating:建立中
  • Changing:修改中
  • Inactive:被禁用
ChargeType String 付費類型:PrePaid 或 PostPaid
CreateTime String 執行個體建立時間。採用ISO8601 標記法,並使用 UTC 時間。格式為:YYYY-MM-DDThh:mm:ssZ
EndTime String 預付費執行個體到期時間。採用ISO8601 標記法,並使用 UTC 時間。格式為: YYYY-MM-DDThh:mm:ssZ
NetworkType String 網路類型:CLASSIC 或 VPC
VpcId String VPC 的 ID
VSwitchId String 虛擬交換器 ID
PrivateIpAddress String 私人 IP 位址
MaintainStartTime String 可營運開始時間,返回格式HH:mmZ,如02:00Z。
MaintainEndTime String 可營運結束時間,返回格式: HH:mmZ ,如02:00Z。
SecurityIPList String IP 白名單
AvailabilityValue String 當月的可用性指標
注意 出於曆史相容性考慮,該函數會有些返回結構在文檔中並未提及(如 Config、Region 等),後續阿里雲將逐步把這些欄位刪除,請您在調用 API 時不要依賴這些在文檔中沒有涉及的返回欄位。

請求樣本

https://r-kvstore.aliyuncs.com、
?<公用請求參數>
&Action=DescribeInstanceAttribute
&InstanceId=736538d0a6894665

返回樣本

{
{
    "Instances" : {
        " DBInstanceAttribute " : [{
                "Bandwidth" : 128,
                "Capacity" : 512,
                "ConnectionDomain" : "de5d88e34d004211.m.cnhzalicm10pub001.r-kvstore.aliyuncs.com.com",
                "Connections" : 300,
                "ZoneId" : "cn-qingdao-b",
                "InstanceId" : "de5d88e34d004211",
                "InstanceName" : "wl123456",
                "InstanceStatus" : "Available",
                 "InstanceClass" : "redis.master.mid.default",
                "Port" : 11211,
                "QPS" : 4500,
                "RegionId" : "cn-qingdao",
                 "ChargType":"PostPaid",
                  "NetworkType":"ClASSSIC"
                "MaintainStartTime":"02:00Z",
                 "MaintainEndTime":"06:00Z",
                 "SecurityIPList": "192.168.0.1",
                  "AvailabilityValue":"100%"
        }]
  }
"RequestId" : "283746AF-82B3-4BFF-88CC-BF34CDE2732”
}