创建主机列表导出任务
最近更新时间: 2024-09-03 18:49:47
1. 接口描述
接口请求域名： tcss.api3.cloud.sunhongs.com。
创建主机列表导出任务
默认接口请求频率限制：20次/秒。
接口更新时间：2023-11-10 10:10:38。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：CreateHostExportJob |
| Version | 是 | 否 | String | 公共参数，本接口取值：2020-11-01 |
| Region | 是 | 否 | String | 公共参数，本接口不需要传递此参数。 |
| Filters | 否 | 否 | Array of AssetFilters | 过滤条件。<br><li>Status - String - 是否必填：否 - agent状态筛选，"ALL":"全部"(或不传该字段),"UNINSTALL"："未安装","OFFLINE"："离线", "ONLINE"："防护中"</li><br><li>HostName - String - 是否必填：否 - 主机名筛选</li><br><li>Group- String - 是否必填：否 - 主机群组搜索</li><br><li>HostIP- string - 是否必填：否 - 主机ip搜索</li><br><li>HostID- string - 是否必填：否 - 主机id搜索</li><br><li>DockerVersion- string - 是否必填：否 - docker版本搜索</li><br><li>MachineType- string - 是否必填：否 - 主机来源MachineType搜索，"ALL":"全部"(或不传该字段),主机来源：["CVM", "ECM", "LH", "BM"] 中的之一为腾讯云服务器；["Other"]之一非腾讯云服务器；</li><br><li>DockerStatus- string - 是否必填：否 - docker安装状态，"ALL":"全部"(或不传该字段),"INSTALL":"已安装","UNINSTALL":"未安装"</li><br><li>ProjectID- string - 是否必填：否 - 所属项目id搜索</li><br><li>Tag:xxx(tag:key)- string- 是否必填：否 - 标签键值搜索 示例Filters":[{"Name":"tag:tke-kind","Values":["service"]}]</li> |
| Limit | 否 | 否 | Uint64 | 偏移量，默认为0。 |
| Offset | 否 | 否 | Uint64 | 需要返回的数量，默认为10，最大值为10000 |
| By | 否 | 否 | String | 排序字段 |
| Order | 否 | 否 | String | 升序降序,asc desc |
| ExportField | 否 | 否 | Array of String | 导出字段 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| JobId | String | 导出任务ID，前端拿着任务ID查询任务进度 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InvalidParameter | |
| AuthFailure | |
| InternalError | |
| InvalidParameterValue | |
| FailedOperation | |
| InvalidParameter.ParsingError | |
| InvalidParameter.MissingParameter | |
| InvalidParameter.InvalidFormat |