checks_overview API: шалгалтуудын тоймыг хэрхэн авах вэ?

Энэ API нь таны компани дээр хийгдсэн шалгалтуудын тооны тоймыг буцаана. Хариунд зөвхөн хамгийн сүүлд хийсэн шалгалтууд орно.

Хүсэлт

Формат

GET /cspm/checks_overview?scans=<string>&scan_groups=<string>&rules=<string>&resources=<string>&resource_types=<string>&system_compliance=<string>

Параметрүүд

• `scans` — Array of Strings; заавал биш: Тийм; Эдгээр scan бүртгэлүүд дээр хийсэн scan-ий үр дүнд үүссэн шалгалтуудыг буцаана.
• `scan_groups` — Array of Strings; заавал биш: Тийм; Энэ scan бүлэгт харьяалагдах scan бүртгэлүүд дээр хийсэн scan-ий үр дүнд үүссэн шалгалтуудыг буцаана.
• `rules` — Array of Strings; заавал биш: Тийм; Энэ дүрэмд суурилан хийсэн scan-ий үр дүнд үүссэн шалгалтуудыг буцаана.
• `resources` — Array of Strings; заавал биш: Тийм; Энэ нөөцийг хамарсан шалгалтуудыг буцаана.
• `resource_types` — Array of Strings; заавал биш: Тийм; Энэ төрлийн нөөцийг хамарсан шалгалтуудыг буцаана.
• `system_compliance` — Array of Strings; заавал биш: Тийм; Эдгээр нийцлийн стандартуудтай холбоотой шалгалтуудыг буцаана.

Жишээ

Scan бүртгэлүүд дээр саяхан хийсэн бүх шалгалтын тоймыг хүсэх:

GET /cspm/checks_overview

16beea3e-d011-4c0c-932c-8d8e5******c scan бүлэг дээр хийсэн, 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": Integer,
      "total": Integer,
      "pass": Integer,
      "fail": Integer,
      "suppressed": Integer
    },
    "open_checks_by_severity": {
      "critical": Integer,
      "high": Integer,
      "medium": Integer,
      "low": Integer,
      "informational": Integer
    }
  }
}

Шинж чанарууд

Энэ endpoint нь олон шинж чанар агуулсан объект буцаана:

• `data` — Array; Тодорхой нэг шалгалтын мэдээллийг өгөх шинж чанаруудын жагсаалт.
• `checks_overview` — Array; Таны scan бүртгэлүүд дээр хийсэн шалгалтуудын ерөнхий мэдээлэл болон тоог харуулах шинж чанаруудын жагсаалт.
• `score` — Integer; Буцсан fail болон pass статусын тоонд суурилсан таны scan бүртгэлүүдийн шалгалтын нийт оноо.
• `total` — Integer; Таны scan бүртгэлүүд дээр хийсэн шалгалтын нийт тоо.
• `pass` — Integer; pass статустай шалгалтын нийт тоо.
• `fail` — Integer; fail статустай шалгалтын нийт тоо.
• `suppressed` — Integer; suppressed статустай шалгалтын нийт тоо.
• `open_checks_by_severity` — Array; Тодорхой хүндийн зэрэгтэй шалгалтын нийт тоог харуулах шинж чанаруудын жагсаалт.
• `critical` — Integer; critical хүндийн зэрэгтэй нээлттэй (open) шалгалтын нийт тоо.
• `high` — Integer; high хүндийн зэрэгтэй нээлттэй шалгалтын нийт тоо.
• `medium` — Integer; medium хүндийн зэрэгтэй нээлттэй шалгалтын нийт тоо.
• `low` — Integer; low хүндийн зэрэгтэй нээлттэй шалгалтын нийт тоо.
• `informational` — Integer; informational хүндийн зэрэгтэй нээлттэй шалгалтын нийт тоо.

Жишээ

Scan бүртгэлүүд дээр саяхан хийсэн бүх шалгалтын тоймыг хүссэн:

{
    "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 scan бүлэг дээр хийсэн, mas-trm болон cis-aws-1-4 нийцлийн стандартуудтай холбоотой шалгалтуудын тоймыг хүссэн:

{
    "data": {
        "checks_overview": {
            "score": 0.8511421231687842,
            "total": 14403,
            "pass": 12259,
            "fail": 2144,
            "suppressed": 3
        },
        "open_checks_by_severity": {
            "critical": 36,
            "high": 687,
            "medium": 1383,
            "low": 38,
            "informational": 0
        }
    }
}