調用API DescribeEais查詢一個或多個已創建的彈性加速計算實例EAIS的詳細信息,例如EAIS的實例ID、實例狀態、實例規格、EAIS實例綁定的客戶端實例(ECS實例或ECI實例)等信息。
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
當前API暫無授權信息透出。
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
RegionId | string | 是 | 實例所屬的地域 ID。您可以調用 DescribeRegions 查看最新的阿里云地域列表。 | cn-shenzhen |
ElasticAcceleratedInstanceIds | string | 否 | EAIS 實例 ID。取值可以由多個實例 ID 組成一個 JSON 數組,ID 之間用半角逗號(,)隔開。最多支持 200 個 ID。 | ["eais-id1", "eais-id2"] |
InstanceName | string | 否 | EAIS 實例名稱,支持使用通配符*進行模糊搜索。 | eais* |
Status | string | 否 | EAIS 實例狀態。具體狀態與創建 EAIS 實例的方式有關,說明如下:
| InUse |
InstanceType | string | 否 | EAIS 實例規格。取值范圍:
| eais.ei-a6.2xlarge |
ClientInstanceId | string | 否 | 綁定的 ECS 或 ECI 實例 ID。 | i-wz96zm231cua8hbv**** |
ResourceGroupId | string | 否 | 實例所屬的資源組 ID。 | rg-acfmvpuy4a5**** |
Tag | array<object> | 否 | 標簽列表 | |
object | 否 | 標簽 | ||
Key | string | 否 | 實例的標簽鍵。N 的取值范圍為 1~20。 使用一個標簽過濾資源,查詢到該標簽下的資源數量不能超過 1000 個;使用多個標簽過濾資源,查詢到同時綁定了多個標簽的資源數量不能超過 1000 個。 | TestKey |
Value | string | 否 | 實例的標簽值。N 的取值范圍:1~20。 | TestValue |
PageNumber | integer | 否 | 查詢接口返回信息列表的頁碼。 起始值:1。 默認值:1。 | 1 |
PageSize | integer | 否 | 分頁展示響應信息時設置的每頁行數,單位:行。 最大值:200。 默認值:20。 | 20 |
返回參數
示例
正常返回示例
JSON
格式
{
"RequestId": "1E23D585-BBD8-436F-9615-54CACD67****",
"PageNumber": 1,
"PageSize": 10,
"TotalCount": 1,
"Instances": {
"Instance": [
{
"Status": "InUse",
"CreationTime": "1669945859000",
"ClientInstanceName": "test1",
"Description": "testDescription",
"ElasticAcceleratedInstanceId": "eais-sz8t15a7gt7****",
"InstanceName": "testName",
"ClientInstanceType": "ecs.g5ne.large",
"ClientInstanceId": "i-wz93g6pyat2g****",
"ZoneId": "cn-shenzhen-e",
"InstanceType": "eais.ei-a6.2xlarge",
"RegionId": "cn-shenzhen",
"Tags": {
"Tag": [
{
"TagKey": "TestKey",
"TagValue": "TestValue"
}
]
},
"Category": "jupyter",
"JupyterUrl": "http://121.41.**.24:8888",
"VSwitchId": "vsw-bp1sd131hfmd76r******",
"SecurityGroupId": "sg-bp1gppir818lx4******",
"StartTime": "1669945889000",
"ResourceGroupId": "rg-acfmvpuy4a5****"
}
]
}
}
錯誤碼
HTTP status code | 錯誤碼 | 錯誤信息 | 描述 |
---|---|---|---|
404 | InvalidParameter.InstanceId.NotFound | The specified InstanceId does not exist. | 實例ID不存在。 |
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2023-09-15 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-09-01 | OpenAPI 錯誤碼發生變更、OpenAPI 入參發生變更 | 查看變更詳情 |
2023-04-27 | OpenAPI 錯誤碼發生變更 | 查看變更詳情 |