调用DescribeContainerGroupStatus批量查询ECI实例的状态。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeContainerGroupStatus

系统规定参数。取值:DescribeContainerGroupStatus

RegionId String cn-hangzhou

地域ID。

ZoneId String cn-hangzhou-k

可用区ID。

VSwitchId String vsw-uf6h3rbwbm90urjwa****

交换机ID。

ResourceGroupId String rg-uf66jeqopgqa9hdn****

资源组ID。

ContainerGroupIds String ["eci-bp17gw49eu09yiwm****", "eci-bp19aq49du01abcm****", "eci-2zegym1qhbmdfr1s****"]

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

SinceSecond Integer 60

返回最近几秒内有状态更新的ECI实例状态,用于轮询查询状态。

NextToken String d78f2dd8-5979-42fe-xaee-b16db43be5bc

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

首次查询时无需设置该参数,后续查询的Token从返回结果中获取。

Limit Integer 200

限定此次返回资源(ECI实例)的数量。默认为200个。

说明 返回结果可能小于指定的数量,但不会多于指定的数量。
Tag.N.Value String testValue

ECI实例的标签值。

Tag.N.Key String testKey

ECI实例的标签键。

返回数据

名称 类型 示例值 描述
RequestId String 1340C38D-6189-54D1-86F6-7D5ECF3E0088

请求ID。

NextToken String d78f2dd8-5979-42fe-****-b16db43be5bc

下一个查询开始的Token。

TotalCount Integer 1

结果条数。

Data Array of data

ECI实例状态信息集合。

ContainerGroupId String eci-bp1jrgfqqy54kg5hc****

ECI实例ID。

Name String nginx

ECI实例名称。

Namespace String default

ECI实例所在命名空间。

Status String Running

ECI实例状态。

uuid String 78ee0657-987g-b8b2-1f507dic4****

ECI实例UUID,对应K8s的POD UID。

PodStatus Object

Pod状态信息。

Conditions Array of conditions

Pod conditions信息。

type String Ready

condition类型。可能值:

  • PodScheduled
  • Ready
  • Initialized
  • Unschedulable
status String True

condition状态。

Reason String Completed

事件原因。

Message String Completed

事件消息。

lastTransitionTime String 2021-05-12T07:02:47Z

最后一次状态变化时间。

ContainerStatuses Array of containerStatuses

容器状态信息。

Image String registry-vpc.cn-zhangjiakou.aliyuncs.com/eci_open/ubuntu:18.04

容器镜像。

ImageID String registry-vpc.cn-zhangjiakou.aliyuncs.com/eci_open/ubuntu@sha256:134c7fe821b9d359490cd009ce7ca322453f4f2d018623f849e580a89a685e5d

镜像ID。

Name String ubuntu

容器名称。

Ready Boolean true

容器是否Ready。

RestartCount Integer 1

重启次数。

Started Boolean true

容器是否启动。

State Object

容器状态。包括:

  • Waiting
  • Running
  • Terminated
Waiting Object

容器正在等待创建,还未开始运行。

Reason String Started

事件原因。

Message String Back-off

事件消息。

Running Object

容器已经成功创建,并且正在运行。

StartedAtstartedAt String 2021-05-23T20:49:31Z

开始时间。

Terminated Object

容器运行终止并退出,包括运行成功终止和运行失败终止。

ContainerID String containerd://3ff993933bea366c4719e43a1b067d89bc7f01f1f573981659a44ff17a******

容器ID。

ExitCode Integer 0

退出码。

FinishedAt String 2021-05-23T20:55:31Z

结束时间。

StartedAt String 2021-05-23T20:49:31Z

开始时间。

Signal Integer 1

信号码。

Reason String Completed

事件原因。

Message String Completed

事件消息。

LastState Object

容器最新状态。

Waiting Object

容器正在等待创建,还未开始运行。

Reason String Started

事件原因。

Message String Back-off

事件消息。

Running Object

容器已经成功创建,并且正在运行。

StartedAtstartedAt String 2021-05-23T20:49:31Z

