容器安全服务创建主机列表导出任务

1. 接口描述

接口请求域名： tcss.tencentcloudapi.com 。

创建主机列表导出任务

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：CreateHostExportJob。
Version	是	String	公共参数，本接口取值：2020-11-01。
Region	否	String	公共参数，此参数为可选参数。
Filters.N	否	Array of AssetFilters	过滤条件。 Status-String-是否必填：否-agent状态筛选，"ALL": "全部"(或不传该字段), "UNINSTALL"："未安装", "OFFLINE"："离线", "ONLINE"："防护中" HostName-String-是否必填：否-主机名筛选 Group-String-是否必填：否-主机群组搜索 HostIP-string-是否必填：否-主机ip搜索 HostID-string-是否必填：否-主机id搜索 DockerVersion-string-是否必填：否-docker版本搜索 MachineType-string-是否必填：否-主机来源MachineType搜索，"ALL": "全部"(或不传该字段), 主机来源：[ "CVM", "ECM", "LH", "BM" ]中的之一为腾讯云服务器；[ "Other" ]之一非腾讯云服务器； DockerStatus-string-是否必填：否-docker安装状态，"ALL": "全部"(或不传该字段), "INSTALL": "已安装", "UNINSTALL": "未安装" ProjectID-string-是否必填：否-所属项目id搜索 Tag:(tag: key)-string-是否必填：否-标签键值搜索示例Filters":[{"Name":"tag: tke-kind","Values":["service"]}] 示例值：[{ "Name": "Status", "Values": [“ALL”], "ExactMatch": false }]
Limit	否	Integer	偏移量，默认为0。示例值：10
Offset	否	Integer	需要返回的数量，默认为10，最大值为10000 示例值：10
By	否	String	排序字段示例值：ContainerCnt
Order	否	String	升序降序,asc desc 示例值：ASC
ExportField.N	否	Array of String	导出字段示例值：["HostPublicIP"]

3. 输出参数

参数名称	类型	描述
JobId	String	导出任务ID，前端拿着任务ID查询任务进度示例值：b4d3f78f-4634-4a38-9c82-2beee911****
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 创建主机列表导出任务

输入示例

POST / HTTP/1.1
Host: tcss.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: CreateHostExportJob
<公共请求参数>

{
    "ExportField": [
        "HostName",
        "HostIP",
        "PublicIp",
        "Group",
        "InstanceID",
        "MachineType",
        "Status",
        "DockerVersion",
        "ContainerdVersion",
        "DockerFileSystemDriver",
        "ImageCnt",
        "ContainerCnt"
    ]
}

输出示例

{
    "Response": {
        "JobId": "73805b97-0e40-4249-8fe5-f1e38de1c28a",
        "RequestId": "78382c9e-92c7-42bb-8a2a-04d406903d94"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InternalError	内部错误。
InvalidParameter	参数错误。
InvalidParameter.InvalidFormat	参数格式错误。
InvalidParameter.MissingParameter	缺少必须参数。
InvalidParameter.ParsingError	参数解析错误。
InvalidParameterValue	参数取值错误。