Queries the credential that is used to connect to App Streaming.
Operation description
You must call this operation at least twice to obtain a connection credential.
The first time you call this operation, the system assigns an application instance to the specified convenience account and then starts the application. In this case, the ID of the started task, which is indicated by TaskID, is returned.
In subsequent calls, you must configure TaskID to query whether the task is completed. If the value of TaskStatus in the response is Finished, the connection credential, which is indicated by Ticket, is returned.
Debugging
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 Resourcesis 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:GetConnectionTicket | create | *All Resources * |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| ProductType | string | Yes | The product type. Valid values:
| CloudApp |
| EndUserId | string | Yes | The ID of the convenience account. | alice |
| BizRegionId | string | No | The region ID. Note
If you configure this parameter, the system assigns application instances only among the delivery groups that reside in the specified region.
Enumeration Value:
| cn-hangzhou |
| TaskId | string | No | The task ID. Note
This parameter is required for calls other than the first call to this operation. You can use this parameter to query the task status and connection credential.
| 28778acb-a469-4bc0-8e0f**** |
| AppId | string | No | The application ID. Note
This parameter is required for the first call to this operation and optional for subsequent calls to the operation.
| ca-e4s0puhmwi7v**** |
| AppVersion | string | No | The application version. If you configure this parameter, only an application of the specified version is started. If you do not configure this parameter, an application of a random authorized version is started. | 1.0.0 |
| AppStartParam | string | No | The parameters that are configured to start the application. For information about how to obtain these parameters, see Obtain parameters configured to install and start an application. | /q /n |
| EnvironmentConfig | string | No | The environment configuration. | |
| AppInstanceGroupIdList | array | No | The delivery groups. Note
AppInstanceId or AppInstancePersistentId. | |
| string | No | The ID of the delivery group. | aig-4xz0oy8x4ipyv**** | |
| AppInstancePersistentId | string | No | The ID of the persistent session. | p-0bxls9m3cl7s**** |
| AppInstanceId | string | No | The ID of the application instance. Note
AppInstanceGroupIdList and the number of delivery groups specified by AppInstanceGroupIdList must be 1. | ai-1rznfnrvsa99d**** |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "1CBAFFAB-B697-4049-A9B1-67E1FC5F****",
"TaskStatus": "Running",
"TaskId": "f3d1b31c-605e-4d04-a896****",
"BizRegionId": "cn-hangzhou",
"Ticket": "DQpbRGVza3RvcF0NCkZvcmNlVGxzVHlwZT0xDQpHV1Rva2VuUGFydDE9MDAva09ROW1FUTU3dU****",
"AppInstanceGroupId": "aig-53fvrq1oan****",
"AppInstancePersistentId": "p-0bxls9m3cl7s****",
"AppInstanceId": "ai-7ybdeiyoeh5e****",
"OsType": "Windows",
"TenantId": 0,
"AvatarId": ""
}Error codes
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2025-11-03 | The request parameters of the API has changed | View Change Details |
| 2025-04-07 | The request parameters of the API has changed | View Change Details |
| 2023-12-22 | The request parameters of the API has changed. The response structure of the API has changed | View Change Details |
| 2023-06-29 | The response structure of the API has changed | View Change Details |
| 2023-03-20 | The internal configuration of the API is changed, but the call is not affected | View Change Details |
