All Products
Search
Document Center

App Streaming:ListAppInstances

Last Updated:Dec 17, 2025

Queries the details of application instances in a delivery group, including the IDs, status, creation time, update time, session status, and public IP addresses associated with the primary NICs of the instances.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
appstreaming:ListAppInstancesget
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
AppInstanceGroupIdstringYes

The ID of the delivery group.

aig-4p5f8tj16yb8b****
AppInstanceIdstringNo

The ID of the application instance.

ai-azn3kmwruh1vl****
StatusarrayNo

The status of the application instances.

stringYes

The status of the application instance.

Valid values:

  • INIT: The application instance is being initialized.
  • STARTING: The application instance is being started.
  • CLOSING: The application instance is being stopped.
  • CLOSED: The application instance is closed.
  • RUNNING: The application instance is running.
  • idle: The application instance is idle.
  • BOUND: The application instance is bound to an application instance group.
  • UNAVAILABLE: The application instance is unavailable.
INIT
AppInstanceIdListarrayNo

The IDs of the application instances. Up to 100 IDs can be specified.

stringYes

The ID of the application instance.

ai-azn3kmwruh1vl****
PageSizeintegerNo

The number of entries per page. The value cannot be greater than 100. Default value: 20. We recommend that you specify this parameter.

20
PageNumberintegerNo

The page number. Default value: 1. We recommend that you specify this parameter.

1
IncludeDeletedbooleanNo

Specifies whether to query the information about deleted app instances. If you set this parameter to true, you must configure AppInstanceIdList. Otherwise, a parameter error is reported.

Valid values:

  • true
  • false
true
UserIdListarrayNo

The user IDs. You can specify up to 100 IDs.

stringNo

The user ID.

Alice

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

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

The total number of entries returned.

18
PageSizeinteger

The number of entries returned on each page. The value cannot be greater than 100. We recommend that you configure this parameter.

10
PageNumberinteger

The page number of the returned page. We recommend that you configure this parameter.

1
AppInstanceModelsarray<object>

The app instances.

dataobject

The app instance.

AppInstanceIdstring

The ID of the application instance.

ai-8dl7dzchklmka****
AppInstanceGroupIdstring

The ID of the delivery group.

aig-dk8p95irqfst9****
Statusstring

The status of the application instance.

BOUND
MainEthPublicIpstring

The public IP address associated with the primary NIC. This value is returned only if StrategyType is set to Mixed.

10.13.13.211
GmtCreatestring

The time when the application instance was created.

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

The time when the application instance was updated.

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

The session status. This parameter is returned only if the application instance is in the RUNNING state.

Valid values:

  • disconnect: disconnected
  • connect: connected
connect
BindInfoobject

The information about the binding between the application instance and end users.

EndUserIdstring

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

app.test
UsageDurationlong

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

2000
NodeIdstring

The ID of the node on which the app instance runs.

Note This parameter is returned only if the ChargeResourceMode parameter of the delivery group to which the app instance belongs is set to Node.
i-bp13********
ChargeTypestring

The billing method of the app instance. Valid values:

  • PrePaid: subscription.
  • PostPaid: pay-as-you-go
Note This parameter is returned only if the ChargeResourceMode parameter of the delivery group to which the app instance belongs is set to Node.
PostPaid

Examples

Sample success responses

JSONformat

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

Error codes

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

Change history

Change timeSummary of changesOperation
2025-12-04The response structure of the API has changedView Change Details
2025-03-12The response structure of the API has changedView Change Details
2025-02-21The request parameters of the API has changedView Change Details
2025-02-18The response structure of the API has changedView Change Details
2023-05-09The request parameters of the API has changed. The response structure of the API has changedView Change Details