OpenShift docs are moving and will soon only be available at docs.redhat.com, the home of all Red Hat product documentation. Explore the new docs experience today.
  1. Documentation
    2. history bug_report picture_as_pdf
×

GetComplianceOverallClusterStats

GET /v2/compliance/scan/stats/overall/cluster

Deprecated in favor of GetComplianceClusterStats

Description

Parameters

Query Parameters

Name Description Required Default Pattern

query

-

null

pagination.limit

-

null

pagination.offset

-

null

pagination.sortOption.field

-

null

pagination.sortOption.reversed

-

null

pagination.sortOption.aggregateBy.aggrFunc

-

UNSET

pagination.sortOption.aggregateBy.distinct

-

null

Return Type

V2ListComplianceClusterOverallStatsResponse

Content Type

  • application/json

Responses

Table 1. HTTP Response Codes
Code Message Datatype

200

A successful response.

V2ListComplianceClusterOverallStatsResponse

0

An unexpected error response.

RpcStatus

Samples

Common object reference

ProtobufAny

Field Name Required Nullable Type Description Format

@type

String

RpcStatus

Field Name Required Nullable Type Description Format

code

Integer

int32

message

String

details

List of ProtobufAny

V2ComplianceCheckStatus

Enum Values

UNSET_CHECK_STATUS

PASS

FAIL

ERROR

INFO

MANUAL

NOT_APPLICABLE

INCONSISTENT

V2ComplianceCheckStatusCount

Group the number of occurrences by status
Field Name Required Nullable Type Description Format

count

Integer

int32

status

V2ComplianceCheckStatus

UNSET_CHECK_STATUS, PASS, FAIL, ERROR, INFO, MANUAL, NOT_APPLICABLE, INCONSISTENT,

V2ComplianceClusterOverallStats

ComplianceClusterOverallStats provides overall stats for cluster
Field Name Required Nullable Type Description Format

cluster

V2ComplianceScanCluster

checkStats

List of V2ComplianceCheckStatusCount

clusterErrors

List of string

lastScanTime

Date

date-time

V2ComplianceScanCluster

Field Name Required Nullable Type Description Format

clusterId

String

clusterName

String

V2ListComplianceClusterOverallStatsResponse

ListComplianceCheckScanStatsResponse provides stats per cluster
Field Name Required Nullable Type Description Format

scanStats

List of V2ComplianceClusterOverallStats

totalCount

Integer

int32