1. 接口描述
接口请求域名： bh.tencentcloudapi.com 。
外部客户访问资产
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：AccessDevices。 |
| Version | 是 | String | 公共参数，本接口取值：2023-04-18。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| Account | 是 | String | 资产的登录账号 示例值：root |
| DeviceId | 否 | Integer | 资产ID 示例值：12 |
| InstanceId | 否 | String | 资源id(优先使用DeviceId) 示例值：ins-bhtest |
| Password | 否 | String | 未托管密码私钥时，填入 示例值：1a2b3c |
| PrivateKey | 否 | String | 未托管密码私钥时，填入 示例值：bh-test-private-key |
| PrivateKeyPassword | 否 | String | 未托管密码私钥时，填入 示例值：1a2b3c |
| Exe | 否 | String | 客户端工具 示例值：mrd |
| Drivers.N | 否 | Array of String | RDP挂载盘符驱动（mstsc支持） 示例值：["c:","d:"] |
| Width | 否 | Integer | 窗口宽度（RDP支持） 示例值：800 |
| Height | 否 | Integer | 窗口高度（RDP支持） 示例值：600 |
| IntranetAccess | 否 | Boolean | 是否内网访问（默认不是） 示例值：false |
| AutoManageAccessCredential | 否 | Boolean | 是否自动管理访问串，删掉过期的，新建可用的（默认false） 示例值：false |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| AccessInfo | AccessInfo | 认证信息 示例值：{"Ip":"127.0.0.1","Port":22} |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 访问示例
输入示例
POST / HTTP/1.1
Host: bh.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: AccessDevices
<公共请求参数>
{
"InstanceId": "ins-2ftyp2vu",
"Account": "zhangsan",
"Password": "",
"PrivateKey": "",
"PrivateKeyPassword": "",
"Exe": "web",
"Drivers": [
""
],
"Width": 60,
"Height": 80,
"IntranetAccess": false
}输出示例
{
"Response": {
"AccessInfo": {
"AccessURL": "",
"Ip": "11.11.11.11",
"Password": "sHUbwq6nFm9mja05n10X6YZ1TbTr0mpS",
"Port": 8322,
"User": "root@FdfmcRltiJZ2nNam"
},
"RequestId": "3bd56f7b-6453-476d-b0fa-c97c164d68b8"
}
}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. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| ResourceNotFound | 资源不存在。 |
