查询基线的详细检查项 - ShowDefaultSecurityCheckPolicyDetails
功能介绍
查询基线的详细检查项
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/baseline/security-checks/default-policy/details
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 项目ID,用于明确项目归属,配置后可通过该ID查询项目下资产。获取方式请参见获取项目ID。 约束限制: 不涉及 取值范围: 字符长度1-256位 默认取值: 不涉及 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
enterprise_project_id |
否 |
String |
参数解释: 企业项目ID,用于过滤不同企业项目下的资产。获取方式请参见获取企业项目ID。 如需查询所有企业项目下的资产请传参“all_granted_eps”。 约束限制: 开通企业项目功能后才需要配置企业项目ID参数。 取值范围: 字符长度1-256位 默认取值: 0,表示默认企业项目(default)。 |
|
offset |
是 |
Integer |
参数解释: 偏移量:指定返回记录的开始位置 约束限制: 不涉及 取值范围: 最小值0,最大值2000000 默认取值: 不涉及 |
|
limit |
是 |
Integer |
参数解释: 每页显示个数 约束限制: 不涉及 取值范围: 取值10-200 默认取值: 10 |
|
support_os |
是 |
String |
参数解释 策略支持的操作系统类型 约束限制 不涉及 取值范围 默认取值 Linux |
|
check_type |
否 |
String |
参数解释 配置检查(基线)的类型,例如SSH、CentOS 7、Windows Server 2019 R2、Windows Server 2016 R2、MySQL5-Windows、weakpwd、pwdcomplexity 约束限制 不涉及 取值范围 字符长度0-256位 默认取值 不涉及 |
|
standard |
是 |
String |
参数解释 标准类型 约束限制 不涉及 取值范围 默认取值 不涉及 |
|
tag |
否 |
String |
参数解释 基线检查项的类型 约束限制 不涉及 取值范围 字符长度0-256位 默认取值 不涉及 |
|
check_rule_name |
否 |
String |
参数解释 配置检查(基线)检查项的名称 约束限制 不涉及 取值范围 字符长度0-2048位 默认取值 不涉及 |
|
severity |
否 |
String |
参数解释 配置检查(基线)检查项的风险程度 约束限制 不涉及 取值范围 默认取值 不涉及 |
|
level |
否 |
String |
参数解释 配置检查(基线)检查项的等级 约束限制 不涉及 取值范围 字符长度0-32位 默认取值 不涉及 |
|
group_id |
否 |
String |
参数解释 策略组ID 约束限制 不涉及 取值范围 字符长度0-128位 默认取值 不涉及 |
|
checked |
否 |
Boolean |
参数解释 默认是否被选中 约束限制 不涉及 取值范围 false : 不选中 true : 默认 默认取值 true |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
参数解释 检查项列表总数 取值范围 取值0-2147483647 |
|
check_details |
Array of SecurityCheckPolicyDetailInfoResponseInfo objects |
参数解释 检查项列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
key |
String |
参数解释 检查项唯一值 取值范围 字符长度0-256位 |
|
check_rule_id |
String |
参数解释 检查项id 取值范围 字符长度0-256位 |
|
check_rule_name |
String |
参数解释 检查项(检查规则)名称 取值范围 字符长度0-65534位 |
|
check_rule_type |
Integer |
参数解释 检查项类型是否是数值类型 取值范围 |
|
check_type |
String |
参数解释 配置检查(基线)的类型,例如SSH、CentOS 7、Windows 取值范围 字符长度0-256位 |
|
severity |
String |
参数解释 检查项的风险程度 取值范围 |
|
level |
String |
参数解释 检查项的等级 取值范围 字符长度0-32位 |
|
checked |
Boolean |
参数解释 检查项是否被选中 取值范围 |
|
rule_params |
Array of CheckRuleFixParamInfo objects |
参数解释 可自定义配置的参数 |
请求示例
无
响应示例
状态码:200
请求已成功
{
"check_details" : [ {
"key" : "hw_standard-SSH-访问控制",
"check_rule_id" : "1.1",
"check_rule_name" : "禁止启用FTP服务(自动)",
"check_rule_type" : 1,
"check_type" : "SSH",
"severity" : "High",
"level" : "level1/level2",
"checked" : "true",
"rule_params" : [ {
"rule_param_id" : 10,
"rule_desc" : "数字大小",
"default_value" : 2147483647,
"range_min" : 2147483647,
"range_max" : 2147483647
} ]
} ],
"total_num" : 1
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。