All Products
Search

This Product

    App Streaming:ListPersistentAppInstances

    Document Center

    App Streaming:ListPersistentAppInstances

    Last Updated:Jun 17, 2026

    Queries the list of persistent session application instances in a delivery group.

    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:ListPersistentAppInstances

    get

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ProductType

    string

    Yes

    The product type.

    Valid values:

    • CloudApp :

      cloud application.

    • CloudBrowser :

      cloud browser.

    • AndroidCloud :

      cloud phone.

    CloudApp
    AppInstanceGroupId

    string

    Yes

    The delivery group ID.

    aig-0bxls9m9arax6****
    AppInstancePersistentIds

    array

    No

    The list of persistent session IDs.

    string

    Yes

    The persistent session ID.

    p-0cc7s3mw2fg4j****
    PageSize

    integer

    No

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

    20
    PageNumber

    integer

    No

    The page number of the query results to display. Minimum value: 1. Default value: 1.

    1

    Response elements

    Element

    Type

    Description

    Example

    object

    The response body.

    RequestId

    string

    The request ID.

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

    integer

    The total number of query results.

    15
    PageSize

    integer

    The number of query results per page.

    20
    PageNumber

    integer

    The page number of the query results currently displayed.

    1
    PersistentAppInstanceModels

    array<object>

    The list of persistent session application instances.

    object

    The persistent session application instance information.

    AppInstancePersistentId

    string

    The persistent session ID.

    p-0cc7s3mw2fg4j****
    AppInstancePersistentName

    string

    The name of the persistent session application instance.

    test-persistent-name
    AppInstancePersistentStatus

    string

    The instance status of the persistent session application.

    Valid values:

    • STARTING :

      starting.

    • RUNNING :

      running.

    • STOPPED :

      stopped.

    • UNAVAILABLE :

      unavailable.

    • DELETING :

      deleting.

    • PENDING :

      creating.

    • STOPPING :

      stopping.

    • DELETED :

      deleted.

    • REBUILDING :

      resetting.

    RUNNING
    AppInstanceGroupId

    string

    The delivery group ID.

    aig-0bxls9m9arax6****
    AppInstanceId

    string

    The application instance ID.

    ai-azn3kmwruh1vl****
    AppInstanceStatus

    string

    The application instance status.

    Valid values:

    • INIT :

      initializing.

    • STARTING :

      application starting.

    • CLOSING :

      application stopping.

    • CLOSED :

      application closed.

    • RUNNING :

      application running.

    • IDLE :

      idle.

    • BOUND :

      bound.

    • UNAVAILABLE :

      unavailable.

    • DELETED :

      deleted.

    RUNNING
    GmtCreate

    string

    The creation time.

    2025-03-13T03:22:18.000+00:00
    AuthorizedUsers

    array

    The list of authorized usernames.

    string

    The authorized username.

    user-001

    Examples

    Success response

    JSON format

    {
  "RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
  "TotalCount": 15,
  "PageSize": 20,
  "PageNumber": 1,
  "PersistentAppInstanceModels": [
    {
      "AppInstancePersistentId": "p-0cc7s3mw2fg4j****",
      "AppInstancePersistentName": "test-persistent-name",
      "AppInstancePersistentStatus": "RUNNING",
      "AppInstanceGroupId": "aig-0bxls9m9arax6****",
      "AppInstanceId": "ai-azn3kmwruh1vl****",
      "AppInstanceStatus": "RUNNING",
      "GmtCreate": "2025-03-13T03:22:18.000+00:00",
      "AuthorizedUsers": [
        "user-001"
      ]
    }
  ]
}

    Error codes

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.