导出集群环境安全相关信息 - ExportRisks
功能介绍
导出集群环境安全相关信息
授权信息
账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权，具体权限要求请参见权限和授权项。
- 如果使用身份策略授权，当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/container/cluster/risk/export-task
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID，用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0，表示默认企业项目（default）。 |
|
risk_type |
是 |
String |
参数解释: 风险类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
export_size |
是 |
Integer |
参数解释: 导出数据条数 约束限制: 不涉及 取值范围: 不涉及 默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token，包含了用户的身份、权限等信息，在调用API接口时，可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
export_headers |
是 |
Array<Array<String>> |
参数解释: 导出集群环境安全数据的表头信息列表 取值范围: 最小值1，最大值10000 |
|
iac_items |
否 |
IacRequestInfo object |
IaC风险筛选条件 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
file_id_list |
否 |
Array of strings |
参数解释: IaC文件ID列表 约束限制: 不涉及 取值范围: 1-200个items 默认取值: 不涉及 |
|
file_name |
否 |
String |
参数解释: 文件名称 约束限制: 不涉及 取值范围: 字符长度1-64 默认取值: 不涉及 |
|
file_type |
否 |
String |
参数解释: 文件类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
risky |
否 |
Boolean |
参数解释: 是否有风险 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
scan_type |
否 |
String |
参数解释: 扫描方式 约束限制: 不涉及 取值范围:
默认取值: manual_scan |
响应参数
状态码：200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
task_id |
String |
参数解释： 任务ID 取值范围： 字符长度1-64位 |
请求示例
导出project_id为2b31ed520xxxxxxebedb6e57xxxxxxxx的所有手动扫描的iac风险数据，导出的excel文件包含“文件名称”、“风险名称”两列
POST https://{endpoint}/v5/2b31ed520xxxxxxebedb6e57xxxxxxxx/container/cluster/risk/export-task?enterprise_project_id=all_granted_eps&risk_type=iac_risk&export_size=10000
{
"iac_items" : {
"scan_type" : "manual_scan"
},
"export_headers" : [ [ "file_name", "文件名称" ], [ "risk_name", "风险名称" ] ]
}
响应示例
状态码：200
请求已成功
{
"task_id" : "b02cdc6b-aeed-4232-911f-3e4e2a2d991a"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。
