1. 接口描述
接口请求域名: gs.tencentcloudapi.com 。
创建云手机实例 ADB 连接信息,请将返回结果的 PrivateKey 字段保存为 pem 文件,并将 pem 文件权限设置为 600,再参考返回结果的 ConnectCommand 使用 adb 连接实例。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:CreateAndroidInstanceADB。 |
Version | 是 | String | 公共参数,本接口取值:2019-11-18。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
AndroidInstanceId | 是 | String | 安卓实例 ID 示例值:cai-ab123456 |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
PrivateKey | String | 连接私钥,需要保存为文件形式,例如 private_key.pem 示例值:-----BEGIN OPENSSH PRIVATE KEY----- |
UserName | String | 用户名称 示例值:root |
HostName | String | 连接地址 示例值:10.0.0.1 |
Port | Integer | 连接端口 示例值:12222 |
ConnectCommand | String | 连接参考命令 示例值:ssh -i private_key.pem -p 12222 root@10.0.0.1 |
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 示例
示例
输入示例
POST / HTTP/1.1
Host: gs.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateAndroidInstanceADB
<公共请求参数>
{
"AndroidInstanceId": "cai-251006279-ea99cM7rbg6"
}
输出示例
{
"Response": {
"ConnectCommand": "ssh -i private_key.pem -L 5555:cai-251006279-ea99cM7rbg6:5555 root@test-ap-shenzhen-1.webssh.crtrcloud.com -p 12222",
"HostName": "test-ap-shenzhen-1.webssh.crtrcloud.com",
"Port": 12222,
"PrivateKey": "-----BEGIN OPENSSH PRIVATE KEY-----\nb3BlbnNzaC1rZXktdjEAAAAABG5vbmUAAAAEbm9uZQAAAAAAAAABAAAAMwAAAAtz\nc2gtZWQyNTUxOQAAACDZ2upaoRI2s2uMA8ESBiDnS9heOvxhBAQOQzSrFv1aagAA\nAIjvnnQA7550AAAAAAtzc2gtZWQyNTUxOQAAACDZ2upaoRI2s2uMA8ESBiDnS9he\nOvxhBAQOQzSrFv1aagAAAEAWnd+o1zmFUPf6K78mAcnFtIcV+OJ7D8mzaI050YgK\ncdna6lqhEjaza4wDwRIGIOdL2F46/GEEBA5DNKsW/VpqAAAAAAECAwQF\n-----END OPENSSH PRIVATE KEY-----\n",
"RequestId": "c53f2591-97ae-4eec-a66c-c12e312ea519",
"UserName": "root"
}
}
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 | 操作失败。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue | 参数取值错误。 |