All Products
Search

This Product

    App Streaming:ListAppInstances

    Document Center

    App Streaming:ListAppInstances

    Last Updated:Jul 04, 2026

    Retrieves details for session instances in a delivery group, including the instance ID, instance status, creation time, update time, session status, and the public IP of the primary network interface.

    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 ID of the app instance group.

    aig-4p5f8tj16yb8b****
    AppInstanceId

    string

    No

    The ID of the app instance.

    ai-azn3kmwruh1vl****
    Status

    array

    No

    An array of app instance statuses.

    string

    Yes

    The status of the app instance.

    Valid values:

    • INIT :

      initialization

    • STARTING :

      starting

    • CLOSING :

      closing

    • CLOSED :

      closed

    • RUNNING :

      running

    • IDLE :

      idle

    • BOUND :

      bound

    • UNAVAILABLE :

      unavailable

    INIT
    AppInstanceIdList

    array

    No

    An array of up to 100 app instance IDs.

    string

    Yes

    The ID of the app instance.

    ai-azn3kmwruh1vl****
    PageSize

    integer

    No

    The number of entries to return on each page. The value cannot exceed 100. Default value: 20.

    20
    PageNumber

    integer

    No

    The page number of the results to return. Default value: 1.

    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 :

      Includes deleted instances.

    • false :

      Excludes deleted instances. (Default)

    true
    UserIdList

    array

    No

    An array of up to 100 user IDs.

    string

    No

    The user ID.

    Alice

    Response elements

    Element

    Type

    Description

    Example

    object

    The data returned.

    RequestId

    string

    The request ID.

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

    integer

    The total number of entries.

    18
    PageSize

    integer

    The number of entries per page. The value cannot exceed 100.

    10
    PageNumber

    integer

    The current page number.

    1
    AppInstanceModels

    array<object>

    A list of app instances.

    array<object>

    Details of an app instance.

    AppInstanceId

    string

    The ID of the app instance.

    ai-8dl7dzchklmka****
    AppInstanceGroupId

    string

    The ID of the delivery group.

    aig-dk8p95irqfst9****
    Status

    string

    The status of the app instance.

    BOUND
    MainEthPublicIp

    string

    The public IP address of the primary network interface. This parameter is returned only if the network policy (StrategyType) of the delivery group is Mixed. Otherwise, this parameter is empty.

    10.13.13.211
    NetworkInterfaceIp

    string

    The IP address of the elastic network interface.

    GmtCreate

    string

    The time when the app instance was created.

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

    string

    The time when the app instance was last modified.

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

    string

    The connection status of the session. This parameter is returned only if the status of the app instance is RUNNING. Otherwise, this parameter is empty.

    Valid values:

    • disconnect :

      Disconnected

    • connect :

      Connected

    connect
    BindInfo

    object

    Details about the user binding for the app instance.

    EndUserId

    string

    The ID of the end user bound to the app instance.

    app.test
    UsageDuration

    integer

    The usage duration of the app instance, in seconds.

    2000
    NodeId

    string

    The ID of the node that runs the app instance.

    Note

    This parameter is returned only when the delivery group to which the app instance belongs is billed by node (ChargeResourceMode is set to Node).

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

    string

    The billing method of the app instance. Valid values:

    • PrePaid: subscription.

    • PostPaid: pay-as-you-go.

    Note

    This parameter is returned only when the delivery group to which the app instance belongs is billed by node (ChargeResourceMode is set to Node).

    Valid values:

    • PostPaid :

      pay-as-you-go

    • PrePaid :

      subscription

    PostPaid
    NetworkInterfaceId

    string

    The ID of the elastic network interface.

    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.