すべてのプロダクト
Search
ドキュメントセンター

:DescribeContainerGroupStatus

最終更新日:Oct 17, 2025

DescribeContainerGroupStatus を呼び出すことで、複数の Elastic Container Instance (ECI) インスタンスのステータスを一括でクエリできます。

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

  • アクション:特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。

  • API:アクションを具体的に実行するための API。

  • アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。

  • リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。

    • リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。

    • リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。

  • 条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。

  • 依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

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

任意

vSwitch ID。

vsw-uf6h3rbwbm90urjwa****

ResourceGroupId

string

任意

リソースグループ ID。

rg-uf66jeqopgqa9hdn****

ContainerGroupIds

string

任意

Elastic Container Instance (ECI) インスタンスの ID。最大 20 個の ID を指定できます。値は JSON 形式の文字列である必要があります。

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

SinceSecond

integer

任意

時間 (秒単位) 。この操作は、この期間内に更新された ECI インスタンスのステータスを返します。このパラメーターはポーリングに使用されます。

60

Tag

array<object>

任意

ECI インスタンスにアタッチされたタグ。

object

任意

ECI インスタンスにアタッチされたタグ。

Value

string

任意

タグの値。

testValue

Key

string

任意

タグキー。

testKey

NextToken

string

任意

次のページの結果を取得するためのトークン。最初のリクエストでは、このパラメーターを設定する必要はありません。前のリクエストへの応答の NextToken パラメーターからトークンを取得できます。

d78f2dd8-5979-42fe-xaee-b16db43be5bc

Limit

integer

任意

返される ECI インスタンスの最大数。デフォルト値は 200 です。

説明

返されるインスタンスの数は、指定された値以下になります。

200

レスポンスフィールド

フィールド

説明

object

応答のスキーマ

RequestId

string

リクエスト ID。

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

NextToken

string

次のクエリを開始するためのトークン。

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) 。これは Kubernetes の Pod UID に対応します。

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

Annotations

string

ECI インスタンスのアノテーション。

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

PodStatus

object

ECI インスタンスのステータス情報。

Conditions

array<object>

Pod の条件。

object

Pod の条件。

type

string

条件のタイプ。有効な値:

  • PodReadyToStartContainers

  • Initialized

  • Ready

  • ContainersReady

  • PodScheduled

  • ContainerHasSufficientDisk

  • ContainerInstanceCreated

  • Unschedulable

Ready

status

string

条件のステータス。

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

コンテナーが準備完了かどうかを示します。

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 の Quality of Service (QoS) クラス。

Guaranteed

StartTime

string

Pod が開始された時間。

2021-05-12T07:02:47Z

成功レスポンス

JSONJSON

{
  "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 ステータスコード

エラーコード

エラーメッセージ

説明

400 InvalidParameter.MismatchInstanceType The instanceId mismatch instance type.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。