调用API DescribeEais查询一个或多个已创建的弹性加速计算实例EAIS的详细信息,例如EAIS的实例ID、实例状态、实例规格、EAIS实例绑定的客户端实例(ECS实例或ECI实例)等信息。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
eais:DescribeEais | list |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
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 错误码发生变更 | 查看变更详情 |