1. 接口描述
接口请求域名： ioa.tencentcloudapi.com 。
创建终端导出任务，私有化调用path为：capi/Assets/Device/ExportDeviceDownloadTask
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ExportDeviceDownloadTask。 |
| Version | 是 | String | 公共参数，本接口取值：2022-06-01。 |
| Region | 否 | String | 公共参数，本接口不需要传递此参数。 |
| OsType | 否 | Integer | 系统类型（0: win，1：linux，2: mac，4：android，5：ios；默认值0） 示例值：0 |
| DomainInstanceId | 否 | String | 管理域实例ID，用于CAM管理域权限分配。若企业未进行管理域的划分，可直接传入根域"1"，此时表示针对当前企业的全部设备和账号进行接口CRUD，具体CRUD的影响范围限制于相应接口的入参。 示例值：1 |
| GroupId | 否 | Integer | 分组id 示例值：1120 |
| OnlineStatus | 否 | Integer | 在线状态 2 在线 0，1 离线 示例值：0 |
| ExportOrder | 否 | String | 导出顺序，接口返回的数据字段 示例值：Name,RemarkName,IOAUserName,AccountName,UserName,LocalIpList,Ip,Mid,VulVersion,SysRepVersion,VirusVer,Os,Tags,SerialNum,AccountList,BaseBoardSn,MacAddr,GroupName,StrVersion,DomainName |
| ExportType | 否 | Integer | 导出类型， 0：终端树；7:硬件信息列表导出； 示例值：0 |
| Condition | 否 | Condition | 过滤条件。同DescribeDevices接口 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Data | DeviceDownloadTask | 业务响应数据 |
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 测试全网终端分组（ID=1120）的数据导出
测试全网终端分组（ID=1120）的数据导出
输入示例
POST / HTTP/1.1
Host: ioa.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ExportDeviceDownloadTask
<公共请求参数>
{
"OsType": 0,
"DomainInstanceId": "1",
"GroupId": 1120,
"ExportType": 0
}输出示例
{
"Response": {
"Data": {
"DownloadURL": "",
"TaskId": 186954
},
"RequestId": "23b2ad49-f082-401c-a3f1-8b903291d5a6"
}
}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: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| FailedOperation.QueryData | 查询数据失败。 |
| InternalError.DatabaseException | 内部错误，数据库异常。 |
| InternalError.Unknown | 内部未知错误。 |
| InvalidParameter.RequestParam | 请求参数错误。 |
| MissingParameter.CommonParam | 缺少公共参数。 |
| RequestLimitExceeded.DeviceDownloadTask | 终端导出任务同一时间仅允许一个，请稍后再试。 |
| ResourceNotFound.NotFound | 资源不存在。 |
| UnauthorizedOperation.PermissionDenied | 未授权的操作。 |
