すべてのプロダクト
Search

このプロダクト

    App Streaming:ListAppInstances

    ドキュメントセンター

    App Streaming:ListAppInstances

    最終更新日:Jul 21, 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

    任意

    アプリケーションインスタンス ID のリスト。最大長: 100。

    string

    必須

    アプリケーションインスタンスの ID。

    ai-azn3kmwruh1vl****
    PageSize

    integer

    任意

    ページあたりのクエリ結果の数。最大値: 100。デフォルト値: 20。このパラメーターを指定してください。

    20
    PageNumber

    integer

    任意

    表示するクエリ結果のページ番号。デフォルト値: 1。このパラメーターを指定してください。

    1
    IncludeDeleted

    boolean

    任意

    削除されたインスタンスに関する情報をクエリするかどうかを指定します。このパラメーターが true にセットされている場合、AppInstanceIdList パラメーターは必須です。それ以外の場合、パラメーターエラーが返されます。

    列挙値:

    • true :

      削除されたインスタンスを照会します。

    • false :

      削除されたインスタンスをクエリしません (デフォルト)

    true。
    UserIdList

    array

    任意

    ユーザー ID のリスト。最大長: 100。

    string

    任意

    ユーザー ID。

    Alice。

    レスポンスフィールド

    フィールド

    型

    説明

    例

    object

    応答パラメーター。

    RequestId

    string

    リクエスト ID。

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

    integer

    クエリ結果の総数。

    18
    PageSize

    integer

    ページあたりのクエリ結果の数。最大値: 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

    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

    例

    成功レスポンス

    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": ""
    }
  ]
}

    エラーコード

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

    変更履歴

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