DescribeContainerGroups_容器组_API 参考_弹性容器实例ECI-阿里云

接口说明

注意：

1、当 ECI 实例状态到达运行成功（Succeeded）时，ECI 底层计算资源会被回收，最近运行成功的100个 ECI 实例（所有地域总和）信息将会被保留，其余的会被清理；

2、当 ECI 实例状态到达运行失败（Failed）时，ECI 底层计算资源会被回收，ECI 实例信息将被保留24小时，24小时之后将被清理；

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数


名称	类型	是否必选	示例值	描述
Action	String	否	DescribeContainerGroups	系统规定参数。取值：DescribeContainerGroups
RegionId	String	是	cn-hangzhou	实例所属的地域 ID
ZoneId	String	否	cn-hangzhou-h	实例所属的可用区编号，空表示由系统选择，默认值：空
VSwitchId	String	否	vsw-bp1jrgfqqy54kg5hcf8bc	指定虚拟交换机 ID。当前 ECI 实例均为 VPC 实例。
NextToken	String	否	d78f2dd8-5979-42fe-939e-b16db43be5bc	用来返回更多结果。第一次查询不需要提供这个参数，后续查询的 token 从返回结果中获取。
Limit	Integer	否	20	限定此次返回资源的数量。如果不设定，默认返回20，最大不能超过20。返回结果可能小于指定的数量，但不会多于指定的数量。
Tag.N.Key	String	否	name	标签键。
Tag.N.Value	String	否	test-xh	标签值。
ContainerGroupIds	String	否	["eci-bp14j2xod16swv8efxoz",]	容器组 ID 序列，最多20，字符串需按照 JSON 格式传入。
ContainerGroupName	String	否	test-xh	容器组名称。
Status	String	否	Running	状态列表，参考 ContainerGroup 结构体定义。
ResourceGroupId	String	否	rg-xxx	ECI所属的资源组 ID。创建时没有指定资源组的默认加入账号下默认资源组下。

返回数据


