全部产品
Search

搜索本产品

    弹性容器实例：DescribeContainerGroupStatus - 批量查询容器组状态

    文档中心

    弹性容器实例：DescribeContainerGroupStatus - 批量查询容器组状态

    更新时间：Mar 10, 2023

    批量查询ECI实例的状态。

    调试

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

    调试

    授权信息

    下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

    • 操作：是指具体的权限点。
    • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
    • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
      • 对于必选的资源类型，用背景高亮的方式表示。
      • 对于不支持资源级授权的操作，用全部资源表示。
    • 条件关键字：是指云产品自身定义的条件关键字。
    • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    eci:DescribeContainerGroupStatusRead
    • ECIOpenAPI
      acs:eci:{#regionId}:{#accountId}:containergroup/{#containergroupId}
    • eci:tag
    		无

    请求参数

    名称类型必填描述示例值
    RegionIdstring是

    地域ID。

    		cn-hangzhou
    ZoneIdstring否

    可用区ID。

    		cn-hangzhou-k
    VSwitchIdstring否

    交换机ID。

    		vsw-uf6h3rbwbm90urjwa****
    ResourceGroupIdstring否

    资源组ID。

    		rg-uf66jeqopgqa9hdn****
    ContainerGroupIdsstring否

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

    		["eci-bp17gw49eu09yiwm****", "eci-bp19aq49du01abcm****", "eci-2zegym1qhbmdfr1s****"]
    SinceSecondinteger否

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

    		60
    Tagarray否

    ECI实例绑定的标签。

    object否

    ECI实例绑定的标签。

    Valuestring否

    ECI实例的标签值。

    		testValue
    Keystring否

    ECI实例的标签键。

    		testKey
    NextTokenstring否

    下一个查询开始的Token，NextToken为空表示没有下一个。
    首次查询时无需设置该参数，后续查询的Token从返回结果中获取。

    		d78f2dd8-5979-42fe-xaee-b16db43be5bc
    Limitinteger否

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

    说明返回结果可能小于指定的数量，但不会多于指定的数量。
    		200

    返回参数

    名称类型描述示例值
    object

    Schema of Response

    RequestIdstring

    请求ID。

    		1340C38D-6189-54D1-86F6-7D5ECF3E0088
    NextTokenstring

    下一个查询开始的Token。

    		d78f2dd8-5979-42fe-****-b16db43be5bc
    TotalCountinteger

    结果条数。

    		1
    Dataarray

    ECI实例状态信息集合。

    object

    ECI实例状态信息集合。

    ContainerGroupIdstring

    ECI实例ID。

    		eci-bp1jrgfqqy54kg5hc****
    Namestring

    ECI实例名称。

    		nginx
    Namespacestring

    ECI实例所在命名空间。

    		default
    Statusstring

    ECI实例状态。

    		Running
    uuidstring

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

    		78ee0657-987g-b8b2-1f507dic4****
    PodStatusobject

    Pod状态信息。

    Conditionsarray

    Pod conditions信息。

    object

    Pod conditions信息。

    typestring

    condition类型。可能值：

    • PodScheduled
    • Ready
    • Initialized
    • Unschedulable
    		Ready
    statusstring

    condition状态。

    		True
    Reasonstring

    事件原因。

    		Completed
    Messagestring

    事件消息。

    		Completed
    lastTransitionTimestring

    最后一次状态变化时间。

    		2021-05-12T07:02:47Z
    ContainerStatusesarray

    容器状态信息。

    object

    容器状态信息。

    Imagestring

    容器镜像。

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

    镜像ID。

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

    容器名称。

    		ubuntu
    Readyboolean

    容器是否Ready。

    		true
    RestartCountinteger

    重启次数。

    		1
    Startedboolean

    容器是否启动。

    		true
    Stateobject

    容器状态。包括：

    • Waiting
    • Running
    • Terminated
    Waitingobject

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

    Reasonstring

    事件原因。

    		Started
    Messagestring

    事件消息。

    		Back-off
    Runningobject

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

    StartedAtstartedAtstring

    开始时间。

    		2021-05-23T20:49:31Z
    Terminatedobject

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

    ContainerIDstring

    容器ID。

    		containerd://3ff993933bea366c4719e43a1b067d89bc7f01f1f573981659a44ff17a******
    ExitCodeinteger

    退出码。

    		0
    FinishedAtstring

    结束时间。

    		2021-05-23T20:55:31Z
    StartedAtstring

    开始时间。

    		2021-05-23T20:49:31Z
    Signalinteger

    信号码。

    		1
    Reasonstring

    事件原因。

    		Completed
    Messagestring

    事件消息。

    		Completed
    LastStateobject

    容器最新状态。

    Waitingobject

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

    Reasonstring

    事件原因。

    		Started
    Messagestring

    事件消息。

    		Back-off
    Runningobject

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

    StartedAtstartedAtstring

    开始时间。

    		2021-05-23T20:49:31Z
    Terminatedobject

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

    ContainerIDstring

    容器ID。

    		containerd://3ff993933bea366c4719e43a1b067d89bc7f01f1f573981659a44ff17a******
    ExitCodeinteger

    退出码。

    		0
    FinishedAtstring

    结束时间。

    		2021-05-23T20:49:31Z
    StartedAtstring

    开始时间。

    		021-05-12T07:02:52Z
    Signalinteger

    信号码。

    		1
    Reasonstring

    事件原因。

    		Completed
    Messagestring

    事件消息。

    		Completed
    HostIpstring

    主机IP。

    		192.168.XX.XX
    Phasestring

    Pod生命周期阶段。

    		Running
    PodIpstring

    Pod IP地址。

    		192.168.XX.XX
    PodIpsarray

    Pod IP地址集合。

    object

    Pod IP地址集合。

    Ipstring

    Pod IP地址。

    		192.168.XX.XX
    QosClassstring

    Pod Qos。

    		Guaranteed
    StartTimestring

    容器开始运行时间。

    		2021-05-12T07:02:47Z

    示例

    正常返回示例

    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"
      }
    }
  ]
}

    错误码

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

    变更历史

    变更时间变更内容概要操作
    2021-09-27OpenAPI 入参发生变更
    变更项变更内容
    入参OpenAPI 入参发生变更
      新增入参：ZoneId