描述

查詢賬戶下的某一個或多個執行個體資訊。

請求參數

表 1. 請求參數
名稱 類型 是否必須 描述
<公用請求參數> - - 參見公用請求參數。
Action String 是 操作介面名，取值：DescribeInstances。
InstanceIds String 否 執行個體 ID（全域唯一）。指定執行個體 ID 時需輸入。若查詢多個執行個體 ID 時，使用英文半形逗號（“,”）分隔各 ID；置空時預設為查詢該使用者名下所有執行個體。
InstanceStatus String 否

按狀態過濾所需返回的執行個體：

  • Normal：正常
  • Creating：建立中
  • Changing：修改中
  • Inactive：被禁用
ChargeType String 否 按付費類型過濾所需返回的執行個體：
  • PrePaid：預付費
  • PostPaid：後付費
RegionId String 是 調用 DescribeRegions 查詢 RegionId。
InstanceType String 否 引擎類型的過濾。
  • Memcache：Memcache 類型的執行個體
  • Redis：Redis 類型的執行個體
PageNumber Integer 否 執行個體狀態列表的頁碼，起始值為1，預設值為1。
PageSize Integer 否 分頁查詢時設定的每頁行數，最大值50行，預設值為10。
NetworkType String 否 按網路類型過濾：
  • CLASSIC：傳統網路類型
  • VPC：VPC 網路類型

返回參數

表 2. 返回參數
名稱 類型 描述
<公用返回參數> - 參見公用返回參數。
Instances List 由 Instance 組成的數組。
TotalCount Integer 執行個體總個數
PageNumber Integer 執行個體列表的頁碼
PageSize Integer 輸入時設定的每頁行數

Instance 的參數構成

名稱 類型 描述
InstanceId String 執行個體 ID （全域唯一）
InstanceName String 執行個體名稱
Capacity Long 申請到的儲存執行個體容量； 單位：MB。
InstanceClass String 執行個體規格資訊
Bandwidth Long 執行個體頻寬節流設定；單位：Mbps。
Connections Long 執行個體串連數限制；單位：個。
ConnectionDomain String 執行個體串連網域名稱（僅支援內網訪問。）
Port Int 串連連接埠
UserName String 串連使用者名
RegionId String 申請的儲存執行個體所在地區
ZoneId String RegionId 下的可用性區域編碼
InstanceStatus String 執行個體狀態：
  • Normal：正常
  • Creating：建立中
  • Changing：修改中
  • Inactive：被禁用
  • Transforming：轉換中
  • BackupRecovering：備份恢複中
  • MinorVersionUpgrading：執行個體小版本升級中
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
PrivateIpAddr String 私人 IP 位址
注意 出於曆史相容性考慮，該函數會有些返回結構在文檔中並未提及（如 Config），後續阿里雲將逐步把這些欄位刪除，請您在調用 API 時不要依賴這些在文檔中沒有涉及的返回欄位。

請求樣本

https://r-kvstore.aliyuncs.com.com/
?<公用請求參數>
&Action=DescribeInstances
&PageNumber=1
&PageSize=10
&InstanceId=de5d88e34d004211

返回樣本

{
    "Instances" : {
        "Instance" : [{
                "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,
                "RegionId" : "cn-qingdao",
                "UserName" : "de5d88e34d004211"
                “NetworkType”:”CLASSSIC”
“ChargeType”:” PostPaid”
            }
        ]
    },
    "PageNumber" : 1,
    "PageSize" : 10,
    "TotalCount" : 1,
    "RequestId" : "969D0A1D-C91A-4837-9F70-49785DF9BDCE"
}