名称	类型	示例值	描述
RequestId	String	1EB63BFD-273A-49D1-83DE-690465E29A15	请求ID，唯一标识。
NextToken	String	d78f2dd8-5979-42fe-939e-b16db43be5bc	后续查询 token
TotalCount	Integer	19	容器组总数
ContainerGroups	Array		容器组列表。
ContainerGroupId	String	eci-xxx	容器组ID。
ContainerGroupName	String	test	容器组名称。
RegionId	String	cn-hangzhou	实例所属的地域 ID。
ZoneId	String	cn-hangzhou-h	实例所属的可用区编号。
Memory	Float	4.0	容器组级别内存大小。
Cpu	Float	2.0	容器组级别CPU大小。
VSwitchId	String	vsw-bp1vzjjflab6wvjoxpogs	指定的虚拟交换机 ID。当前 ECI 实例均为 VPC 实例。
SecurityGroupId	String	sg-bp12ujq5zpxuyjfo3o8r	安全组ID。
RestartPolicy	String	Never	容器组的重启策略。
IntranetIp	String	10.21.1.1	内网 IP。
Status	String	Running	返回容器组创建状态，枚举值：Pending，Running，Succeeded，Failed，Scheduling, ScheduleFailed。
InternetIp	String	21.3.43.4	公网 IP。
CreationTime	String	2018-08-02T15:00:00Z	接到请求后的系统创建时间。UTC时间，RFC3339标准。
SucceededTime	String	2019-12-11T04:33:42Z	容器全部成功退出后的时间。UTC时间，RFC3339标准，例如：2018-08-02T15:00:00Z。
EniInstanceId	String	eni-xxx	ENI 实例 ID。
InstanceType	String	ecs.g5.large	实例规格。
ExpiredTime	String	2018-08-02T15:00:00Z	容器由于帐户欠费导致eci运行失败的时间。UTC时间，RFC3339标准。
FailedTime	String	2018-08-02T15:00:00Z	容器执行失败的时间。UTC时间，RFC3339标准。
RamRoleName	String	ram:PassRole	实例RAM角色名称，ECI与ECS共用实例RAM角色，使用方式请参阅通过API使用实例RAM角色。
Ipv6Address	String	CDCD:0000:0000:0000:8475:1111:3900:2020=CDCD::8475:1111:3900:2020	IPv6地址。
Tags	Array		实例的标签键值对，上限20。
Key	String	name	标签键。
Value	String	test-xh	标签值。
Events	Array		事件信息，上限 50。
Count	Integer	20	事件计数。
Type	String	Normal	事件类型，枚举值： Normal，Warning。
Name	String	test-xxx	事件的归属对象名。
Message	String	Started container	事件消息。
FirstTimestamp	String	2018-08-02T15:00:00Z	事件起始时间。
LastTimestamp	String	2018-08-02T15:00:00Z	事件结束时间。
Reason	String	Created	事件名。
Containers	Array		容器列表。
Name	String	nginx	容器名称。
Image	String	mysql	容器镜像。
Memory	Float	2.0	容器内存大小。
Cpu	Float	2.0	CPU大小。
RestartCount	Integer	0	重启次数。
WorkingDir	String	/usr/local/nginx	工作目录。
ImagePullPolicy	String	Always	镜像拉取策略。
Ready	Boolean	true	指定容器是否已通过其就绪探针。
Gpu	Integer	1	图形化处理器。
Stdin	Boolean	true	此容器是否应在容器运行时为标准输入分配缓冲区。如果未设置，则容器中标准输入的读取值将导致EOF。默认为false。
StdinOnce	Boolean	true	当标准输入为True时，标准输入流将在多个附加会话中保持开启状态。如果StdinOnce设为True，标准输入在容器开启时被打开，在首个客户端附加到标准输入之前都为空，然后会一直保持开启状态，接收数据，直到客户端连接断开，此时标准输入被关闭，在容器重启前一直保持关闭状态。
Tty	Boolean	false	是否开启交互，默认为false，例如Command为【“/bin/bash”】时，需要设置为true。
VolumeMounts	Array		挂载数据卷。
Name	String	test-empty	数据卷名称，同 Volume 中的 Name。
MountPath	String	/usr/share/	挂载目录，容器的挂载目录下的内容被Volume的内容直接覆盖。
ReadOnly	Boolean	false	默认值为False。
Ports	Array		暴露端口+协议，上限100。
Port	Integer	8080	端口号 1-65535。
Protocol	String	TCP	TCP/UDP。
EnvironmentVars	Array		环境变量。
Key	String	PATH	变量名。
Value	String	/usr/bin/	变量值。
ValueFrom	Struct		环境变量值的来源。如果值不为空，则无法使用。
FieldRef	Struct		选择容器的字段。
FieldPath	String	status.podIP	指定的版本中选择字段的路径。目前只支持 `status.podIP`。
Commands	List	[/bin/sh echo]	容器启动命令，上限20，单个String，256个字符。
Args	List	["hello"]	容器启动参数，上限10。
PreviousState	Struct		上一次状态。
State	String	Terminated	容器状态，枚举值：Waiting，Running，Terminated。
DetailStatus	String	working	状态详情。
ExitCode	Integer	0	容器运行退出码。
StartTime	String	2018-08-02T15:00:00Z	容器运行开始时间。
FinishTime	String	2018-08-02T15:00:00Z	容器运行结束时间。
Reason	String	Completed	容器状态 Reason。
Message	String	Back-off 5m0s restarting failed container=test pod=test_eci-xxx(xxx)	容器状态信息。
Signal	Integer	1	容器状态信号。
CurrentState	Struct		当前状态。
State	String	Terminated	容器状态，枚举值：Waiting，Running，Terminated。
DetailStatus	String	working	状态详情。
ExitCode	Integer	0	容器运行退出码。
StartTime	String	2019-12-19T12:05:02Z	容器运行开始时间。
FinishTime	String	2018-08-02T15:00:00Z	容器运行结束时间。
Reason	String	Started	容器状态 Reason。
Message	String	Back-off 5m0s restarting failed container=test pod=test_eci-xxx(xxx)	容器状态信息。
Signal	Integer	1	容器状态信号。
ReadinessProbe	Struct		就绪探针。
InitialDelaySeconds	Integer	5	检查开始执行的时间，以容器启动完成为起点计算。
PeriodSeconds	Integer	1	检查执行的周期，默认为10秒，最小为1秒。
TimeoutSeconds	Integer	5	检查超时的时间，默认为1秒，最小为1秒。
SuccessThreshold	Integer	1	从上次检查失败后重新认定检查成功的检查次数阈值（必须是连续成功），默认为1。当前必须为1。
FailureThreshold	Integer	3	从上次检查成功后认定检查失败的检查次数阈值（必须是连续失败），默认为3。
Execs	List	["/bin/sh", "-c", "echo Hello world > /usr/share/message"]	容器内检测的命令。
HttpGet	Struct		HttpGet。
Path	String	/usr/local	HttpGet检测的路径。
Port	Integer	8080	HttpGet检测的端口号。
Scheme	String	HTTP	HTTP／HTTPS。
TcpSocket	Struct		TcpSocket。
Host	String	1.2.3.4	Host。
Port	Integer	8888	端口号。
LivenessProbe	Struct		存活探针。
InitialDelaySeconds	Integer	10	检查开始执行的时间，以容器启动完成为起点计算。
PeriodSeconds	Integer	5	检查执行的周期，默认为10秒，最小为1秒。
TimeoutSeconds	Integer	10	检查超时的时间，默认为1秒，最小为1秒。
SuccessThreshold	Integer	1	从上次检查失败后重新认定检查成功的检查次数阈值（必须是连续成功），默认为1。当前必须为1。
FailureThreshold	Integer	3	从上次检查成功后认定检查失败的检查次数阈值（必须是连续失败），默认为3。
Execs	List	["/bin/sh", "-c", "echo Hello world > /usr/share/message"]	执行指令。
HttpGet	Struct		HttpGet。
Path	String	/usr/nginx/	HttpGet检测的路径。
Port	Integer	80	HttpGet检测的端口。
Scheme	String	HTTP	HTTP／HTTPS。
TcpSocket	Struct		TcpSocket。
Host	String	1.2.3.4	主机名。
Port	Integer	80	端口号。
SecurityContext	Struct		实例运行的安全上下文。
ReadOnlyRootFilesystem	Boolean	true	是否只读根文件系统，目前仅支持True。
RunAsUser	Long	1000	用于运行容器进程入口点的UID。
Capability	Struct		容器的默认功能集。目前仅支持Cpu／Memory。
Adds	List	[NET_ADMIN]	枚举值，目前仅支持：NET_ADMIN。
Volumes	Array		数据卷信息，上限20。
Type	String	EmptyDirVolume	数据卷类型，目前有 EmptyDirVolume、NFSVolume、ConfigFileVolume、FlexVolume四种。
Name	String	test-empty	名称。
NFSVolumePath	String	/eci	NFS 数据卷路径。
NFSVolumeServer	String	0eafxxxxx-xxxxx.cn-hangzhou.nas.aliyuncs.com	NFS 服务器地址。
NFSVolumeReadOnly	Boolean	false	默认值为 False。
DiskVolumeDiskId	String	d-xxxx	DiskVolume的ID。
DiskVolumeFsType	String	xfs	DiskVolume系统类型。
FlexVolumeDriver	String	flexvolume	用于FlexVolume的驱动程序名称。
FlexVolumeFsType	String	ntfs	挂载的文件系统类型，默认取决于FlexVolume的script。
FlexVolumeOptions	String	[nolock,tcp,noresvport]	FlexVolume对象选项列表。
ConfigFileVolumeConfigFileToPaths	Array		配置文件路径列表。
Content	String	hello world	配置文件内容 (32KB)。
Path	String	/usr/bin/	相对文件路径。
InitContainers	Array		Init容器列表。
Name	String	Init-xxx	Init容器名称。
Image	String	nginx	镜像。
Cpu	Float	1.0	CPU大小。
Memory	Float	2.0	内存大小。
RestartCount	Integer	5	重启次数。
WorkingDir	String	/usr/test	工作目录。
ImagePullPolicy	String	Always	镜像拉取策略。
Ready	Boolean	true	指定容器是否已通过其就绪探针。
Gpu	Integer	1	图形化处理器。
VolumeMounts	Array		数据卷挂载。
Name	String	test-empty	数据卷名称，同 Volume 中的 Name。
MountPath	String	/usr/share/	挂载目录，容器的挂载目录下的内容被Volume的内容直接覆盖。
ReadOnly	Boolean	false	默认值为False。
Ports	Array		暴露端口+协议，上限100。
Port	Integer	8888	端口号 1-65535。
Protocol	String	TCP	TCP／UDP。
EnvironmentVars	Array		环境变量。
Key	String	PATH	变量名。
Value	String	/usr/local/bin	变量值。
ValueFrom	Struct		环境变量值的来源。如果值不为空，则无法使用。
FieldRef	Struct		选择容器的字段。
FieldPath	String	status.podIP	指定的版本中选择字段的路径。目前只支持 `status.podIP`。
Command	List	[/bin/sh echo]	启动命令。
Args	List	['hello world']	启动参数。
PreviousState	Struct		上一次状态。
State	String	Terminated	容器状态，枚举值：Waiting，Running，Terminated。
DetailStatus	String	working	状态详情。
ExitCode	Integer	0	容器运行退出码。
StartTime	String	2019-12-24T05:35:44Z	容器运行开始时间。
FinishTime	String	2019-12-24T05:35:44Z	容器运行结束时间。
Reason	String	completed	容器状态 Reason。
Message	String	Started container	容器状态信息。
Signal	Integer	1	容器状态信号。
CurrentState	Struct		当前状态。
State	String	Running	容器状态，枚举值：Waiting，Running，Terminated。
DetailStatus	String	working	状态详情。
ExitCode	Integer	0	容器退出码。
StartTime	String	2018-08-02T15:00:00Z	容器运行开始时间。
FinishTime	String	2018-08-02T15:00:00Z	容器运行结束时间。
Reason	String	Started	容器状态 Reason。
Message	String	Created container	事件消息。
Signal	Integer	1	容器状态信号。
SecurityContext	Struct		容器运行的安全上下文。
ReadOnlyRootFilesystem	Boolean	true	是否只读根文件系统，目前仅支持True。
RunAsUser	Long	1557	用于运行容器进程入口点的UID。
Capability	Struct		容器的默认功能集。目前仅支持Cpu／Memory。
Adds	List	NET_ADMIN	枚举值，目前仅支持：NET_ADMIN。
HostAliases	Array		自定义Pod内一个容器的Hostname映射。
Ip	String	42.101.1.10	IP地址。
Hostnames	List	['hehe.com', 'haha.com']	主机名。
DnsConfig	Struct		DNS配置信息。
Options	Array		对象选项列表，每个对象由Name和Value（可选）构成。
Name	String	name	对象变量名。
Value	String	value	对象变量值。
NameServers	List	[1.2.3.4]	DNS 服务器 IP 地址列表。
Searches	List	[svc.local.kubenetes]	DNS 搜索域列表。
EciSecurityContext	Struct		容器组运行的安全上下文。
Sysctls	Array		系统信息。
Name	String	kernel.msgmax	变量名。
Value	String	65536	变量值。

