すべてのプロダクト
Search

このプロダクト

    :DescribeContainerGroups

    ドキュメントセンター

    :DescribeContainerGroups

    最終更新日:Oct 17, 2025

    DescribeContainerGroups を呼び出して、複数の ECI インスタンスに関する情報をクエリできます。

    操作説明

    • ECI インスタンスの実行が停止すると、その基盤となる計算資源が回収されます。インスタンスと共に作成された他のリソース (EIP など) は、デフォルトでインスタンスと共にリリースされます。

    • ターミナル状態 (Failed、Succeeded、または Expired) のインスタンスのメタデータは、次のように保持されます。

      • 過去 1 時間以内に作成されたインスタンスのすべてのメタデータが保持されます。

      • 1 時間以上経過したインスタンスについては、各リージョンで最後の 100 インスタンスのメタデータのみが保持されます。

    • 必要な API 権限を持たない RAM ユーザーまたは RAM ロールを使用してクエリを実行すると、空のリストが返されます。

    今すぐお試しください

    この 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:DescribeContainerGroups

    get

    ContainerGroup

    acs:eci:{#regionId}:{#accountId}:containergroup/*

    ContainerGroup

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

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    RegionId

    string

    必須

    インスタンスのリージョン ID。

    cn-hangzhou
    RegionId

    string

    必須

    インスタンスのリージョン ID。

    cn-hangzhou
    ZoneId

    string

    任意

    インスタンスが配置されているゾーン。このパラメーターを空のままにすると、システムはゾーンを選択します。

    デフォルト値は空です。

    cn-hangzhou-h
    VSwitchId

    string

    任意

    インスタンスが接続されている vSwitch の ID。

    vsw-bp1jrgfqqy54kg5hc****
    NextToken

    string

    任意

    次のクエリの開始を示すトークン。このパラメーターが空の場合、それ以上の結果は返されません。

    説明

    最初のクエリでは、このパラメーターを設定する必要はありません。後続のクエリのトークンは、前のクエリの応答から取得されます。

    d78f2dd8-5979-42fe-****-b16db43be5bc
    Limit

    integer

    任意

    返すリソースの数。このパラメーターを設定しない場合、デフォルト値は 20 です。最大値は 20 です。

    説明

    返されるリソースの数は、指定された値より少なくなることはありますが、大きくなることはありません。

    20
    ContainerGroupIds

    string

    任意

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

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

    string

    任意

    インスタンスの名前。コンテナグループの名前でもあります。

    test
    Status

    string

    任意

    インスタンスのステータス。有効な値:

    • Pending: インスタンスは開始中です。

    • Running: インスタンスは実行中です。

    • Succeeded: インスタンスは正常に実行されました。

    • Failed: インスタンスの実行に失敗しました。

    • Scheduling: インスタンスは作成中です。

    • ScheduleFailed: インスタンスの作成に失敗しました。

    • Restarting: インスタンスは再起動中です。

    • Updating: インスタンスは更新中です。

    • Terminating: インスタンスは停止中です。

    • Expired: インスタンスは期限切れです。

    Running
    ResourceGroupId

    string

    任意

    インスタンスが属するリソースグループの ID。

    rg-aekzh43v*****

    WithEvent

    boolean

    任意

    イベント情報を返すかどうかを指定します。

    true
    Tag

    array<object>

    任意

    インスタンスのタグ。

    object

    任意

    インスタンスのタグ。

    Key

    string

    任意

    インスタンスのタグキー。

    name
    Value

    string

    任意

    インスタンスのタグ値。

    test
    ComputeCategory

    string

    任意

    計算能力カテゴリ。有効な値:

    • economy: エコノミー型

    • general: 汎用

    economy
    SecurityGroupId

    string

    任意

    インスタンスが属するセキュリティグループの ID。

    sg-uf66jeqopgqa9hdn****

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    TotalCount

    integer

    インスタンスの数。

    1
    NextToken

    string

    次のクエリの開始を示すトークン。

    d78f2dd8-5979-42fe-****-b16db43be5bc
    RequestId

    string

    リクエスト ID。一意の識別子です。

    89945DD3-9072-47D0-A318-353284CFC7B3
    ContainerGroups

    array<object>

    インスタンス情報のリスト。

    array<object>

    インスタンス情報のリスト。

    Status

    string

    インスタンスのステータス。指定できる値:

    • Pending: インスタンスは開始中です。

    • Running: インスタンスは実行中です。

    • Succeeded: インスタンスは正常に実行されました。

    • Failed: インスタンスの実行に失敗しました。

    • Scheduling: インスタンスは作成中です。

    • ScheduleFailed: インスタンスの作成に失敗しました。

    • Restarting: インスタンスは再起動中です。

    • Updating: インスタンスは更新中です。

    • Terminating: インスタンスは停止中です。

    • Expired: インスタンスは期限切れです。

    Running
    CreationTime

    string

    システムがリクエストを受信した後にインスタンスを作成した時刻。時刻は UTC で、RFC3339 標準に準拠しています。

    2018-08-02T15:00:00Z
    VpcId

    string

    インスタンスが属する VPC の ID。

    vpc-1vzjjflab6wvjox****
    InternetIp

    string

    パブリック IP アドレス。

    192.0.XX.XX
    TenantSecurityGroupId

    string

    このパラメーターは利用できません。

    sg-xxx
    SecurityGroupId

    string

    セキュリティグループ ID。

    sg-bp12ujq5zpxuyjfo3o8r
    HostAliases

    array<object>

    インスタンス内のコンテナーのホスト名と IP アドレス間のカスタムマッピング。

    object

    インスタンス内のコンテナーのホスト名と IP アドレス間のカスタムマッピング。

    Hostnames

    array

    ホスト情報。

    string

    ホスト名。

    ['hehe.com', 'haha.com']
    Ip

    string

    IP アドレス。

    192.0.XX.XX
    Tags

    array<object>

    インスタンスのタグ。

    object

    インスタンスのタグ。

    Key

    string

    タグキー。

    name
    Value

    string

    タグ値。

    test-xh
    Events

    array<object>

    イベント情報。最大 50 件のイベントを返すことができます。

    object

    イベント情報。最大 50 件のイベントを返すことができます。

    Type

    string

    イベントタイプ。指定できる値:

    • Normal

    • Warning

    Normal
    LastTimestamp

    string

    イベントが終了した時刻。

    2018-08-02T15:00:00Z
    Message

    string

    イベントメッセージ。

    Started container
    Name

    string

    イベントが属するオブジェクトの名前。

    test-xxx
    Reason

    string

    イベント名。

    Created
    Count

    integer

    イベントの数。

    20
    FirstTimestamp

    string

    イベントが開始された時刻。

    2018-08-02T15:00:00Z
    SucceededTime

    string

    すべてのコンテナーが正常に終了した時刻。時刻は UTC で、RFC3339 標準に準拠しています。

    2019-12-11T04:33:42Z
    SpotStrategy

    string

    インスタンスのプリエンプションポリシー。有効な値:

    • NoSpot (デフォルト): 通常の従量課金インスタンス。

    • SpotWithPriceLimit: ユーザー定義の 1 時間あたりの最大価格を持つスポットインスタンス。

    • SpotAsPriceGo: システムが現在の市場価格に基づいて自動的に入札するスポットインスタンス。

    NoSpot
    SpotPriceLimit

    number

    スポットインスタンスの 1 時間あたりの最大価格。

    このパラメーターは、SpotStrategy が SpotWithPriceLimit に設定されている場合にのみ返されます。

    0.025
    EphemeralStorage

    integer

    一時記憶領域のサイズ。単位: GiB。

    20
    TenantEniInstanceId

    string

    このパラメーターは利用できません。

    i-xxx
    Discount

    integer

    割引。

    9
    RestartPolicy

    string

    コンテナグループの再起動ポリシー。有効な値:

    • Never: 再起動しません。

    • Always: 常に再起動します。

    • OnFailure: 失敗時に再起動します。

    Never
    Memory

    number

    インスタンスのメモリサイズ。単位: GiB。

    4.0
    TenantVSwitchId

    string

    このパラメーターは利用できません。

    vsw-xxx
    Containers

    array<object>

    インスタンス内のコンテナーのリスト。

    array<object>

    インスタンス内のコンテナーのリスト。

    LivenessProbe

    object

    liveness プローブ。

    SuccessThreshold

    integer

    失敗したプローブが成功したと見なされるための最小連続成功回数。デフォルト値は 1 です。値は 1 である必要があります。

    1
    InitialDelaySeconds

    integer

    コンテナーの起動時から計算して、チェックが開始されるまでの時間。

    10
    FailureThreshold

    integer

    成功したプローブが失敗したと見なされるための最小連続失敗回数。デフォルト値は 3 です。

    3
    TimeoutSeconds

    integer

    チェックのタイムアウト期間。デフォルト値は 1 秒です。最小値は 1 秒です。

    10
    TcpSocket

    object

    TCP ソケット。

    Host

    string

    ホスト名。

    1.2.3.4
    Port

    integer

    ポート番号。

    80
    Execs

    array

    実行するコマンド。

    string

    実行するコマンド。

    ["/bin/sh", "-c", "echo Hello world > /usr/share/message"]
    HttpGet

    object

    HTTP GET リクエスト。

    Scheme

    string

    HTTP または HTTPS。

    HTTP
    Path

    string

    HTTP GET リクエストチェックのパス。

    /usr/nginx/
    Port

    integer

    HTTP GET リクエストチェックのポート。

    80
    PeriodSeconds

    integer

    チェックが実行される間隔。デフォルト値は 10 秒です。最小値は 1 秒です。

    5
    Commands

    array

    コンテナーの起動コマンド。

    string

    コンテナーの起動コマンド。

    [/bin/sh echo]
    VolumeMounts

    array<object>

    マウントされたボリュームに関する情報。

    object

    マウントされたボリュームに関する情報。

    MountPropagation

    string

    ボリュームのマウント伝達設定。マウント伝達により、コンテナーによってマウントされたボリュームを同じ Pod 内の他のコンテナーと共有したり、同じノード上の他の Pod と共有したりできます。指定できる値:

    • None: このボリュームまたはそのサブディレクトリで実行される後続のマウントをボリュームが受信しません。

    • HostToContainer: このボリュームまたはそのサブディレクトリで実行される後続のマウントをすべてボリュームが受信します。

    • Bidirectional: HostToContainer に似ています。ボリュームはマウント操作を受信します。さらに、ボリュームはホストと、同じボリュームを使用するすべての Pod のすべてのコンテナーに伝達されます。

    None
    MountPath

    string

    マウントパス。コンテナーのマウントパス内のコンテンツは、ボリュームのコンテンツによって上書きされます。

    /usr/share/
    ReadOnly

    boolean

    ボリュームが読み取り専用であるかどうかを指定します。

    false
    Name

    string

    ボリュームの名前。

    test-empty
    SubPath

    string

    ボリューム内のサブディレクトリ。これにより、インスタンスは同じボリュームから異なるディレクトリをコンテナー内の異なるディレクトリにマウントできます。

    /usr/sub
    Args

    array

    コンテナーの起動引数。

    string

    コンテナーの起動引数。

    ["hello"]
    Image

    string

    コンテナイメージ。

    mysql
    Ports

    array<object>

    公開ポートとプロトコル。

    object

    公開ポートとプロトコル。

    Protocol

    string

    プロトコルタイプ。

    TCP
    Port

    integer

    ポート番号。指定できる値: 1～65535。

    8080
    RestartCount

    integer

    再起動回数。

    0
    ImagePullPolicy

    string

    イメージプルポリシー。指定できる値:

    • Always: 常にイメージをプルします。

    • IfNotPresent: ローカルに存在しない場合にイメージをプルします。

    • Never: イメージをプルしません。ローカルイメージを使用します。

    Always
    StdinOnce

    boolean

    stdin が true の場合、標準入力ストリームは複数のアタッチセッションにわたって開いたままになります。StdinOnce が true に設定されている場合、stdin はコンテナーの起動時に開かれ、最初のクライアントが stdin にアタッチするまで空のままになります。その後、開いたままになり、クライアントが切断するまでデータを受信します。その時点で、stdin は閉じられ、コンテナーが再起動されるまで閉じたままになります。

    true
    Cpu

    number

    コンテナーの vCPU サイズ。

    2.0
    PreviousState

    object

    前の状態。

    StartTime

    string

    コンテナーが実行を開始した時刻。

    2021-12-02T15:00:00Z
    FinishTime

    string

    コンテナーの実行が停止した時刻。

    2021-12-02T15:01:00Z
    DetailStatus

    string

    ステータスの詳細。

    working
    State

    string

    コンテナーステータス。指定できる値:

    • Waiting: コンテナーは開始中です。

    • Running: コンテナーは実行中です。

    • Terminated: コンテナーは停止しました。

    Terminated
    Message

    string

    コンテナーステータスメッセージ。

    Back-off 5m0s restarting failed container=test pod=test_eci-xxx(xxx)
    Signal

    integer

    コンテナーステータス信号。

    1
    ExitCode

    integer

    コンテナーの終了コード。

    0
    Reason

    string

    コンテナーステータスの理由。

    Completed
    Tty

    boolean

    インタラクションを有効にするかどうかを指定します。デフォルト値は false です。たとえば、Command を /bin/bash に設定した場合、このパラメーターを true に設定する必要があります。

    false
    WorkingDir

    string

    作業ディレクトリ。

    /usr/local/nginx
    CurrentState

    object

    コンテナーの現在のステータス。

    StartTime

    string

    コンテナーの開始時刻。

    2021-12-02T15:00:00Z
    FinishTime

    string

    コンテナーの実行が停止した時刻。

    2021-12-02T15:01:00Z
    DetailStatus

    string

    コンテナーの詳細なステータス。

    working
    State

    string

    コンテナーの状態。指定可能な値:

    • Waiting

    • Running

    • Terminated

    Terminated
    Message

    string

    コンテナーのステータスメッセージ。

    Back-off 5m0s restarting failed container=test pod=test_eci-xxx(xxx)
    Signal

    integer

    コンテナーのステータス信号。

    1
    ExitCode

    integer

    コンテナーの終了コード。

    0
    Reason

    string

    コンテナーのステータスの理由。

    Started
    Ready

    boolean

    コンテナーが readiness プローブに合格したかどうかを示します。

    true
    Gpu

    integer

    GPU の数。

    1
    SecurityContext

    object

    インスタンスの Security Context。

    ReadOnlyRootFilesystem

    boolean

    ルートファイルシステムが読み取り専用であるかどうかを示します。現在、`true` のみがサポートされています。

    true
    RunAsUser

    integer

    コンテナーを実行するユーザー ID。

    1000
    Capability

    object

    コンテナー内のプロセスに付与される特定の権限。

    Adds

    array

    コンテナー内のプロセスに対する特定の権限。

    string

    コンテナー内のプロセスに付与される特定のケーパビリティ。

    [NET_ADMIN]
    Memory

    number

    コンテナーのメモリサイズ。単位は GiB です。

    2.0
    Stdin

    boolean

    コンテナーランタイムがコンテナーの標準入力用にバッファーを割り当てる必要があるかどうかを指定します。割り当てない場合、標準入力からの読み取りは End-of-File (EOF) を返します。デフォルトは false です。

    true
    Name

    string

    コンテナー名。

    nginx
    EnvironmentVars

    array<object>

    環境変数。

    array<object>

    環境変数。

    Key

    string

    環境変数の名前。

    PATH
    Value

    string

    環境変数の値。

    /usr/bin/
    ValueFrom

    object

    環境変数の値のソース。このパラメーターは、Value パラメーターが Empty でない場合は使用できません。

    FieldRef

    object

    指定されたフィールド。

    FieldPath

    string

    フィールドのパス。

    status.podIP
    ReadinessProbe

    object

    アプリケーションの readiness プローブ。コンテナーがリクエストを処理できる状態かどうかをチェックします。

    SuccessThreshold

    integer

    失敗した後、プローブが成功したと見なされるための連続した成功の最小回数。デフォルト値は 1 です。値は 1 である必要があります。

    1
    InitialDelaySeconds

    integer

    コンテナーの起動後、チェックが開始されるまでの秒数。

    5
    FailureThreshold

    integer

    最後のプローブが成功した後、プローブが失敗したと見なされるまでの連続失敗回数。デフォルト値は 3 です。

    3
    TimeoutSeconds

    integer

    プローブのタイムアウト (秒)。デフォルト値は 1 秒です。最小値は 1 秒です。

    1
    TcpSocket

    object

    ヘルスチェックは TCP ソケットを使用します。

    Host

    string

    ホスト名または IP アドレス。

    1.2.3.4
    Port

    integer

    ポート番号。

    8888
    Execs

    array

    コマンドラインヘルスチェックでコンテナー内で実行するコマンド。

    string

    コマンドラインのヘルスチェックのためにコンテナーで実行するコマンド。

    ["/bin/sh", "-c", "echo Hello world > /usr/share/message"]
    HttpGet

    object

    ヘルスチェックは HTTP リクエストを使用して実行されます。

    Scheme

    string

    HTTP/HTTPS。

    HTTP
    Path

    string

    HTTP GET チェックのパス。

    /usr/local
    Port

    integer

    HttpGet チェックのポート番号です。

    8080
    PeriodSeconds

    integer

    チェックを実行する期間。デフォルトは 10 秒です。最小値は 1 秒です。

    1
    EniInstanceId

    string

    エラスティックネットワークインターフェース (ENI) の ID です。

    eni-bp14rzqi6fd8satm****
    InitContainers

    array<object>

    init コンテナーのリスト。

    array<object>

    init コンテナーのリスト。

    VolumeMounts

    array<object>

    init コンテナーにマウントされたボリューム。

    object

    init コンテナーにマウントされたボリューム。

    MountPropagation

    string

    ボリュームのマウント伝播設定。マウント伝播により、コンテナーによってマウントされたボリュームを同じ Pod 内の他のコンテナーと共有できます。また、同じノード上の他の Pod とボリュームを共有することもできます。指定できる値は次のとおりです。

    • None: ボリュームは、このボリュームまたはそのサブディレクトリで実行される後続のマウントを受け取りません。

    • HostToContainer: ボリュームは、このボリュームまたはそのサブディレクトリで実行される後続のマウントを受け取ります。

    • Bidirectional: HostToContainer と同様に、この設定により、ボリュームはマウント操作を受け取ることができます。また、ボリュームマウントをホストと、同じボリュームを使用するすべての Pod のすべてのコンテナーに伝播します。

    None
    MountPath

    string

    コンテナー内のマウントパス。ボリュームの内容は、このパスにある既存のコンテンツを上書きします。

    /usr/share/
    ReadOnly

    boolean

    ボリュームが読み取り専用であるかどうかを示します。

    false
    Name

    string

    ボリュームの名前。これは、Volume の Name と同じである必要があります。

    test-empty
    Args

    array

    起動引数。

    string

    起動引数。

    ['hello world']
    Image

    string

    イメージ。

    nginx
    Ports

    array<object>

    公開ポートとプロトコル。

    object

    公開ポートとプロトコル。

    Protocol

    string

    プロトコルの種類。

    TCP
    Port

    integer

    ポート番号。有効な値： 1～65535。

    8888
    RestartCount

    integer

    再起動回数。

    5
    ImagePullPolicy

    string

    イメージプルポリシー。有効な値:

    • Always: イメージは常にプルされます。

    • IfNotPresent: イメージがローカルに存在しない場合にのみプルされます。

    • Never: イメージはプルされません。ローカルイメージのみが使用されます。

    Always
    PreviousState

    object

    前の状態。

    StartTime

    string

    コンテナーが開始された時刻。

    2021-12-02T15:00:00Z
    FinishTime

    string

    コンテナーが実行を停止した時間。

    2021-12-02T15:01:00Z
    DetailStatus

    string

    ステータスの詳細。

    working
    State

    string

    コンテナーのステータス。列挙値は Waiting、Running、および Terminated です。

    Terminated
    Message

    string

    コンテナーのステータスメッセージ。

    Started container
    Signal

    integer

    コンテナーのステータス信号。

    1
    ExitCode

    integer

    コンテナーの終了コード。

    0
    Reason

    string

    コンテナーのステータスの理由。

    completed
    WorkingDir

    string

    作業ディレクトリ。

    /usr/test
    Cpu

    number

    vCPU のサイズ。

    1.0
    CurrentState

    object

    現在のステータス。

    StartTime

    string

    コンテナーが実行を開始した時間。

    2021-12-02T15:00:00Z
    FinishTime

    string

    コンテナーの実行が終了した時刻。

    2021-12-02T15:01:00Z
    DetailStatus

    string

    詳細なステータス。

    working
    State

    string

    コンテナーのステータス。指定できる値:

    • Waiting

    • Running

    • Terminated

    Running
    Message

    string

    イベントメッセージ。

    Created container
    Signal

    integer

    コンテナーのステータス信号。

    1
    ExitCode

    integer

    コンテナーの終了コード。

    0
    Reason

    string

    コンテナーのステータスの理由。

    Started
    Command

    array

    起動コマンド。

    string

    起動コマンド。

    [/bin/sh echo]
    Ready

    boolean

    コンテナーが readiness プローブに合格したかどうかを示します。

    true
    Gpu

    integer

    GPU の数。

    1
    SecurityContext

    object

    コンテナーのセキュリティコンテキストです。

    ReadOnlyRootFilesystem

    boolean

    ルートファイルシステムが読み取り専用かどうかを示します。現在、true のみがサポートされています。

    true
    RunAsUser

    integer

    コンテナープロセスのエントリポイントを実行するために使用される UID。

    1557
    Capability

    object

    コンテナー内のプロセスに対する特定の権限。

    Adds

    array

    コンテナー内のプロセスが持つ特定の権限。

    string

    コンテナー内のプロセスに付与される特定の権限。

    NET_ADMIN
    Memory

    number

    init コンテナーのメモリサイズ (GiB)。

    2.0
    Name

    string

    コンテナーの名前。

    Init-xxx
    EnvironmentVars

    array<object>

    環境変数。

    array<object>

    環境変数。

    Key

    string

    環境変数の名前。

    PATH
    Value

    string

    環境変数の値。

    /usr/local/bin
    ValueFrom

    object

    環境変数の値のソース。Value パラメーターが設定されている場合、このパラメーターは使用できません。

    FieldRef

    object

    指定されたフィールド。

    FieldPath

    string

    指定されたバージョンから選択するフィールドのパス。現在、status.podIP のみがサポートされています。

    status.podIP
    ContainerGroupId

    string

    インスタンスの ID です。

    eci-bp1jrgfqqy54kg5hc****
    TenantEniIp

    string

    このパラメーターは利用できません。

    10.10.XX.XX
    InstanceType

    string

    指定された ECS インスタンスタイプ。

    ecs.g5.large
    IntranetIp

    string

    イントラネット IP アドレス。

    172.16.XX.XX
    Ipv6Address

    string

    IPv6 アドレス。

    2001:XXXX:4:4:4:4:4:4
    RegionId

    string

    インスタンスのリージョン ID です。

    cn-hangzhou
    DnsConfig

    object

    DNS 構成。

    Searches

    array

    DNS 検索ドメインのリスト。

    string

    DNS 検索ドメイン。

    svc.local.kubenetes
    Options

    array<object>

    オプションオブジェクトのリスト。各オブジェクトは、Name とオプションの Value で構成されます。

    object

    オプションオブジェクトのリスト。各オブジェクトは Name とオプションの Value で構成されます。

    Value

    string

    変数の値。

    value
    Name

    string

    オブジェクト変数の名前。

    name
    NameServers

    array

    DNS サーバの IP アドレス。

    string

    IP アドレス。

    [10.2.*.*]
    Volumes

    array<object>

    ボリューム情報。

    array<object>

    ボリュームを記述します。

    Type

    string

    ボリュームのタイプ。有効な値は次のとおりです。

    • EmptyDirVolume

    • NFSVolume

    • ConfigFileVolume

    • FlexVolume

    EmptyDirVolume
    DiskVolumeDiskId

    string

    DiskVolume の ID。

    d-xxxx
    NFSVolumeReadOnly

    boolean

    ボリュームが読み取り専用かどうかを示します。

    false
    ConfigFileVolumeConfigFileToPaths

    array<object>

    構成ファイルのパスのリスト。

    object

    構成ファイルパスのリストです。

    Path

    string

    ファイルの相対パスです。

    /usr/bin/
    Content

    string

    構成ファイルの内容。サイズは 32 KB に制限されています。

    hello world
    FlexVolumeFsType

    string

    マウントするファイルシステムのタイプ。デフォルト値は FlexVolume スクリプトによって異なります。

    ntfs
    FlexVolumeDriver

    string

    FlexVolume のドライバーの名前。

    flexvolume
    DiskVolumeFsType

    string

    ボリュームのタイプ。

    xfs
    FlexVolumeOptions

    string

    FlexVolume オブジェクトのオプションのリスト。

    [nolock,tcp,noresvport]
    NFSVolumeServer

    string

    NFS サーバーのアドレス。

    0eafxxxxx-xxxxx.cn-hangzhou.nas.aliyuncs.com
    NFSVolumePath

    string

    NFS ボリュームのパス。

    /eci
    Name

    string

    ボリュームの名前。

    test-empty
    EmptyDirVolumeMedium

    string

    emptyDir ボリュームの記憶媒体。デフォルト値は空で、ノードのファイルシステムが使用されることを意味します。有効な値:

    • Memory: メモリを使用します。

    • LocalRaid0: ローカルディスクを RAID 0 配列に結合します。この値は、ローカルディスクを持つインスタンスを作成してアタッチする場合にのみ有効です。詳細については、「ローカルディスクを持つインスタンスを作成する」をご参照ください。

    Memory
    EmptyDirVolumeSizeLimit

    string

    EmptyDir ボリュームのサイズ。

    256Mi
    RamRoleName

    string

    インスタンス RAM ロールの名前。ECI と ECS はインスタンス RAM ロールを共有します。詳細については、「API を使用してインスタンス RAM ロールを使用する」をご参照ください。

    ram:PassRole
    VSwitchId

    string

    vSwitch ID。

    vsw-bp1vzjjflab6wvjox****
    Cpu

    number

    インスタンスの vCPU の数。

    2.0
    ExpiredTime

    string

    支払い遅延のためインスタンスの実行が失敗した時刻。時刻は UTC で、RFC 3339 に従ってフォーマットされています。

    2018-08-02T15:00:00Z
    ResourceGroupId

    string

    リソースグループの ID。

    rg-8db03793gfrz****
    ZoneId

    string

    インスタンスが属するゾーン。

    cn-hangzhou-h
    ContainerGroupName

    string

    コンテナグループの名前。

    test
    EciSecurityContext

    object

    コンテナグループの Security Context です。

    Sysctls

    array<object>

    sysctl パラメーター。

    object

    sysctl パラメーター。

    Value

    string

    sysctl パラメーターの値。

    65536
    Name

    string

    sysctl パラメーターの名前。

    kernel.msgmax
    FailedTime

    string

    インスタンスが失敗した時間。時間は UTC で、RFC 3339 標準に準拠しています。

    2018-08-02T15:00:00Z
    ComputeCategory

    string

    計算能力のカテゴリ。有効な値は次のとおりです。

    • economy: エコノミー型

    • general: 汎用型

    economy
    DnsPolicy

    string

    DNS ポリシー。有効な値:

    • None: DnsConfig フィールドの DNS 設定を使用します。

    • Default: ランタイム環境から DNS 設定を継承します。

    None

    例

    成功レスポンス

    JSONJSON

    {
  "TotalCount": 1,
  "NextToken": "d78f2dd8-5979-42fe-****-b16db43be5bc",
  "RequestId": "89945DD3-9072-47D0-A318-353284CFC7B3",
  "ContainerGroups": [
    {
      "Status": "Running",
      "CreationTime": "2018-08-02T15:00:00Z",
      "VpcId": "vpc-1vzjjflab6wvjox****",
      "InternetIp": "192.0.XX.XX",
      "TenantSecurityGroupId": "sg-xxx",
      "SecurityGroupId": "sg-bp12ujq5zpxuyjfo3o8r",
      "HostAliases": [
        {
          "Hostnames": [
            "['hehe.com', 'haha.com']"
          ],
          "Ip": "192.0.XX.XX"
        }
      ],
      "Tags": [
        {
          "Key": "name",
          "Value": "test-xh"
        }
      ],
      "Events": [
        {
          "Type": "Normal",
          "LastTimestamp": "2018-08-02T15:00:00Z",
          "Message": "Started container",
          "Name": "test-xxx",
          "Reason": "Created",
          "Count": 20,
          "FirstTimestamp": "2018-08-02T15:00:00Z"
        }
      ],
      "SucceededTime": "2019-12-11T04:33:42Z",
      "SpotStrategy": "NoSpot",
      "SpotPriceLimit": 0.025,
      "EphemeralStorage": 20,
      "TenantEniInstanceId": "i-xxx",
      "Discount": 9,
      "RestartPolicy": "Never",
      "Memory": 4,
      "TenantVSwitchId": "vsw-xxx",
      "Containers": [
        {
          "LivenessProbe": {
            "SuccessThreshold": 1,
            "InitialDelaySeconds": 10,
            "FailureThreshold": 3,
            "TimeoutSeconds": 10,
            "TcpSocket": {
              "Host": "1.2.3.4",
              "Port": 80
            },
            "Execs": [
              "[\"/bin/sh\", \"-c\", \"echo Hello world > /usr/share/message\"]"
            ],
            "HttpGet": {
              "Scheme": "HTTP",
              "Path": "/usr/nginx/",
              "Port": 80
            },
            "PeriodSeconds": 5
          },
          "Commands": [
            "[/bin/sh echo]"
          ],
          "VolumeMounts": [
            {
              "MountPropagation": "None",
              "MountPath": "/usr/share/",
              "ReadOnly": false,
              "Name": "test-empty",
              "SubPath": "/usr/sub"
            }
          ],
          "Args": [
            "[\"hello\"]"
          ],
          "Image": "mysql",
          "Ports": [
            {
              "Protocol": "TCP",
              "Port": 8080
            }
          ],
          "RestartCount": 0,
          "ImagePullPolicy": "Always",
          "StdinOnce": true,
          "Cpu": 2,
          "PreviousState": {
            "StartTime": "2021-12-02T15:00:00Z",
            "FinishTime": "2021-12-02T15:01:00Z",
            "DetailStatus": "working",
            "State": "Terminated",
            "Message": "Back-off 5m0s restarting failed container=test pod=test_eci-xxx(xxx)",
            "Signal": 1,
            "ExitCode": 0,
            "Reason": "Completed"
          },
          "Tty": false,
          "WorkingDir": "/usr/local/nginx",
          "CurrentState": {
            "StartTime": "2021-12-02T15:00:00Z",
            "FinishTime": "2021-12-02T15:01:00Z",
            "DetailStatus": "working",
            "State": "Terminated",
            "Message": "Back-off 5m0s restarting failed container=test pod=test_eci-xxx(xxx)",
            "Signal": 1,
            "ExitCode": 0,
            "Reason": "Started"
          },
          "Ready": true,
          "Gpu": 1,
          "SecurityContext": {
            "ReadOnlyRootFilesystem": true,
            "RunAsUser": 1000,
            "Capability": {
              "Adds": [
                "[NET_ADMIN]"
              ]
            }
          },
          "Memory": 2,
          "Stdin": true,
          "Name": "nginx",
          "EnvironmentVars": [
            {
              "Key": "PATH",
              "Value": "/usr/bin/",
              "ValueFrom": {
                "FieldRef": {
                  "FieldPath": "status.podIP"
                }
              }
            }
          ],
          "ReadinessProbe": {
            "SuccessThreshold": 1,
            "InitialDelaySeconds": 5,
            "FailureThreshold": 3,
            "TimeoutSeconds": 1,
            "TcpSocket": {
              "Host": "1.2.3.4",
              "Port": 8888
            },
            "Execs": [
              "[\"/bin/sh\", \"-c\", \"echo Hello world > /usr/share/message\"]"
            ],
            "HttpGet": {
              "Scheme": "HTTP",
              "Path": "/usr/local",
              "Port": 8080
            },
            "PeriodSeconds": 1
          }
        }
      ],
      "EniInstanceId": "eni-bp14rzqi6fd8satm****",
      "InitContainers": [
        {
          "VolumeMounts": [
            {
              "MountPropagation": "None",
              "MountPath": "/usr/share/",
              "ReadOnly": false,
              "Name": "test-empty"
            }
          ],
          "Args": [
            "['hello world']"
          ],
          "Image": "nginx",
          "Ports": [
            {
              "Protocol": "TCP",
              "Port": 8888
            }
          ],
          "RestartCount": 5,
          "ImagePullPolicy": "Always",
          "PreviousState": {
            "StartTime": "2021-12-02T15:00:00Z",
            "FinishTime": "2021-12-02T15:01:00Z",
            "DetailStatus": "working",
            "State": "Terminated",
            "Message": "Started container",
            "Signal": 1,
            "ExitCode": 0,
            "Reason": "completed"
          },
          "WorkingDir": "/usr/test",
          "Cpu": 1,
          "CurrentState": {
            "StartTime": "2021-12-02T15:00:00Z",
            "FinishTime": "2021-12-02T15:01:00Z",
            "DetailStatus": "working",
            "State": "Running",
            "Message": "Created container",
            "Signal": 1,
            "ExitCode": 0,
            "Reason": "Started"
          },
          "Command": [
            "[/bin/sh echo]"
          ],
          "Ready": true,
          "Gpu": 1,
          "SecurityContext": {
            "ReadOnlyRootFilesystem": true,
            "RunAsUser": 1557,
            "Capability": {
              "Adds": [
                "NET_ADMIN"
              ]
            }
          },
          "Memory": 2,
          "Name": "Init-xxx",
          "EnvironmentVars": [
            {
              "Key": "PATH",
              "Value": "/usr/local/bin",
              "ValueFrom": {
                "FieldRef": {
                  "FieldPath": "status.podIP"
                }
              }
            }
          ]
        }
      ],
      "ContainerGroupId": "eci-bp1jrgfqqy54kg5hc****",
      "TenantEniIp": "10.10.XX.XX",
      "InstanceType": "ecs.g5.large",
      "IntranetIp": "172.16.XX.XX",
      "Ipv6Address": "2001:XXXX:4:4:4:4:4:4",
      "RegionId": "cn-hangzhou",
      "DnsConfig": {
        "Searches": [
          "svc.local.kubenetes"
        ],
        "Options": [
          {
            "Value": "value",
            "Name": "name"
          }
        ],
        "NameServers": [
          "[10.2.*.*]"
        ]
      },
      "Volumes": [
        {
          "Type": "EmptyDirVolume",
          "DiskVolumeDiskId": "d-xxxx",
          "NFSVolumeReadOnly": false,
          "ConfigFileVolumeConfigFileToPaths": [
            {
              "Path": "/usr/bin/",
              "Content": "hello world"
            }
          ],
          "FlexVolumeFsType": "ntfs",
          "FlexVolumeDriver": "flexvolume",
          "DiskVolumeFsType": "xfs",
          "FlexVolumeOptions": "[nolock,tcp,noresvport]",
          "NFSVolumeServer": "0eafxxxxx-xxxxx.cn-hangzhou.nas.aliyuncs.com",
          "NFSVolumePath": "/eci",
          "Name": "test-empty",
          "EmptyDirVolumeMedium": "Memory",
          "EmptyDirVolumeSizeLimit": "256Mi"
        }
      ],
      "RamRoleName": "ram:PassRole",
      "VSwitchId": "vsw-bp1vzjjflab6wvjox****",
      "Cpu": 2,
      "ExpiredTime": "2018-08-02T15:00:00Z",
      "ResourceGroupId": "rg-8db03793gfrz****",
      "ZoneId": "cn-hangzhou-h",
      "ContainerGroupName": "test",
      "EciSecurityContext": {
        "Sysctls": [
          {
            "Value": "65536",
            "Name": "kernel.msgmax"
          }
        ]
      },
      "FailedTime": "2018-08-02T15:00:00Z",
      "ComputeCategory": "economy",
      "DnsPolicy": "None"
    }
  ]
}

    エラーコード

    HTTP ステータスコード

    エラーコード

    エラーメッセージ

    説明
    400 InvalidParameter.MismatchInstanceType The instanceId mismatch instance type.

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

    変更履歴

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