文档首页/ 企业主机安全 HSS/ API参考/ API说明/ 容器管理/ 创建容器导出任务 - ExportContainerList
更新时间:2025-10-31 GMT+08:00
分享

创建容器导出任务 - ExportContainerList

功能介绍

创建容器导出任务

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。

  • 如果使用角色与策略授权,具体权限要求请参见权限和授权项
  • 如果使用身份策略授权,当前API调用无需身份策略权限。

URI

POST /v5/{project_id}/container/export-task

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

参数解释:

项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID

约束限制:

不涉及

取值范围:

字符长度1-256位

默认取值:

不涉及

表2 Query参数

参数

是否必选

参数类型

描述

enterprise_project_id

String

参数解释:

企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID

如需查询所有企业项目下的资产请传参“all_granted_eps”。

约束限制:

开通企业项目功能后才需要配置企业项目ID参数。

取值范围:

字符长度1-256位

默认取值:

0,表示默认企业项目(default)。

export_size

Integer

参数解释:

导出条数

约束限制:

不涉及

取值范围:

取值1-100000

默认取值:

100000

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

参数解释:

用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token

约束限制:

不涉及

取值范围:

字符长度1-32768位

默认取值:

不涉及

表4 请求Body参数

参数

是否必选

参数类型

描述

cluster_container

Boolean

参数解释:

是否是集群内的容器。只导出集群内容器时,设置此参数值为true。只导出非集群容器时,设置此参数为false。

约束限制:

不涉及

取值范围:

true或者false。

默认取值:

不涉及

cluster_type

String

参数解释:

集群类型。

约束限制:

不涉及

取值范围:

  • cce:CCE集群

  • ali:阿里云集群

  • tencent:腾讯云集群

  • azure:微软云集群

  • aws:亚马逊集群

  • self_built_hw:华为云自建集群

  • self_built_idc:IDC自建集群

默认取值:

不涉及

cluster_name

String

参数解释:

所属集群名称。

约束限制:

不涉及

取值范围:

字符长度1-255。

默认取值:

不涉及

container_name

String

参数解释:

容器名称。

约束限制:

不涉及

取值范围:

字符长度1-255。

默认取值:

不涉及

pod_name

String

参数解释:

所属Pod名称。

约束限制:

不涉及

取值范围:

字符长度1-512。

默认取值:

不涉及

image_name

String

参数解释:

镜像名称。

约束限制:

不涉及

取值范围:

字符长度1-255。

默认取值:

不涉及

status

String

参数解释:

容器状态。

约束限制:

不涉及

取值范围:

  • Running : 运行中

  • Waiting : 等待

  • Terminated : 终止

  • Isolated : 已隔离

  • Paused : 已暂停

默认取值:

不涉及

risky

Boolean

参数解释:

是否有安全风险。只导出有安全风险容器时,设置此参数值为true。只导出无安全风险容器时,设置此参数为false。

约束限制:

不涉及

取值范围:

true或者false。

默认取值:

不涉及

create_time

create_time object

创建时间

cpu_limit

String

参数解释:

cpu限制。

约束限制:

不涉及

取值范围:

字符长度0-64。以m为单位,例如100m。

默认取值:

不涉及

memory_limit

String

参数解释:

内存限制。

约束限制:

不涉及

取值范围:

字符长度0-64。以Mi、Gi为单位,例如300Mi。

默认取值:

不涉及

export_headers

Array<Array<String>>

参数解释:

导出容器列表的表头信息。

约束限制:

不涉及

取值范围:

合法的key值及其对应的表头名称(表头名称可自定义)

  • container_id:容器id

  • container_name:容器名称

  • image_name:镜像名称

  • pod_name:所属POD

  • cluster_name:所属集群

  • cluster_type:集群类型

  • status:状态

  • risky:是否有安全风险

  • low_risk:低危风险

  • medium_risk:中危风险

  • high_risk:高危风险

  • fatal_risk:致命风险

  • create_time:创建时间

  • restart_count:重启次数

  • cpu_limit:CPU限制

  • memory_limit:内存限制

默认取值:

不涉及

表5 create_time

参数

是否必选

参数类型

描述

start_time

Long

筛选起始时间

end_time

Long

筛选终止时间

响应参数

状态码:200

表6 响应Body参数

参数

参数类型

描述

task_id

String

导出任务ID

请求示例

创建容器导出任务

{
  "export_headers" : [ [ "container_name", "容器名称" ], [ "image_name", "镜像名称" ], [ "risky", "是否有安全风险" ] ]
}

响应示例

状态码:200

请求已成功

{
  "task_id" : "test"
}

状态码

状态码

描述

200

请求已成功

错误码

请参见错误码

相关文档