示例

请求示例

http(s)://eci.aliyuncs.com/?Action=DescribeContainerGroups
&RegionId=cn-hangzhou
&<公共请求参数>

正常返回示例

JSON 格式

{
	"NextToken": "",
	"TotalCount": 1,
	"ContainerGroups": [
		{
			"EciSecurityContext": {},
			"Containers": [
				{
					"VolumeMounts": [],
					"Gpu": 0,
					"PreviousState": {
						"State": "",
						"FinishTime": "",
						"StartTime": ""
					},
					"RestartCount": 0,
					"SecurityContext": {
						"Capability": {}
					},
					"WorkingDir": "",
					"CurrentState": {
						"State": "Running",
						"FinishTime": "",
						"StartTime": "2019-12-24T05:35:44Z"
					},
					"Ready": true,
					"Name": "test-imagepull",
					"ImagePullPolicy": "IfNotPresent",
					"Memory": 4,
					"Cpu": 2,
					"ReadinessProbe": {
						"TcpSocket": {},
						"HttpGet": {}
					},
					"Image": "registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:1.14.2",
					"EnvironmentVars": [
						{
							"Value": "/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin",
							"Key": "PATH",
							"ValueFrom": {
								"FieldRef": {}
							}
						},
						{
							"Value": "1.14.2-1~stretch",
							"Key": "NGINX_VERSION",
							"ValueFrom": {
								"FieldRef": {}
							}
						},
						{
							"Value": "1.14.2.0.2.6-1~stretch",
							"Key": "NJS_VERSION",
							"ValueFrom": {
								"FieldRef": {}
							}
						}
					],
					"LivenessProbe": {
						"TcpSocket": {},
						"HttpGet": {}
					},
					"Ports": []
				}
			],
			"SecurityGroupId": "sg-bp19ryeo103eqznmcat0",
			"RestartPolicy": "Always",
			"FailedTime": "",
			"DnsConfig": {},
			"Events": [
				{
					"Name": "test-imagepull.15e337e2347880ac",
					"LastTimestamp": "2019-12-24T05:35:39Z",
					"Count": 1,
					"Message": "pulling image \"registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:1.14.2\"",
					"Type": "Normal",
					"FirstTimestamp": "2019-12-24T05:35:39Z",
					"Reason": "Pulling"
				},
				{
					"Name": "test-imagepull.15e337e37173d182",
					"LastTimestamp": "2019-12-24T05:35:44Z",
					"Count": 1,
					"Message": "Successfully pulled image \"registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:1.14.2\"",
					"Type": "Normal",
					"FirstTimestamp": "2019-12-24T05:35:44Z",
					"Reason": "Pulled"
				},
				{
					"Name": "test-imagepull.15e337e37306423e",
					"LastTimestamp": "2019-12-24T05:35:44Z",
					"Count": 1,
					"Message": "Created container",
					"Type": "Normal",
					"FirstTimestamp": "2019-12-24T05:35:44Z",
					"Reason": "Created"
				},
				{
					"Name": "test-imagepull.15e337e377a39ab6",
					"LastTimestamp": "2019-12-24T05:35:44Z",
					"Count": 1,
					"Message": "Started container",
					"Type": "Normal",
					"FirstTimestamp": "2019-12-24T05:35:44Z",
					"Reason": "Started"
				}
			],
			"InternetIp": "",
			"ZoneId": "cn-hangzhou-i",
			"ContainerGroupName": "test-imagepull",
			"EniInstanceId": "eni-bp1gj8moqnu15zrvt0in",
			"VSwitchId": "vsw-bp1vzjjflab6wvjoxpogs",
			"CreationTime": "2019-12-24T05:35:27Z",
			"Tags": [],
			"ContainerGroupId": "eci-bp12wdqc3g6qtr44vrpt",
			"Status": "Running",
			"SucceededTime": "",
			"Memory": 4,
			"Cpu": 2,
			"InitContainers": [],
			"RegionId": "cn-hangzhou",
			"IntranetIp": "192.168.168.91",
			"ExpiredTime": "",
			"Volumes": []
		}
	],
	"RequestId": "8715677F-0F66-4013-A1FE-FA8136A3A4D1"
}

