擷取執行個體列表。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求文法
GET /v2/openapi/listinstances HTTP/1.1請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| Status |
string |
否 |
執行個體狀態。 枚舉值：
|
normal |
| MaxResults |
integer |
否 |
返回執行個體的最大個數，取值範圍為 0~200。不設定此參數或者設定為 0 時，則預設值為 100。 |
100 |
| NextToken |
string |
否 |
查詢憑證（Token），取值為上一次 API 呼叫返回的 NextToken 參數值。從 NextToken 開始按字典序返回執行個體列表。第一次調用此介面時，設定為空白。 |
CAESCG15aC1xxxxx |
| InstanceName |
string |
否 |
執行個體名稱，支援模糊搜尋。 |
instance |
| ResourceGroupId |
string |
否 |
資源群組 ID，可通過資源群組控制台查詢。 |
rg-aek24upgom6p5ri |
| InstanceNameList |
array |
否 |
執行個體名稱列表，用於批量查詢多個指定執行個體。 |
|
|
string |
否 |
執行個體名稱，精準匹配查詢。 |
instance-test |
|
| Tag |
array<object> |
否 |
標籤列表。 |
|
|
object |
否 |
標籤。 |
||
| Key |
string |
否 |
標籤鍵。 |
Owner |
| Value |
string |
否 |
標籤值。 |
Tester |
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回結構體。 |
||
| RequestId |
string |
請求 ID，可用於排查和定位問題。 |
E734979F-5A44-5993-9CE5-C23103576923 |
| TotalCount |
integer |
返回執行個體的總條數。 |
2 |
| NextToken |
string |
當預期返回的執行個體總數大於設定的 MaxResults 時，將作為查詢後續頁的憑證。只有當執行個體未全部返回時，此參數才有值。 |
CAESCG15aC1xxxxx |
| Instances |
array<object> |
執行個體資訊列表。 |
|
|
object |
執行個體對象。 |
||
| InstanceName |
string |
執行個體名稱，用於唯一標識一個執行個體。 |
instance-test |
| ResourceGroupId |
string |
資源群組 ID。 |
rg-acfmxh4em5jnbcd |
| RegionId |
string |
地區 ID。 |
cn-huhehaote |
| SPInstanceId |
string |
執行個體 ID。 |
ots_standard_public_cn-g4t3igqjj002 |
| AliasName |
string |
執行個體別名。 |
instance-test |
| UserId |
string |
使用者識別碼。 |
13542356466 |
| InstanceDescription |
string |
執行個體描述。 |
測試執行個體的描述資訊。 |
| InstanceSpecification |
string |
執行個體規格。
|
HYBRID |
| PaymentType |
string |
付費方式。
|
Subscription |
| StorageType |
string |
儲存類型。
|
HYBRID |
| VCUQuota |
integer |
VCU 配額。 |
3 |
| InstanceStatus |
string |
執行個體狀態。
|
normal |
| CreateTime |
string |
執行個體的建立時間。 |
2019-04-07T09:19:21Z |
| IsMultiAZ |
boolean |
是否同城冗餘。
|
true |
樣本
正常返回樣本
JSON格式
{
"RequestId": "E734979F-5A44-5993-9CE5-C23103576923",
"TotalCount": 2,
"NextToken": "CAESCG15aC1xxxxx",
"Instances": [
{
"InstanceName": "instance-test",
"ResourceGroupId": "rg-acfmxh4em5jnbcd",
"RegionId": "cn-huhehaote",
"SPInstanceId": "ots_standard_public_cn-g4t3igqjj002",
"AliasName": "instance-test",
"UserId": "13542356466",
"InstanceDescription": "測試執行個體的描述資訊。",
"InstanceSpecification": "HYBRID",
"PaymentType": "Subscription",
"StorageType": "HYBRID",
"VCUQuota": 3,
"InstanceStatus": "normal",
"CreateTime": "2019-04-07T09:19:21Z",
"IsMultiAZ": true
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊，參考變更詳情。