查询基线白名单列表 - ListBaselineWhiteLists
功能介绍
查询基线白名单列表
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,当前API调用无需身份策略权限。
URI
GET /v5/{project_id}/baseline/whitelists
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
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 |
|
check_rule_name |
否 |
String |
基线检查的检查项名称 |
|
os_type |
否 |
String |
基线检查的操作系统
|
|
rule_type |
否 |
String |
基线检查白名单的规则范围
|
|
tag |
否 |
String |
基线检查中检查项的检查类型
|
|
description |
否 |
String |
基线检查白名单备注 |
请求参数
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
X-Auth-Token |
是 |
String |
参数解释: 用户Token,包含了用户的身份、权限等信息,在调用API接口时,可通过Token进行身份认证。获取方式请参见获取用户Token。 约束限制: 不涉及 取值范围: 字符长度1-32768位 默认取值: 不涉及 |
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
total_num |
Integer |
基线白名单总数 |
|
data_list |
Array of BaselineWhiteListsResponseInfo objects |
基线白名单列表 |
|
tag_list |
Array of strings |
基线检查中检查项的检查类型列表 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
id |
String |
基线白名单标识 |
|
rule_type |
String |
基线检查白名单的规则范围
|
|
os_type |
String |
基线检查的操作系统
|
|
index_version |
String |
基线检查的检查项标识 |
|
check_type |
String |
基线检查的基线名称 |
|
standard |
String |
标准类型,包含如下:
|
|
tag |
String |
基线检查中检查项的检查类型
|
|
check_rule_name |
String |
基线检查中检查项的名称 |
|
description |
String |
基线白名单备注 |
请求示例
查询企业项目id为xxx下的基线白名单列表
GET https://{endpoint}/v5/{project_id}/baseline/whitelists?enterprise_project_id=xxx&limit=100&offset=0
响应示例
状态码:200
请求已成功
{
"total_num" : 2,
"data_list" : [ {
"id" : "00bd5209-d8df-43af-bf91-5c0cfc965a1a",
"rule_type" : "specific_host",
"os_type" : "Linux",
"index_version" : "4.1",
"check_type" : "HCE1.1",
"standard" : "cn_standard",
"tag" : "访问控制",
"check_rule_name" : "规则:访问控制A",
"description" : "基线白名单A"
}, {
"id" : "01e7a09c-99ff-4418-b960-6b198e814c72",
"rule_type" : "all_host",
"os_type" : "windows",
"index_version" : "4.2",
"check_type" : "windows2012",
"standard" : "cn_standard",
"tag" : "服务配置",
"check_rule_name" : "规则:服务配置B",
"description" : "基线白名单B"
} ],
"tag_list" : [ "访问控制", "服务配置" ]
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
请求已成功 |
错误码
请参见错误码。