GET /cspm/checks_overview
该API返回对您公司执行检查的数量概览。响应中仅包含最新执行的检查。
请求
格式
GET /cspm/checks_overview?scans=<字符串>&scan_groups=<字符串>&rules=<字符串>&resources=<字符串>&resource_types=<字符串>&system_compliance=<字符串>
参数
|
参数 |
类型 |
可选 |
描述 |
|---|---|---|---|
|
|
字符串数组 |
是 |
返回在这些扫描账户上执行扫描所产生的检查项。 |
|
|
字符串数组 |
是 |
返回属于该扫描组的扫描账户上执行扫描所产生的检查项。 |
|
|
字符串数组 |
是 |
返回基于该规则执行扫描所产生的检查项。 |
|
|
字符串数组 |
是 |
返回涉及该资源的检查项。 |
|
|
字符串数组 |
是 |
返回涉及该类型资源的检查项。 |
|
|
字符串数组 |
是 |
返回与这些合规标准相关的检查项。 |
注意
您可以使用 GET /setting/scans , GET /setting/scan_groups , GET /cspm/rules , GET /cspm/resources ，以及 GET /cspm/system_compliance 用于获取使用此请求所需ID的API。
示例
请求获取最近对扫描账户执行的所有检查的概览：
GET /cspm/checks_overview
请求获取扫描组
16beea3e-d011-4c0c-932c-8d8e5******c
上执行且关联到
mas-trm
与
cis-aws-1-4
合规标准的检查概览。
GET /cspm/checks_overview?scan_groups=16beea3e-d011-4c0c-932c-8d8e5******c&system_compliance=mas-trm,cis-aws-1-4
响应
格式
{
"data": {
"checks_overview": {
"score": 整数,
"total": 整数,
"pass": 整数,
"fail": 整数,
"suppressed": 整数
},
"open_checks_by_severity": {
"critical": 整数,
"high": 整数,
"medium": 整数,
"low": 整数,
"informational": 整数
}
}
}
属性
|
属性名 |
类型 |
描述 |
|---|---|---|
|
|
数组 |
提供特定检查信息的属性列表。 |
|
|
数组 |
显示扫描账户检查总体信息及数量的属性列表。 |
|
|
整数 |
扫描账户的总体检查分数，基于
|
|
|
整数 |
对扫描账户执行检查的总次数。 |
|
|
整数 |
具有
|
|
|
整数 |
具有
|
|
|
整数 |
具有
|
|
|
数组 |
显示特定严重性检查总数的属性列表。 |
|
|
整数 |
具有
|
|
|
整数 |
处于开放状态的
|
|
|
整数 |
处于开放状态的
|
|
|
整数 |
处于开放状态的
|
|
|
整数 |
处于开放状态的
|
示例
已请求获取您扫描账户最近所有检查的概览：
{
"data": {
"checks_overview": {
"score": 0.7941442255557564,
"total": 16599,
"pass": 13182,
"fail": 3417,
"suppressed": 4
},
"open_checks_by_severity": {
"critical": 42,
"high": 950,
"medium": 2272,
"low": 153,
"informational": 0
}
}
}
已请求获取扫描组
16beea3e-d011-4c0c-932c-8d8e5******c
中与
mas-trm
及
cis-aws-1-4
合规标准相关的检查概览：
{
"数据": {
"检查概览": {
"得分": 0.8511421231687842,
"总数": 14403,
"通过": 12259,
"失败": 2144,
"已抑制": 3
},
"按严重性分类的未通过检查": {
"严重": 36,
"高": 687,
"中": 1383,
"低": 38,
"信息性": 0
}
}
}