獲取實例列表。
調試
您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求語法
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 |
返回參數
示例
正常返回示例
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
}
]
}錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
| 變更時間 | 變更內容概要 | 操作 |
|---|---|---|
| 2024-07-24 | OpenAPI 入參發生變更 | 查看變更詳情 |