批量擷取串連憑證。本介面會非同步進行 Ticket 的產生,絕大多數可第一次直接從Response中直接拿到Ticket,部分情況需要根據Response中的TaskId再調用本介面進行輪詢是否產生。
介面說明
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
請求參數
|
名稱 |
類型 |
必填 |
描述 |
樣本值 |
| InstanceGroupId |
string |
否 |
執行個體組 ID。 |
ag-25nt4kk9whjh**** |
| InstanceIds |
array |
否 |
雲手機執行個體 ID 列表,可設定 1~100 個。 |
|
|
string |
否 |
執行個體 ID。 |
acp-bj9t2gmys**** |
|
| EndUserId |
string |
否 |
已指派的使用者識別碼,如果不傳,則會使用後台分配的系統使用者擷取 Ticket。 |
user |
| ConnectionMode |
string |
否 |
建連模式。 |
custom |
| 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**** |
| Port |
integer |
建連連接埠 |
10000 |
樣本
正常返回樣本
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****",
"Port": 10000
}
]
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。