按查询结果导出配置检测报告 - ExportSecurityCheckReport
功能介绍
按查询结果导出配置检测报告,生成Excel文件
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/baseline/risk-config/export
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
|
group_id |
否 |
String |
参数解释: 服务器组ID 约束限制: 不涉及 取值范围: 字符长度1-64位 默认取值: 不涉及 |
|
host_id |
否 |
String |
参数解释: 服务器ID 约束限制: 不涉及 取值范围: 字符长度1-64位 默认取值: 不涉及 |
|
check_name |
否 |
String |
参数解释 : "配置检查(基线)的名称,例如SSH、CentOS 7、Windows"。 约束限制 : 不涉及 取值范围 : 字符长度1-256位 默认取值 : 不涉及 |
|
standard |
否 |
String |
参数解释: 标准类型。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
scan_result |
否 |
String |
参数解释: 检查结果。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
|
severity |
否 |
String |
参数解释: 风险级别。 约束限制: 不涉及 取值范围:
默认取值: 不涉及 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
配置检测信息总数 |
|
data_list |
Array of ExportSecurityCheckInfoResponseInfo objects |
数据列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
host_id |
String |
服务器ID |
|
host_name |
String |
服务器名称 |
|
host_public_ip |
String |
服务器公网IP |
|
host_private_ip |
String |
服务器私网IP |
|
check_type |
String |
配置检查(基线)的类型,Linux系统支持的基线一般check_type和check_name相同,例如SSH、CentOS 7。 Windows系统支持的基线一般check_type和check_name不相同,例如check_name为Windows的配置检查(基线),它的check_type包含Windows Server 2019 R2、Windows Server 2016 R2等。 |
|
check_name |
String |
配置检查(基线)的名称,例如SSH、CentOS 7、Windows |
|
standard |
String |
基线标准 - cn_standard#等保合规标准 - hw_standard#云安全实践标准 |
|
check_rule_name |
String |
检查项(检查规则)名称 |
|
executable_file_path |
String |
配置检查(基线)的路径信息 |
|
severity |
String |
风险等级,包含如下:
|
|
scan_result |
String |
检测结果
|
|
status |
String |
状态
|
|
check_rule_desc |
String |
规则描述 |
|
audit |
String |
审计描述 |
|
remediation |
String |
修改建议 |
|
check_info_list |
String |
检测用例信息 |
|
create_time |
Long |
首次扫描时间,时间戳单位:毫秒 |
请求示例
无
响应示例
无
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。