文档

DescribeContainerGroupStatus - 批量查询容器组状态

更新时间:

批量查询ECI实例的状态。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
eci:DescribeContainerGroupStatusRead
  • containergroup
    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
Tagobject []

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
Dataobject []

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****
Annotationsstring

ECI 实例的注解。

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

ECI 实例的状态信息。

Conditionsobject []

Pod conditions 信息。

typestring

condition 类型。可能值:

  • PodScheduled
  • Ready
  • Initialized
  • Unschedulable
Ready
statusstring

condition 状态。

True
Reasonstring

事件原因。

Completed
Messagestring

事件消息。

Completed
lastTransitionTimestring

最后一次状态变化时间。

2021-05-12T07:02:47Z
ContainerStatusesobject []

容器状态信息。

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

开始时间。

2021-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
PodIpsobject []

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

错误码

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

变更历史

变更时间变更内容概要操作
2023-05-08OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
2021-09-27OpenAPI 入参发生变更看变更集
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参:ZoneId
  • 本页导读 (1)
文档反馈