批量获取连接凭证。本接口会异步进行Ticket的生成,绝大多数可第一次直接从Response中直接拿到Ticket,部分情况需要根据Response中的TaskId再调用本接口进行轮询是否生成。
接口说明
本接口的作用因云手机产品版本和实例串流模式而异:
云手机实例版或云手机矩阵版(抢占模式):只能通过同一个
EnduserId
获取Ticket
。云手机矩阵版(协同模式):可通过传入不同的
EnduserId
来为不同的用户(至多 5 个)同时获取Ticket
并串流。每次只能传入 1 个EnduserId
。
实例串流模式可通过 ModifyCloudPhoneNode 接口的StreamMode
参数来定义。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
InstanceGroupId |
string |
否 |
实例组 ID。 |
ag-25nt4kk9whjh**** |
InstanceIds |
array |
否 |
云手机实例 ID 列表,可设置 1~100 个。 |
|
string |
否 |
实例 ID。 |
acp-bj9t2gmys**** |
|
EndUserId |
string |
否 |
已分配的用户 ID,如果不传,则会使用后台分配的系统用户获取 Ticket。 本参数的使用方法因云手机产品版本和实例串流模式而异:
说明
实例串流模式可通过 |
user |
InstanceTasks |
array<object> |
否 |
实例连接任务。用于查询 Ticket 获取任务是否完成。 |
|
object |
否 |
实例连接任务。 |
||
InstanceId |
string |
否 |
实例 ID。 |
acp-fkuit0cmyfvzz**** |
TaskId |
string |
否 |
任务 ID。 |
cn-hangzhou@c9f5c2e8-f5c4-4b01-8602-000cae94**** |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
Schema of Response |
||
RequestId |
string |
请求 ID。 |
7B9EFA4F-4305-5968-BAEE-BD8B8DE5**** |
InstanceConnectionModels |
array<object> |
实例连接任务结果。 |
|
object |
实例连接任务结果。 |
||
AppInstanceGroupId |
string |
交付组 ID。 |
aig-1uzb6heg797z3**** |
InstanceId |
string |
实例 ID。 |
acp-ajxvwo1u0hqvd**** |
TaskStatus |
string |
任务状态。状态为 FINISHED 代表可以从 Ticket 字段获取到 Ticket,否则仍需要使用 TaskId 调用本接口查询 Ticket 生成结果。 |
FINISHED |
TaskId |
string |
任务 ID。 |
cn-hangzhou@c9f5c2e8-f5c4-4b01-8602-000cae94**** |
Ticket |
string |
用于连接用户实例的 Ticket。 |
piVE58_AdmVSVW7SEW3*AE5*p8mmO5gvItsNOmv4S_f_cNpoU_BOTwChTBoNM1ZJeedfK9zxYnbN5hossqIZCr6t7SGxRigm2Cb4fGaCdBZWIzmgdHq6sXXZQg4KFWufyvpeV*0*Cm58slMT1tJw3**** |
ErrorCode |
string |
错误原因。 |
InvalidResourceId.NotFound |
PersistentAppInstanceId |
string |
持久会话 ID。 |
p-abdywvcksdb**** |
AppInstanceId |
string |
物理实例 ID。 |
ai-0caoetkqi8kj**** |
示例
正常返回示例
JSON
格式
{
"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****"
}
]
}
错误码
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。