同步执行命令 RunSyncCommand--云手机-火山引擎

文档中心

立即注册

云手机

请输入

云手机操控

同步执行命令 RunSyncCommand

在一个或多个云手机实例中同步执行命令，执行结果同步返回。
该接口适用于执行时间小于 5s 的命令，超过 5s 的命令建议使用异步执行命令异步执行命令 RunCommand 接口。

注意事项

本接口的单用户 QPS 限制为 50 次/秒、单实例 QPS 限制为 10 次/秒。超过限制，API 调用会被限流。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=RunSyncCommand&Version=2025-05-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`RunSyncCommand`	接口名称。当前 API 的名称为 `RunSyncCommand`。
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	权限类型。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
ProductId	String	1608456935646xxxxxx	实例所归属的业务 ID。
Command	String	ls	对指定的实例执行的命令。
Status	Array of RunSyncCommandStatus		命令执行状态，参考 RunSyncCommandStatus 数据格式说明。

RunSyncCommandStatus

参数	类型	示例值	描述
PodId	String	`7297074858797xxxxxx`	实例 ID。
Detail	String	`acct\napex\nbin\nvendor\n`	命令执行结果详情。
Success	Boolean	`true`	命令是否执行成功。

请求示例

POST https://open.volcengineapi.com?Action=RunSyncCommand&Version=2025-05-01
{
    "ProductId": "1608456935646xxxxxx",
    "PodIdList": [
        "7299381659819xxxxxx",
        "7297074858797xxxxxx"
    ],
    "Command": "ls",
    "PermissionType": "root"
}

返回示例

{
    "ResponseMetadata": {
        "Action": "RunSyncCommand",
        "Region": "cn-north-1",
        "Service": "ACEP",
        "Version": "2025-05-01",
        "RequestId": "20230604110420****100232280022D31"
    },
    "Result": {
        "ProductId": "1608456935646xxxxxx",
        "Command": "ls",
        "Status": [
            {
                "PodId": "7297074858797xxxxxx",
                "Detail": "acct\napex\nbin\nvendor\n",
                "Success": true
            }
        ]
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。

最近更新时间：2026.01.28 16:48:46

这个页面对您有帮助吗？

有用

无用

云手机

注意事项 #

请求说明 #

请求参数 #

Query #

Body #

返回参数 #

RunSyncCommandStatus #

请求示例 #

返回示例 #

错误码 #