BatchGetAcpConnectionTicket - Cloud Phone - Alibaba Cloud Documentation Center

Retrieves connection tickets in batch. This operation generates connection tickets asynchronously. In most cases, the tickets are returned directly in the response of the first call. However, in some situations, the initial response will contain a TaskId. You must then poll this endpoint with the TaskId until the generation is complete and the tickets are returned.

Operation description

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
InstanceGroupId	string	No	The ID of the instance group.	ag-25nt4kk9whjh****
InstanceIds	array	No	The IDs of the cloud phone instances. You can specify 1 to 100 IDs of cloud phone instances.
	string	No	The ID of the cloud phone instance.	acp-bj9t2gmys****
EndUserId	string	No	The ID of the user to whom the cloud phone instance is assigned.	user
InstanceTasks	array<object>	No	The instance connection task, which is used to query whether the ticket retrieval task is completed.
	object	No	The instance connection task.
InstanceId	string	No	The ID of the cloud phone instance.	acp-fkuit0cmyfvzz****
TaskId	string	No	The ID of the task.	cn-hangzhou@c9f5c2e8-f5c4-4b01-8602-000cae94****

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The ID of the request.	7B9EFA4F-4305-5968-BAEE-BD8B8DE5****
InstanceConnectionModels	array<object>	The results of the instance connection tasks.
	object	The result of the instance connection task.
AppInstanceGroupId	string	The ID of the delivery group.	aig-1uzb6heg797z3****
InstanceId	string	The ID of the cloud phone instance.	acp-ajxvwo1u0hqvd****
TaskStatus	string	The state of the task. If FINISHED is returned, it indicates that a value can be retrieved from the Ticket field. If the returned value is not FINISHED, you still need to use this operation to query the Ticket generation result by using TaskId.	FINISHED
TaskId	string	The ID of the task.	cn-hangzhou@c9f5c2e8-f5c4-4b01-8602-000cae94****
Ticket	string	The ticket used to connect to the cloud phone instance.	piVE58_AdmVSVW7SEW3AE5p8mmO5gvItsNOmv4S_f_cNpoU_BOTwChTBoNM1ZJeedfK9zxYnbN5hossqIZCr6t7SGxRigm2Cb4fGaCdBZWIzmgdHq6sXXZQg4KFWufyvpeV0Cm58slMT1tJw3****
ErrorCode	string		InvalidResourceId.NotFound
PersistentAppInstanceId	string		p-abdywvcksdb****
AppInstanceId	string		ai-0caoetkqi8kj****

Examples

Success response

JSON format

{
  "RequestId": "7B9EFA4F-4305-5968-BAEE-BD8B8DE5****",
  "InstanceConnectionModels": [
    {
      "AppInstanceGroupId": "aig-1uzb6heg797z3****",
      "InstanceId": "acp-ajxvwo1u0hqvd****",
      "TaskStatus": "FINISHED",
      "TaskId": "cn-hangzhou@c9f5c2e8-f5c4-4b01-8602-000cae94****",
      "Ticket": "piVE58_AdmVSVW7SEW3*AE5*p8mmO5gvItsNOmv4S_f_cNpoU_BOTwChTBoNM1ZJeedfK9zxYnbN5hossqIZCr6t7SGxRigm2Cb4fGaCdBZWIzmgdHq6sXXZQg4KFWufyvpeV*0*Cm58slMT1tJw3****",
      "ErrorCode": "InvalidResourceId.NotFound",
      "PersistentAppInstanceId": "p-abdywvcksdb****",
      "AppInstanceId": "ai-0caoetkqi8kj****"
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.