All Products
Search

This Product

    App Streaming:GetConnectionTicket

    Document Center

    App Streaming:GetConnectionTicket

    Last Updated:Jul 04, 2026

    Retrieves a connection credential for a cloud application.

    Operation description

    To obtain a ticket, you must call this operation at least twice.

    The first call allocates an application instance to the specified convenience account and starts the application. The response includes a TaskID.

    In subsequent calls, include the TaskID in your request to query the task status. When TaskStatus is Finished, the response will include the Ticket.

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

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    ProductType

    string

    Yes

    The product type.

    Valid values:

    • CloudApp :

      cloud app

    • AndroidCloud :

      Android cloud

    CloudApp
    EndUserId

    string

    Yes

    The ID of the end user.

    alice
    BizRegionId

    string

    No

    The region ID.

    Note

    If you specify this parameter, an application instance is allocated only from delivery groups in the specified region.

    Valid values:

    • cn-shenzhen :

      cn-shenzhen

    • cn-beijing :

      cn-beijing

    • cn-shanghai :

      cn-shanghai

    • cn-zhangjiakou :

      cn-zhangjiakou

    • cn-hangzhou :

      cn-hangzhou

    cn-hangzhou
    TaskId

    string

    No

    The task ID.

    Note

    Required for subsequent calls to query the task status and retrieve the connection ticket.

    28778acb-a469-4bc0-8e0f****
    AppId

    string

    No

    The application ID.

    Note

    Required for the initial call. Optional for subsequent calls.

    ca-e4s0puhmwi7v****
    AppVersion

    string

    No

    The version of the application to start. If you omit this parameter, the system starts any authorized version.

    1.0.0
    AppStartParam

    string

    No

    The application startup parameter. For more information, see How to obtain application installation and startup parameters.

    /q /n
    EnvironmentConfig

    string

    No

    The environment configuration.

    AppInstanceGroupIdList

    array

    No

    A list of delivery group IDs.

    Note

    • If specified, an application instance is allocated only from the authorized delivery groups in this list.

    • This parameter is required if you specify the AppInstanceId or AppInstancePersistentId parameter.

    string

    No

    The delivery group ID.

    aig-4xz0oy8x4ipyv****
    AppInstancePersistentId

    string

    No

    The persistent session ID.

    p-0bxls9m3cl7s****
    AppInstanceId

    string

    No

    The application instance ID.

    Note

    • If you specify this parameter, the system attempts to allocate only the specified application instance.

    • If you specify this parameter, you must also provide an AppInstanceGroupIdList containing exactly one delivery group ID.

    ai-1rznfnrvsa99d****
    AccessType

    string

    No

    The access type. If you omit this parameter, details for both access types are returned. Valid values: INTERNET and VPC.

    INTERNET
    AppPolicyId

    string

    No

    Response elements

    Element

    Type

    Description

    Example

    object

    The response data.

    RequestId

    string

    The request ID.

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

    string

    The task status.

    Valid values:

    • Finished :

      The task is complete.

    • Failed :

      The task failed.

    • Running :

      The task is running.

    Running
    TaskId

    string

    The task ID.

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

    string

    The region ID.

    cn-hangzhou
    Ticket

    string

    The ticket to connect to the cloud application.

    Note

    This parameter is returned only for subsequent calls.

    DQpbRGVza3RvcF0NCkZvcmNlVGxzVHlwZT0xDQpHV1Rva2VuUGFydDE9MDAva09ROW1FUTU3dU****
    AppInstanceGroupId

    string

    The delivery group ID.

    aig-53fvrq1oan****
    AppInstancePersistentId

    string

    The persistent session ID.

    p-0bxls9m3cl7s****
    AppInstanceId

    string

    The application instance ID.

    ai-7ybdeiyoeh5e****
    OsType

    string

    The operating system type.

    Valid values:

    • Windows :

      The operating system is Windows.

    Windows
    TenantId

    integer

    The tenant ID (Alibaba Cloud account ID).

    148871678899****
    AvatarId

    string

    The avatar ID.

    Examples

    Success response

    JSON format

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

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.