从后端导出基线检测报告,生成Excel文件 - ExportBaselineSecurityCheckReport
功能介绍
从后端导出基线检测报告,生成Excel文件
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
POST /v5/{project_id}/baseline/export
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位。 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
category |
否 |
String |
参数解释: 导出类型 约束限制: 不涉及 取值范围:
默认取值: risk-config |
|
export_size |
否 |
Integer |
参数解释 导出数据条数 约束限制 不涉及 取值范围 取值 1 - 200000 默认取值 100000 |
|
group_id |
否 |
String |
参数解释: 策略组id 约束限制: 不涉及 取值范围: 字符长度0-128位 默认取值: 不涉及 |
|
check_name |
否 |
String |
参数解释: 配置检查(基线)的名称,例如SSH、CentOS 7、Windows 约束限制: 不涉及 取值范围: 字符长度0-256位 默认取值: 不涉及 |
|
standard |
否 |
String |
参数解释: 标准类型 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
scan_result |
否 |
String |
参数解释: 检查结果 约束限制: 不涉及 取值范围
默认取值 不涉及 |
|
severity |
否 |
String |
参数解释: 风险等级 约束限制: 不涉及 取值范围
默认取值 不涉及 |
|
host_id |
否 |
String |
参数解释: 主机ID,不赋值时,查租户所有主机 约束限制: 不涉及 取值范围: 字符长度0-64位 默认取值: 不涉及 |
|
limit |
否 |
Integer |
每页显示个数 |
|
offset |
否 |
Integer |
偏移量:指定返回记录的开始位置 |
|
export_headers |
是 |
Array<Array<String>> |
导出配置检测数据的表头信息列表 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
task_id |
String |
参数解释: 任务ID 取值范围: 不涉及 |
请求示例
无
响应示例
状态码:200
请求已成功
{
"task_id" : "f2bead8f-xxxx-xxxx-xxxx-911c461dxxxx"
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。