XML 格式

<NextToken/>
<TotalCount>1</TotalCount>
<ContainerGroups>
    <EciSecurityContext/>
    <Containers>
        <Gpu>0</Gpu>
        <PreviousState>
            <State/>
            <FinishTime/>
            <StartTime/>
        </PreviousState>
        <RestartCount>0</RestartCount>
        <SecurityContext>
            <Capability/>
        </SecurityContext>
        <WorkingDir/>
        <CurrentState>
            <State>Running</State>
            <FinishTime/>
            <StartTime>2019-12-24T05:35:44Z</StartTime>
        </CurrentState>
        <Ready>true</Ready>
        <Name>test-imagepull</Name>
        <ImagePullPolicy>IfNotPresent</ImagePullPolicy>
        <Memory>4</Memory>
        <Cpu>2</Cpu>
        <ReadinessProbe>
            <TcpSocket/>
            <HttpGet/>
        </ReadinessProbe>
        <Image>registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:1.14.2</Image>
        <EnvironmentVars>
            <Value>/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin</Value>
            <Key>PATH</Key>
            <ValueFrom>
                <FieldRef/>
            </ValueFrom>
        </EnvironmentVars>
        <EnvironmentVars>
            <Value>1.14.2-1~stretch</Value>
            <Key>NGINX_VERSION</Key>
            <ValueFrom>
                <FieldRef/>
            </ValueFrom>
        </EnvironmentVars>
        <EnvironmentVars>
            <Value>1.14.2.0.2.6-1~stretch</Value>
            <Key>NJS_VERSION</Key>
            <ValueFrom>
                <FieldRef/>
            </ValueFrom>
        </EnvironmentVars>
        <LivenessProbe>
            <TcpSocket/>
            <HttpGet/>
        </LivenessProbe>
    </Containers>
    <SecurityGroupId>sg-bp19ryeo103eqznmcat0</SecurityGroupId>
    <RestartPolicy>Always</RestartPolicy>
    <FailedTime/>
    <DnsConfig/>
    <Events>
        <Name>test-imagepull.15e337e2347880ac</Name>
        <LastTimestamp>2019-12-24T05:35:39Z</LastTimestamp>
        <Count>1</Count>
        <Message>pulling image "registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:1.14.2"</Message>
        <Type>Normal</Type>
        <FirstTimestamp>2019-12-24T05:35:39Z</FirstTimestamp>
        <Reason>Pulling</Reason>
    </Events>
    <Events>
        <Name>test-imagepull.15e337e37173d182</Name>
        <LastTimestamp>2019-12-24T05:35:44Z</LastTimestamp>
        <Count>1</Count>
        <Message>Successfully pulled image "registry-vpc.cn-hangzhou.aliyuncs.com/eci_open/nginx:1.14.2"</Message>
        <Type>Normal</Type>
        <FirstTimestamp>2019-12-24T05:35:44Z</FirstTimestamp>
        <Reason>Pulled</Reason>
    </Events>
    <Events>
        <Name>test-imagepull.15e337e37306423e</Name>
        <LastTimestamp>2019-12-24T05:35:44Z</LastTimestamp>
        <Count>1</Count>
        <Message>Created container</Message>
        <Type>Normal</Type>
        <FirstTimestamp>2019-12-24T05:35:44Z</FirstTimestamp>
        <Reason>Created</Reason>
    </Events>
    <Events>
        <Name>test-imagepull.15e337e377a39ab6</Name>
        <LastTimestamp>2019-12-24T05:35:44Z</LastTimestamp>
        <Count>1</Count>
        <Message>Started container</Message>
        <Type>Normal</Type>
        <FirstTimestamp>2019-12-24T05:35:44Z</FirstTimestamp>
        <Reason>Started</Reason>
    </Events>
    <InternetIp/>
    <ZoneId>cn-hangzhou-i</ZoneId>
    <ContainerGroupName>test-imagepull</ContainerGroupName>
    <EniInstanceId>eni-bp1gj8moqnu15zrvt0in</EniInstanceId>
    <VSwitchId>vsw-bp1vzjjflab6wvjoxpogs</VSwitchId>
    <CreationTime>2019-12-24T05:35:27Z</CreationTime>
    <ContainerGroupId>eci-bp12wdqc3g6qtr44vrpt</ContainerGroupId>
    <Status>Running</Status>
    <SucceededTime/>
    <Memory>4</Memory>
    <Cpu>2</Cpu>
    <RegionId>cn-hangzhou</RegionId>
    <IntranetIp>192.168.168.91</IntranetIp>
    <ExpiredTime/>
</ContainerGroups>
<RequestId>8715677F-0F66-4013-A1FE-FA8136A3A4D1</RequestId>

错误码

访问错误中心查看更多错误码。