すべてのプロダクト
Search

このプロダクト

    App Streaming:ListAppInstances

    ドキュメントセンター

    App Streaming:ListAppInstances

    最終更新日:Sep 17, 2026

    配信グループ内の会話インスタンスの詳細 (インスタンス ID、インスタンスステータス、作成時間、更新時間、会話ステータス、プライマリネットワークインターフェースコントローラー (NIC) のパブリック 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

    *すべてのリソース。

    *

    		 なし なし

    リクエストパラメーター

    パラメーター

    型

    必須 / 任意

    説明

    例
    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

    任意

    1 ページあたりの照会結果数。最大値: 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

    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

    プライマリネットワークインターフェースコントローラー (NIC) のパブリック IP アドレス。この値は、配信グループのネットワークポリシー (StrategyType) が混在モードパターン (Mixed) に設定されている場合にのみ返されます。それ以外の場合、この値は空です。

    10.13.13.211
    NetworkInterfaceIp

    string

    送信トラフィック NIC の非公開 IP アドレス。

    192.168.12.32
    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

    インスタンスの NIC ID。

    eni-2ze1jetnxkm***qq7i

    例

    成功レスポンス

    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": "192.168.12.32",
      "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": "eni-2ze1jetnxkm***qq7i"
    }
  ]
}

    エラーコード

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

    変更履歴

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