1. 接口描述
接口请求域名: gs.tencentcloudapi.com 。
在安卓实例上同步执行命令,仅支持1秒内可以返回结果的命令,例如:ls、cd。同时执行的实例数量不能过多,否则可能云api返回超时。不支持超过1秒无法返回或无法自主结束的命令,例如:top、vim,执行结果最大1KB
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:SyncExecuteCommandOnAndroidInstances。 |
Version | 是 | String | 公共参数,本接口取值:2019-11-18。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
AndroidInstanceIds.N | 是 | Array of String | 安卓实例 ID 列表 示例值:["android_instance_id"] |
Command | 是 | String | shell 命令,必须是1秒内能自动结束的命令 示例值:ls -al; cat /etc/profile |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
CommandResults | Array of SyncExecuteCommandResult | 命令执行结果列表 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 SyncExecuteCommandOnAndroidInstances 示例
输入示例
POST / HTTP/1.1
Host: gs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SyncExecuteCommandOnAndroidInstances
<公共请求参数>
{
"AndroidInstanceIds": [
"cai-1300055477-ea990LbMLbq"
],
"Command": "ls"
}
输出示例
{
"Response": {
"CommandResults": [
{
"InstanceId": "cai-1300055477-ea990LbMLbq",
"Output": "{\"StdOut\":\"acct\\napex\\nbin\\nbugreports\\ncache\\ncharger\\nconfig\\ncontainer.prop\\nd\\ndata\\ndebug_ramdisk\\ndefault.prop\\ndev\\netc\\ninit\\ninit.environ.rc\\ninit.rc\\ninit.usb.rc\\ninit.zygote32.rc\\ninit.zygote64_32.rc\\nlost+found\\nmetadata\\nmnt\\nodm\\noem\\nproc\\nproduct\\nproduct_services\\nres\\nsbin\\nsdcard\\nstorage\\nsys\\nsystem\\ntcg_share_data\\nueventd.rc\\nvendor\\nwebrtc_ctrl_20240914.log\\nwebrtc_ctrl_20240915.log\\nwebrtc_ctrl_20240916.log\\nwebrtc_ctrl_20240917.log\\nwebrtc_ctrl_20240918.log\\nwebrtc_ctrl_20240919.log\\n\",\"StdError\":\"\"}",
"Status": "SUCCESS"
}
],
"RequestId": "bc62efee-0e09-4267-9f0b-aabdc80bf2eb"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation | 操作失败。 |
FailedOperation.ProcessTimeout | 处理超时。 |
InternalError | 内部错误。 |
OperationDenied | 操作被拒绝。 |
ResourceNotFound | 资源不存在。 |
UnsupportedOperation | 操作不支持。 |