All Products
Search

This Product

    App Streaming:ListAppInstances

    Document Center

    App Streaming:ListAppInstances

    Last Updated:Jun 17, 2026

    Queries the details of session instances in a delivery group, including instance IDs, instance statuses, creation time, update time, session statuses, and public IP addresses of primary network interfaces.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    appstreaming:ListAppInstances

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    AppInstanceGroupId

    string

    Yes

    The delivery group ID.

    aig-4p5f8tj16yb8b****
    AppInstanceId

    string

    No

    The application instance ID.

    ai-azn3kmwruh1vl****
    Status

    array

    No

    The list of application instance statuses.

    string

    Yes

    The application instance status.

    Valid values:

    • INIT :

      初始化

    • STARTING :

      应用启动中

    • CLOSING :

      应用停止中

    • CLOSED :

      应用已关闭

    • RUNNING :

      应用运行中

    • IDLE :

      空闲

    • BOUND :

      已绑定

    • UNAVAILABLE :

      不可用

    INIT
    AppInstanceIdList

    array

    No

    The list of application instance IDs. A maximum of 100 IDs can be specified.

    string

    Yes

    The application instance ID.

    ai-azn3kmwruh1vl****
    PageSize

    integer

    No

    The number of query results per page. Maximum value: 100. Default value: 20. Specify this parameter.

    20
    PageNumber

    integer

    No

    The page number of the query results to display. Default value: 1. Specify this parameter.

    1
    IncludeDeleted

    boolean

    No

    Specifies whether to query information about deleted instances. If this parameter is set to true, the AppInstanceIdList parameter is required. Otherwise, a parameter error is returned.

    Valid values:

    • true :

      queries deleted instances.

    • false :

      does not query deleted instances (default).

    true
    UserIdList

    array

    No

    The list of user IDs. A maximum of 100 IDs can be specified.

    string

    No

    The user ID.

    Alice

    Response elements

    Element

    Type

    Description

    Example

    object

    The response parameters.

    RequestId

    string

    The request ID.

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

    integer

    The total number of query results.

    18
    PageSize

    integer

    The number of query results per page. Maximum value: 100. Specify this parameter.

    10
    PageNumber

    integer

    The page number of the query results to display. Specify this parameter.

    1
    AppInstanceModels

    array<object>

    The list of queried application instances.

    array<object>

    The queried application instance.

    AppInstanceId

    string

    The application instance ID.

    ai-8dl7dzchklmka****
    AppInstanceGroupId

    string

    The delivery group ID.

    aig-dk8p95irqfst9****
    Status

    string

    The application instance status.

    BOUND
    MainEthPublicIp

    string

    The public IP address of the primary network interface controller (NIC). This value is returned only when the network policy (StrategyType) of the delivery group is set to mixed mode pattern (Mixed). Otherwise, this value is empty.

    10.13.13.211
    NetworkInterfaceIp

    string

    GmtCreate

    string

    The creation time.

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

    string

    The update time.

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

    string

    The session connection status. This value is returned only when the instance status is running (RUNNING). Otherwise, this value is empty.

    Valid values:

    • disconnect :

      disconnected.

    • connect :

      connected.

    connect
    BindInfo

    object

    The binding information between the instance and the user.

    EndUserId

    string

    The ID of the end user that is bound to the application instance.

    app.test
    UsageDuration

    integer

    The use duration of the application instance. Unit: seconds.

    2000
    NodeId

    string

    The ID of the node on which the instance runs.

    Note

    This parameter is returned only when the billing mode of the delivery group to which the instance belongs is set to resource-based billing (ChargeResourceMode=Node).

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

    string

    The billing method of the instance. Valid values:

    • PrePaid: subscription.

    • PostPaid: pay-as-you-go.

    Note

    This parameter is returned only when the billing mode of the delivery group to which the instance belongs is set to resource-based billing (ChargeResourceMode=Node).

    Valid values:

    • PostPaid :

      Pay-as-you-go.

    • PrePaid :

      Subscription.

    PostPaid
    NetworkInterfaceId

    string

    Examples

    Success response

    JSON format

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

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.