AI 助理
备案控制台
官方文档
输入文档关键字查找
首页 弹性容器实例 开发参考 API参考 API目录 容器组 DescribeContainerGroupStatus - 批量查询容器组状态

DescribeContainerGroupStatus - 批量查询容器组状态

更新时间：
产品详情
我的收藏

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

调试

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

调试

授权信息

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

  • 操作：是指具体的权限点。

  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。

  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：

    • 对于必选的资源类型，用前面加 * 表示。

    • 对于不支持资源级授权的操作，用全部资源表示。

  • 条件关键字：是指云产品自身定义的条件关键字。

  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

eci:DescribeContainerGroupStatus

get

*containergroup

acs:eci:{#regionId}:{#accountId}:containergroup/{#containergroupId}
  • eci:tag
 无

请求参数

名称

类型

必填

描述

示例值
RegionId

string

是

地域 ID。

cn-hangzhou
ZoneId

string

否

可用区 ID。

cn-hangzhou-k
VSwitchId

string

否

交换机 ID。

vsw-uf6h3rbwbm90urjwa****
ResourceGroupId

string

否

资源组 ID。

rg-uf66jeqopgqa9hdn****
ContainerGroupIds

string

否

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

["eci-bp17gw49eu09yiwm****", "eci-bp19aq49du01abcm****", "eci-2zegym1qhbmdfr1s****"]
SinceSecond

integer

否

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

60
Tag

array<object>

否

ECI 实例绑定的标签。

object

否

ECI 实例绑定的标签。

Value

string

否

ECI 实例的标签值。

testValue
Key

string

否

ECI 实例的标签键。

testKey
NextToken

string

否

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

d78f2dd8-5979-42fe-xaee-b16db43be5bc
Limit

integer

否

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

说明

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

200

返回参数

名称

类型

描述

示例值

object

Schema of Response

RequestId

string

请求 ID。

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

string

下一个查询开始的 Token。

d78f2dd8-5979-42fe-****-b16db43be5bc
TotalCount

integer

结果条数。

1
Data

array<object>

ECI 实例状态信息集合。

array<object>

ECI 实例状态信息集合。

ContainerGroupId

string

ECI 实例 ID。

eci-bp1jrgfqqy54kg5hc****
Name

string

ECI 实例名称。

nginx
Namespace

string

ECI 实例所在命名空间。

default
Status

string

ECI 实例状态。

Running
uuid

string

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

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

string

ECI 实例的注解。

"{\"tenancy.x-k8s.io/namespace\":\"redis\"}"
PodStatus

object

ECI 实例的状态信息。

Conditions

array<object>

Pod conditions 信息。

object

Pod conditions 信息。

type

string

condition 类型。可能值：

  • PodReadyToStartContainers

  • Initialized

  • Ready

  • ContainersReady

  • PodScheduled

  • ContainerHasSufficientDisk

  • ContainerInstanceCreated

  • Unschedulable

Ready
status

string

condition 状态。

True
Reason

string

事件原因。

Completed
Message

string

事件消息。

Completed
lastTransitionTime

string

最后一次状态变化时间。

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

array<object>

容器状态信息。

array<object>

容器状态信息。

Image

string

容器镜像。

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

string

镜像 ID。

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

string

容器名称。

ubuntu
Ready

boolean

容器是否 Ready。

true
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

容器 ID。

containerd://3ff993933bea366c4719e43a1b067d89bc7f01f1f573981659a44ff17a******
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

容器 ID。

containerd://3ff993933bea366c4719e43a1b067d89bc7f01f1f573981659a44ff17a******
ExitCode

integer

退出码。

0
FinishedAt

string

结束时间。

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

string

开始时间。

2021-05-12T07:02:52Z
Signal

integer

信号码。

1
Reason

string

事件原因。

Completed
Message

string

事件消息。

Completed
HostIp

string

主机 IP。

192.168.XX.XX
Phase

string

Pod 生命周期阶段。

Running
PodIp

string

Pod IP 地址。

192.168.XX.XX
PodIps

array<object>

Pod IP 地址集合。

object

Pod IP 地址集合。

Ip

string

Pod IP 地址。

192.168.XX.XX
QosClass

string

Pod Qos。

Guaranteed
StartTime

string

容器开始运行时间。

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****",
      "Annotations": "\"{\\\"tenancy.x-k8s.io/namespace\\\":\\\"redis\\\"}\"",
      "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": "2021-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"
      }
    }
  ]
}

错误码

HTTP status code

错误码

错误信息

描述
400 InvalidParameter.MismatchInstanceType The instanceId mismatch instance type. 实例类型错误

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

变更历史

更多信息，参考变更详情。

上一篇：DescribeContainerGroups - 批量查询容器组信息下一篇：DescribeContainerGroupEvents - 查询容器组事件列表