文档首页> 云手机 CPH> API参考> 云手机API> ADB命令> 执行同步adb shell命令
更新时间:2022-03-31 GMT+08:00
分享

执行同步adb shell命令

功能介绍

  • 接口名称

    RunSyncCommand

  • 功能描述

    在云手机中同步执行命令并返回命令执行的输出信息,该接口仅支持adb shell命令的执行。1分钟内每个用户调用接口次数上限为6次,每个云手机允许执行命令超时时间为2秒,接口时间不超过30秒,执行云手机数越多,接口耗时相应越长。

URI

POST /v1/{project_id}/cloud-phone/phones/sync-commands

参数说明请参见表1
表1 参数说明

参数

是否必选

参数类型

描述

project_id

String

项目ID

获取方式请参见获取项目ID

请求消息

  • 参数说明

    参数

    是否必选

    参数类型

    描述

    command

    String

    当前仅支持填写shell。

    content

    String

    待执行的命令

    最大长度为1024字节,只支持大小写字母、数字、下划线(_)、点(.)、斜线(/)、冒号(:)、中划线(-)。

    server_ids

    phone_ids参数不存在时必选

    Array of strings

    云手机服务器ID列表

    可通过查询云手机服务器列表获取。

    phone_ids

    server_ids参数不存在时必选

    Array of strings

    云手机ID列表

    可通过查询云手机列表获取。

  • 请求样例
    POST https://{CPH Endpoint}/v1/{project_id}/cloud-phone/phones/sync-commands
    {
        "command": "shell",
        "content": "ls -l /system",
        "phone_ids": [
            "1234567b8bab40ffb711234cb80d0234",
            "1678567b8bab40f93711234cb80d0764"
        ]
    }

响应消息

  • 响应参数

    参数

    参数类型

    描述

    request_id

    String

    请求的唯一标识ID

    jobs

    Array of objects

    任务信息,详情请参见表2

    表2 job数据结构说明

    参数

    参数类型

    描述

    phone_id

    String

    云手机的唯一标识,云手机相关任务包含此字段。

    job_id

    String

    任务的唯一标识

    status

    Integer

    任务状态。

    • 2表示成功
    • -1表示失败

    error_code

    String

    任务错误码

    error_msg

    String

    任务错误码说明

    execute_msg

    String

    任务执行返回内容,最长1024字节。命令执行成功和失败均将命令的输出返回。

  • 响应样例
    {
        "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"
        }]
    }

返回值

请参考返回值

错误码

请参考错误码

分享:

    相关文档

    相关产品

关闭导读