功能介紹
在 云手機(jī) 中同步執(zhí)行命令并返回命令執(zhí)行的輸出信息，該接口僅支持adb shell命令的執(zhí)行。1分鐘內(nèi)每個用戶調(diào)用接口次數(shù)上限為6次，每個云手機(jī)允許執(zhí)行命令超時時間為2秒，接口時間不超過30秒，執(zhí)行云手機(jī)數(shù)越多，接口耗時相應(yīng)越長。
調(diào)試
您可以在API Explorer中調(diào)試該接口，支持自動認(rèn)證鑒權(quán)。API Explorer可以自動生成SDK代碼示例，并提供SDK代碼示例調(diào)試功能。
URI
POST /v1/{project_id}/cloud-phone/phones/sync-commands
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
項(xiàng)目id。 |
請求參數(shù)
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
用戶Token。 通過調(diào)用 IAM 服務(wù)獲取用戶Token接口獲取（響應(yīng)消息頭中X-Subject-Token的值）。 |
|
參數(shù) |
是否必選 |
參數(shù)類型 |
描述 |
|---|---|---|---|
|
command |
是 |
String |
ADB命令，固定填寫shell。 |
|
content |
是 |
String |
待執(zhí)行的命令。 最大長度為1024字節(jié)，只支持大小寫字母、數(shù)字、下劃線（_）、點(diǎn)（.）、斜線（/）、冒號（:）、中劃線（-）。 |
|
phone_ids |
否 |
Array of strings |
云手機(jī)ID列表。 server_ids參數(shù)不存在時必選，同時存在只處理phone_ids。 |
|
server_ids |
否 |
Array of strings |
云手機(jī)服務(wù)器ID列表。 phone_ids參數(shù)不存在時必選，同時存在只處理phone_ids。 |
響應(yīng)參數(shù)
狀態(tài)碼： 200
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
request_id |
String |
請求的唯一標(biāo)識ID。 |
|
jobs |
任務(wù)列表。 |
|
參數(shù) |
參數(shù)類型 |
描述 |
|---|---|---|
|
phone_id |
String |
云手機(jī)的唯一標(biāo)識，云手機(jī)相關(guān)任務(wù)包含此字段。 |
|
job_id |
String |
任務(wù)的唯一標(biāo)識。 |
|
status |
Integer |
任務(wù)狀態(tài)
|
|
error_code |
String |
任務(wù)錯誤碼。 |
|
error_msg |
String |
任務(wù)錯誤碼說明。 |
|
execute_msg |
String |
任務(wù)執(zhí)行返回內(nèi)容，最長1024字節(jié)。 |
請求示例
向手機(jī)列表中的手機(jī)同步執(zhí)行shell命令，命令為ls -l /system
POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/sync-commands
{
"command" : "shell",
"content" : "ls -l /system",
"phone_ids" : [ "1234567b8bab40ffb711234cb80d0234", "1678567b8bab40f93711234cb80d0764" ]
}
響應(yīng)示例
狀態(tài)碼： 200
OK
{
"request_id" : "6837531fd3f54550927b930180a706bf",
"jobs" : [ {
"phone_id" : "1234567b8bab40ffb711234cb80d0234",
"job_id" : "3fc17538866a4ff3a014d8bc6aaa4b69",
"status" : -1,
"error_code" : "CPS.0191",
"error_msg" : "Run command failed.",
"execute_msg" : "ls: cannot access '/system': No such file or directory"
}, {
"phone_id" : "1678567b8bab40f93711234cb80d0764",
"job_id" : "1564567b8bab40f34711234cb80d5678",
"status" : 2,
"error_code" : "",
"error_msg" : "",
"execute_msg" : "xxxxx"
} ]
}
狀態(tài)碼
|
狀態(tài)碼 |
描述 |
|---|---|
|
200 |
OK |
錯誤碼
請參見錯誤碼。
