ListPersistentAppInstances - App Streaming - Alibaba Cloud Documentation Center

Queries app instances of the persistent session type in a delivery group.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
appstreaming:ListPersistentAppInstances	get	All Resources ``	none	none

Request parameters

Parameter	Type	Required	Description	Example
ProductType	string	Yes	The product type. Valid values: CloudApp: App Streaming CloudBrowser: Cloud-based Browser AndroidCloud: Cloud Phone	CloudApp
AppInstanceGroupId	string	Yes	The ID of the delivery group.	aig-0bxls9m9arax6****
AppInstancePersistentIds	array	No	The IDs of the persistent sessions.
	string	Yes	The ID of the persistent session.	p-0cc7s3mw2fg4j****
PageSize	integer	No	The number of entries per page. The value cannot be greater than 100. Default value: 20.	20
PageNumber	integer	No	The page number. Pages start from page 1. Default value: 1.	1

Response parameters

Parameter	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	1CBAFFAB-B697-4049-A9B1-67E1FC5F****
TotalCount	integer	The total number of entries returned.	15
PageSize	integer	The number of entries per page.	20
PageNumber	integer	The page number.	1
PersistentAppInstanceModels	array<object>	The app instances of the persistent session type.
data	object	The app instance of the persistent session type.
AppInstancePersistentId	string	The ID of the app instance of the persistent session type.	p-0cc7s3mw2fg4j****
AppInstancePersistentName	string	The name of the app instance of the persistent session type.	test-persistent-name
AppInstancePersistentStatus	string	The status of the app instance of the persistent session type. Valid values: STARTING RUNNING STOPPED UNAVAILABLE DELETING PENDING STOPPING DELETED REBUILDING	RUNNING
AppInstanceGroupId	string	The ID of the delivery group.	aig-0bxls9m9arax6****
AppInstanceId	string	The ID of the app instance.	ai-azn3kmwruh1vl****
AppInstanceStatus	string	The status of the app instance. Valid values: INIT: The app instance is being initialized. STARTING: The app instance is being started. CLOSING: The app instance is being stopped. CLOSED: The app instance is closed. RUNNING: The app instance is running. idle: The app instance is idle. BOUND: The app instance is bound to an app instance group. UNAVAILABLE: The app instance is unavailable. DELETED: The app instance is deleted.	RUNNING
GmtCreate	string	The time when the app instance was created.	2025-03-13T03:22:18.000+00:00
AuthorizedUsers	array	The authorized users.
authorizedUsers	string	The name of the authorized user.	user-001

Examples

Sample success responses

JSONformat

{
  "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

For a list of error codes, visit the Service error codes.