You need to enable JavaScript to run this app.
文档中心
云手机

云手机

复制全文
下载 pdf
云手机操控
异步执行命令 RunCommand
复制全文
下载 pdf
异步执行命令 RunCommand
在一个或多个云手机实例中执行命令(异步任务)。命令执行的结果通过回调返回,详细信息,参考 回调服务接入指南。​
该接口适用于执行时间大于 5s 的命令,小于 5s 的命令建议使用同步执行命令 同步执行命令 RunSyncCommand 接口。​
注意事项​
本接口的单用户 QPS 限制为 50 次/秒、单实例 QPS 限制为 10 次/秒。超过限制,API 调用会被限流。​
请求说明​
  • 请求方式:POST​
  • 请求地址:https://open.volcengineapi.com?Action=RunCommand&Version=2025-05-01​
请求参数​
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见 公共参数。​
Query​
​
参数​
类型​
是否必选​
示例值​
描述​
Action​
String​
是​
RunCommand​
接口名称。当前 API 的名称为 RunCommand。​
Version​
String​
是​
2025-05-01​
接口版本。当前 API 的版本为 2025-05-01。​
​
Body​
​
参数​
类型​
是否必选​
示例值​
描述​
ProductId​
String​
是​
1608456935646xxxxxx​
实例所归属的业务 ID,可在「云手机控制台-业务管理-业务详情」中获取。​
PodIdList​
Array of String​
是​
["7299381659819xxxxxx", "7297074858797xxxxxx"]​
实例 ID 列表,对多个实例批量执行命令操作时,支持的最大实例数量为 100。​
Command​
String​
是​
ls​
希望执行的命令。请注意直接传入命令本身,无需添加任何命令行前缀(如 “adb shell”,参考示例值格式)。支持的最大长度为 1024 字节。​
PermissionType​
String​
否​
root​
权限类型。​
TimeoutSeconds​
Integer​
否​
300​
异步命令执行的超时时长,单位为 s,默认值为 300,取值范围为 [0,21600]。​
​
返回参数​
下表仅列出本接口特有的返回参数。更多信息请参见 返回结构。​
​
参数​
类型​
示例值​
描述​
TaskId​
String​
7301280763734xxxxxx​
执行命令任务 ID,可用于通过 GetTaskInfo接口查看任务执行状态及结果。​
TaskAction​
String​
RunCommand​
任务类型,默认为对应接口 Action 名称,此处为 RunCommand。​
Jobs​
Array of Job​
-​
子任务列表,参考 Job数据格式。​
​
Job​
​
参数​
类型​
示例值​
描述​
JobId​
String​
job-7294170061873******-7294157141458******​
子任务 ID,每个子任务 ID 对应一个实例。​
PodId​
String​
7294157141458******​
实例 ID。​
Status​
Integer​
100​
子任务执行状态。取值如下:​
  • -2:部分失败​
  • -1:全部失败​
  • 10:执行中​
  • 100:成功​
JobAction​
String​
RunCommand​
子任务类型。​
​
请求示例​
​
POST https://open.volcengineapi.com?Action=RunCommand&Version=2025-05-01​
{​
"ProductId": "1608456935646xxxxxx",​
"PodIdList": [​
"7299381659819xxxxxx",​
"7297074858797xxxxxx"​
],​
"Command": "ls",​
"PermissionType": "root",​
"TimeoutSeconds": 300​
}​
​
返回示例​
​
{​
"ResponseMetadata": {​
"Action": "RunCommand",​
"Region": "cn-north-1",​
"Service": "ACEP",​
"Version": "2025-05-01",​
"RequestId": "20230604110420****100232280022D31"​
},​
"Result": {​
"TaskId": "7301280763734xxxxxx",​
"TaskAction": "RunCommand",​
"Jobs": [​
{​
"JobId": "job-7294170061873xxxxxx-7294157141458xxxxxx",​
"PodId": "7294157141458xxxxxx",​
"Status": 10,​
"JobAction": "RunCommand"​
}​
]​
}​
}​
​
错误码​
您可访问 公共错误码,获取更多错误码信息。​
​
最近更新时间:2026.04.23 11:26:33
这个页面对您有帮助吗?
有用
有用
无用
无用