すべてのプロダクト
Search

このプロダクト

    App Streaming:ListAppInstances

    ドキュメントセンター

    App Streaming:ListAppInstances

    最終更新日:Jul 04, 2026

    デリバリーグループ内のセッションインスタンスの詳細として、インスタンス ID、インスタンスステータス、作成日時、更新日時、セッションステータス、およびプライマリネットワークインターフェイスのパブリック IP を取得します。

    今すぐお試しください

    この 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 ロールに付与する必要があります。

    アクション

    アクセスレベル

    リソースタイプ

    条件キー

    依存アクション

    appstreaming:ListAppInstances

    get

    *All Resource

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    AppInstanceGroupId

    string

    必須

    アプリインスタンスグループの ID。

    aig-4p5f8tj16yb8b****
    AppInstanceId

    string

    任意

    アプリインスタンスの ID。

    ai-azn3kmwruh1vl****
    Status

    array

    任意

    アプリインスタンスのステータスの配列。

    string

    必須

    アプリインスタンスのステータス。

    列挙値:

    • INIT :

      初期化

    • STARTING :

      起動中

    • CLOSING :

      終了中

    • CLOSED :

      終了

    • RUNNING :

      実行中

    • IDLE :

      アイドル

    • BOUND :

      バインド済み

    • UNAVAILABLE :

      利用不可

    INIT
    AppInstanceIdList

    array

    任意

    最大 100 個のアプリインスタンス ID の配列。

    string

    必須

    アプリインスタンスの ID。

    ai-azn3kmwruh1vl****
    PageSize

    integer

    任意

    1ページあたりの項目数。値は 100 を超えません。デフォルト値：20。

    20
    PageNumber

    integer

    任意

    取得する結果のページ番号。デフォルト値：1。

    1
    IncludeDeleted

    boolean

    任意

    削除済みのインスタンスに関する情報を照会するかどうかを指定します。このパラメーターを true に設定した場合、AppInstanceIdList パラメーターは必須です。それ以外の場合、パラメーターエラーを返します。

    列挙値:

    • true :

      削除済みのインスタンスを含みます。

    • false :

      削除済みのインスタンスを除外します。(デフォルト)

    true
    UserIdList

    array

    任意

    最大 100 個のユーザー ID の配列。

    string

    任意

    ユーザー ID。

    Alice

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    返されるデータ。

    RequestId

    string

    リクエスト ID。

    1CBAFFAB-B697-4049-A9B1-67E1FC5F****
    TotalCount

    integer

    エントリの総数。

    18
    PageSize

    integer

    1ページあたりのエントリ数。値は 100 を超えることはできません。

    10
    PageNumber

    integer

    現在のページ番号。

    1
    AppInstanceModels

    array<object>

    アプリインスタンスのリスト。

    array<object>

    アプリインスタンスの詳細。

    AppInstanceId

    string

    アプリインスタンスの ID。

    ai-8dl7dzchklmka****
    AppInstanceGroupId

    string

    デリバリーグループの ID。

    aig-dk8p95irqfst9****
    Status

    string

    アプリインスタンスのステータス。

    BOUND
    MainEthPublicIp

    string

    プライマリネットワークインターフェイスのパブリック IP アドレス。このパラメーターは、デリバリーグループのネットワークポリシー (StrategyType) が Mixed の場合にのみ返されます。それ以外の場合、このパラメーターは空です。

    10.13.13.211
    NetworkInterfaceIp

    string

    弾性ネットワークインタフェースの IP アドレス。

    GmtCreate

    string

    アプリインスタンスが作成された日時。

    2023-03-07T20:29:19.000+08:00
    GmtModified

    string

    アプリインスタンスが最後に変更された日時。

    2023-03-07T20:29:19.000+08:00
    SessionStatus

    string

    セッションの接続ステータス。このパラメーターは、アプリインスタンスのステータスが RUNNING の場合にのみ返されます。それ以外の場合、このパラメーターは空です。

    列挙値:

    • disconnect :

      切断済み

    • connect :

      接続済み

    connect
    BindInfo

    object

    アプリインスタンスのユーザーバインディングに関する詳細。

    EndUserId

    string

    アプリインスタンスにバインドされているエンドユーザーの ID。

    app.test
    UsageDuration

    integer

    アプリインスタンスの使用時間 (秒単位)。

    2000
    NodeId

    string

    アプリインスタンスを実行するノードの ID。

    説明

    このパラメーターは、アプリインスタンスが属するデリバリーグループがノード単位で課金される (ChargeResourceMode が Node に設定されている) 場合にのみ返されます。

    i-bp13********
    ChargeType

    string

    アプリインスタンスの課金方法。有効な値：

    • PrePaid：サブスクリプション。

    • PostPaid：従量課金。

    説明

    このパラメーターは、アプリインスタンスが属するデリバリーグループがノード単位で課金される (ChargeResourceMode が Node に設定されている) 場合にのみ返されます。

    列挙値:

    • PostPaid :

      従量課金

    • PrePaid :

      サブスクリプション

    PostPaid
    NetworkInterfaceId

    string

    弾性ネットワークインタフェースの ID。

    例

    成功レスポンス

    JSONJSON

    {
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TotalCount": 18,
  "PageSize": 10,
  "PageNumber": 1,
  "AppInstanceModels": [
    {
      "AppInstanceId": "ai-8dl7dzchklmka****",
      "AppInstanceGroupId": "aig-dk8p95irqfst9****",
      "Status": "BOUND",
      "MainEthPublicIp": "10.13.13.211",
      "NetworkInterfaceIp": "",
      "GmtCreate": "2023-03-07T20:29:19.000+08:00",
      "GmtModified": "2023-03-07T20:29:19.000+08:00",
      "SessionStatus": "connect",
      "BindInfo": {
        "EndUserId": "app.test",
        "UsageDuration": 2000
      },
      "NodeId": "i-bp13********",
      "ChargeType": "PostPaid",
      "NetworkInterfaceId": ""
    }
  ]
}

    エラーコード

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

    変更履歴

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