DescribeContainerGroupStatus - 批量查詢容器組狀態 - Elastic Container Instance

調用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.	執行個體類型錯誤

訪問錯誤中心查看更多錯誤碼。

變更歷史

更多資訊，參考變更詳情。