All Products
Search
Document Center

App Streaming:GetConnectionTicket

Last Updated:Dec 17, 2025

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

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:GetConnectionTicketcreate
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ProductTypestringYes

The product type.

Valid values:

  • CloudApp: App Streaming
  • AndroidCloud: Cloud Phone
CloudApp
EndUserIdstringYes

The ID of the convenience account.

alice
BizRegionIdstringNo

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-shenzhen: cn-shenzhen.
  • cn-beijing: cn-beijing.
  • cn-shanghai: cn-shanghai.
  • cn-zhangjiakou: cn-zhangjiakou.
  • cn-hangzhou: cn-hangzhou.
cn-hangzhou
TaskIdstringNo

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****
AppIdstringNo

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****
AppVersionstringNo

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
AppStartParamstringNo

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
EnvironmentConfigstringNo

The environment configuration.

AppInstanceGroupIdListarrayNo

The delivery groups.

Note
  • If you configure this parameter, the system assigns application instances only among the specified authorized delivery groups.
  • This parameter is required if you configure AppInstanceId or AppInstancePersistentId.
  • stringNo

    The ID of the delivery group.

    aig-4xz0oy8x4ipyv****
    AppInstancePersistentIdstringNo

    The ID of the persistent session.

    p-0bxls9m3cl7s****
    AppInstanceIdstringNo

    The ID of the application instance.

    Note
  • If you configure this parameter, the system attempts to assign only the specified application instance.
  • If you configure this parameter, you must also configure AppInstanceGroupIdList and the number of delivery groups specified by AppInstanceGroupIdList must be 1.
  • ai-1rznfnrvsa99d****

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    RequestIdstring

    The request ID.

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

    The task status.

    Valid values:

    • Finished: The task is complete.
    • Failed: The task failed.
    • Running: The task is being executed.
    Running
    TaskIdstring

    The task ID.

    f3d1b31c-605e-4d04-a896****
    BizRegionIdstring

    The region ID.

    cn-hangzhou
    Ticketstring

    The credential that is used to connect to App Streaming.

    Note This parameter is displayed for calls other than the first call to this operation.
    DQpbRGVza3RvcF0NCkZvcmNlVGxzVHlwZT0xDQpHV1Rva2VuUGFydDE9MDAva09ROW1FUTU3dU****
    AppInstanceGroupIdstring

    The ID of the delivery group.

    aig-53fvrq1oan****
    AppInstancePersistentIdstring

    The ID of the persistent session.

    p-0bxls9m3cl7s****
    AppInstanceIdstring

    The ID of the application instance.

    ai-7ybdeiyoeh5e****
    OsTypestring

    The operating system.

    Valid value:

    • Windows: the Windows operating system
    Windows
    TenantIdlong

    The ID of the Alibaba Cloud account.

    148871678899****
    AvatarIdstring

    The avatar ID.

    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 timeSummary of changesOperation
    2025-11-03The request parameters of the API has changedView Change Details
    2025-04-07The request parameters of the API has changedView Change Details
    2023-12-22The request parameters of the API has changed. The response structure of the API has changedView Change Details
    2023-06-29The response structure of the API has changedView Change Details
    2023-03-20The internal configuration of the API is changed, but the call is not affectedView Change Details