DescribeContainerGroups_弹性容器实例_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

  • 当 ECI 实例运行终止后,底层计算资源将会被回收。随实例一起创建的其它资源(例如 EIP 等)默认随实例一起释放。
  • 终态(处于 Failed、Succeeded 或 Expired 状态)实例的元数据信息的保留情况如下:
    • 1 小时内的实例信息全部保留。
    • 超出 1 小时的实例仅保留最近的 100 条(单个地域分别计算)。
  • 如果使用 RAM 用户账号或者 RAM 角色进行查询,当 RAM 用户或者角色缺乏接口权限时,会返回空列表。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
eci:DescribeContainerGroups
Get
ContainerGroup
acs:eci:{#regionId}:{#accountId}:containergroup/*
ContainerGroup
acs:eci:{#regionId}:{#accountId}:containergroup/{#containergroupId}
eci:tag

请求参数

字段名称字段详情
RegionIdstring

实例所属的地域 ID。

示例值:cn-hangzhou参考取值来源:
    DescribeRegions
ZoneIdstring

实例所属的可用区。如果取值为空,则表示由系统选择。展开详情

示例值:cn-hangzhou-h
VSwitchIdstring

实例所属的虚拟交换机 ID。

示例值:vsw-bp1jrgfqqy54kg5hc****
NextTokenstring

下一个查询开始的 Token,NextToken 为空表示没有下一个。展开详情

示例值:d78f2dd8-5979-42fe-****-b16db43be5bc
Limitinteger<int32>

限定此次返回资源的数量。如果不设置,默认返回 20 个,最大不能超过 20 个。展开详情

示例值:20
ContainerGroupIdsstring

实例 ID 序列。最多 20 个,字符串需按照 JSON 格式传入。

示例值:["eci-bp17gw49eu09yiwm****", "eci-bp19aq49du01abcm****", "eci-2zegym1qhbmdfr1s****"]参考取值来源:
    CreateContainerGroup
    DescribeContainerGroupStatus
ContainerGroupNamestring

实例名称,即容器组名称。

示例值:test参考取值来源:
    CreateContainerGroup
Statusstring

实例状态。取值范围:展开详情

示例值:Running
ResourceGroupIdstring

实例所属的资源组 ID。

示例值:rg-aekzh43v*****
WithEventboolean

是否返回事件信息。

示例值:true
Tagarray<object>

实例标签信息。

子级条数 <= 10
ComputeCategorystring

指定算力类别。取值范围:展开详情

示例值:economy
SecurityGroupIdstring

实例所属的安全组 ID。

示例值:sg-uf66jeqopgqa9hdn****

返回参数

字段名称字段详情
TotalCountinteger<int32>

实例数量。

示例值:1
NextTokenstring

下一个查询开始的 Token。

示例值:d78f2dd8-5979-42fe-****-b16db43be5bc
RequestIdstring

请求 ID,唯一标识。

示例值:89945DD3-9072-47D0-A318-353284CFC7B3
ContainerGroupsarray<object>

实例信息列表。

返回示例

错误码

全局错误码
HTTP 状态码错误码错误信息操作
400
InvalidParameter.MismatchInstanceType
The instanceId mismatch instance type.诊断

变更历史

变更时间变更内容概要操作
2024-09-26
变更返回参数
2024-09-04
新增错误码400
2023-12-27
新增请求参数ComputeCategory
2023-12-25
新增请求参数SecurityGroupId
变更返回参数
  • 1
  • 2
  • 10 条/页

相关示例