开始时间。

Terminated Object

容器运行终止并退出,包括运行成功终止和运行失败终止。

ContainerID String containerd://3ff993933bea366c4719e43a1b067d89bc7f01f1f573981659a44ff17a******

容器ID。

ExitCode Integer 0

退出码。

FinishedAt String 2021-05-23T20:49:31Z

结束时间。

StartedAt String 021-05-12T07:02:52Z

开始时间。

Signal Integer 1

信号码。

Reason String Completed

事件原因。

Message String Completed

事件消息。

HostIp String 192.168.XX.XX

主机IP。

Phase String Running

Pod生命周期阶段。

PodIp String 192.168.XX.XX

Pod IP地址。

PodIps Array of podIps

Pod IP地址集合。

Ip String 192.168.XX.XX

Pod IP地址。

QosClass String Guaranteed

Pod Qos。

StartTime String 2021-05-12T07:02:47Z

容器开始运行时间。

示例

请求示例

https://eci.aliyuncs.com/?Action=DescribeContainerGroupStatus
&RegionId=cn-hangzhou
&ZoneId=cn-hangzhou-k
&VSwitchId=vsw-uf6h3rbwbm90urjwa****
&ResourceGroupId=rg-uf66jeqopgqa9hdn****
&ContainerGroupIds=["eci-bp17gw49eu09yiwm****", "eci-bp19aq49du01abcm****", "eci-2zegym1qhbmdfr1s****"]
&SinceSecond=60
&Tag=[{"Value":"testValue","Key":"testKey"}]
&NextToken=d78f2dd8-5979-42fe-xaee-b16db43be5bc
&Limit=200
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeContainerGroupStatusResponse>
    <RequestId>1340C38D-6189-54D1-86F6-7D5ECF3E0088</RequestId>
    <NextToken>d78f2dd8-5979-42fe-****-b16db43be5bc</NextToken>
    <TotalCount>1</TotalCount>
    <Data>
        <ContainerGroupId>eci-bp1jrgfqqy54kg5hc****</ContainerGroupId>
        <Name>nginx</Name>
        <Namespace>default</Namespace>
        <Status>Running</Status>
        <uuid>78ee0657-987g-b8b2-1f507dic4****</uuid>
        <PodStatus>
            <Conditions>
                <type>Ready</type>
                <status>True</status>
                <Reason>Completed</Reason>
                <Message>Completed</Message>
                <lastTransitionTime>2021-05-12T07:02:47Z</lastTransitionTime>
            </Conditions>
            <ContainerStatuses>
                <Image>registry-vpc.cn-zhangjiakou.aliyuncs.com/eci_open/ubuntu:18.04</Image>
                <ImageID>registry-vpc.cn-zhangjiakou.aliyuncs.com/eci_open/ubuntu@sha256:134c7fe821b9d359490cd009ce7ca322453f4f2d018623f849e580a89a685e5d</ImageID>
                <Name>ubuntu</Name>
                <Ready>true</Ready>
                <RestartCount>1</RestartCount>
                <Started>true</Started>
                <State>
                    <Waiting>
                        <Reason>Started</Reason>
                        <Message>Back-off</Message>
                    </Waiting>
                    <Running>
                        <StartedAtstartedAt>2021-05-23T20:49:31Z</StartedAtstartedAt>
                    </Running>
                    <Terminated>
                        <ContainerID>containerd://3ff993933bea366c4719e43a1b067d89bc7f01f1f573981659a44ff17a******</ContainerID>
                        <ExitCode>0</ExitCode>
                        <FinishedAt>2021-05-23T20:55:31Z</FinishedAt>
                        <StartedAt>2021-05-23T20:49:31Z</StartedAt>
                        <Signal>1</Signal>
                        <Reason>Completed</Reason>
                        <Message>Completed</Message>
                    </Terminated>
                </State>
                <LastState>
                    <Waiting>
                        <Reason>Started</Reason>
                        <Message>Back-off</Message>
                    </Waiting>
                    <Running>
                        <StartedAtstartedAt>2021-05-23T20:49:31Z</StartedAtstartedAt>
                    </Running>
                    <Terminated>
                        <ContainerID>containerd://3ff993933bea366c4719e43a1b067d89bc7f01f1f573981659a44ff17a******</ContainerID>
                        <ExitCode>0</ExitCode>
                        <FinishedAt>2021-05-23T20:49:31Z</FinishedAt>
                        <StartedAt>021-05-12T07:02:52Z</StartedAt>
                        <Signal>1</Signal>
                        <Reason>Completed</Reason>
                        <Message>Completed</Message>
                    </Terminated>
                </LastState>
            </ContainerStatuses>
            <HostIp>192.168.XX.XX</HostIp>
            <Phase>Running</Phase>
            <PodIp>192.168.XX.XX</PodIp>
            <PodIps>
                <Ip>192.168.XX.XX</Ip>
            </PodIps>
            <QosClass>Guaranteed</QosClass>
            <StartTime>2021-05-12T07:02:47Z</StartTime>
        </PodStatus>
    </Data>
</DescribeContainerGroupStatusResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "1340C38D-6189-54D1-86F6-7D5ECF3E0088",
  "NextToken" : "d78f2dd8-5979-42fe-****-b16db43be5bc",
  "TotalCount" : 1,
  "Data" : [ {
    "ContainerGroupId" : "eci-bp1jrgfqqy54kg5hc****",
    "Name" : "nginx",
    "Namespace" : "default",
    "Status" : "Running",
    "uuid" : "78ee0657-987g-b8b2-1f507dic4****",
    "PodStatus" : {
      "Conditions" : [ {
        "type" : "Ready",
        "status" : "True",
        "Reason" : "Completed",
        "Message" : "Completed",
        "lastTransitionTime" : "2021-05-12T07:02:47Z"
      } ],
      "ContainerStatuses" : [ {
        "Image" : "registry-vpc.cn-zhangjiakou.aliyuncs.com/eci_open/ubuntu:18.04",
        "ImageID" : "registry-vpc.cn-zhangjiakou.aliyuncs.com/eci_open/ubuntu@sha256:134c7fe821b9d359490cd009ce7ca322453f4f2d018623f849e580a89a685e5d",
        "Name" : "ubuntu",
        "Ready" : true,
        "RestartCount" : 1,
        "Started" : true,
        "State" : {
          "Waiting" : {
            "Reason" : "Started",
            "Message" : "Back-off"
          },
          "Running" : {
            "StartedAtstartedAt" : "2021-05-23T20:49:31Z"
          },
          "Terminated" : {
            "ContainerID" : "containerd://3ff993933bea366c4719e43a1b067d89bc7f01f1f573981659a44ff17a******",
            "ExitCode" : 0,
            "FinishedAt" : "2021-05-23T20:55:31Z",
            "StartedAt" : "2021-05-23T20:49:31Z",
            "Signal" : 1,
            "Reason" : "Completed",
            "Message" : "Completed"
          }
        },
        "LastState" : {
          "Waiting" : {
            "Reason" : "Started",
            "Message" : "Back-off"
          },
          "Running" : {
            "StartedAtstartedAt" : "2021-05-23T20:49:31Z"
          },
          "Terminated" : {
            "ContainerID" : "containerd://3ff993933bea366c4719e43a1b067d89bc7f01f1f573981659a44ff17a******",
            "ExitCode" : 0,
            "FinishedAt" : "2021-05-23T20:49:31Z",
            "StartedAt" : "021-05-12T07:02:52Z",
            "Signal" : 1,
            "Reason" : "Completed",
            "Message" : "Completed"
          }
        }
      } ],
      "HostIp" : "192.168.XX.XX",
      "Phase" : "Running",
      "PodIp" : "192.168.XX.XX",
      "PodIps" : [ {
        "Ip" : "192.168.XX.XX"
      } ],
      "QosClass" : "Guaranteed",
      "StartTime" : "2021-05-12T07:02:47Z"
    }
  } ]
}

错误码

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