This is a cache of https://docs.openshift.com/acs/4.5/api/ReportConfigurationService.html. It is a snapshot of the page at 2024-11-25T18:12:42.917+0000.
R<strong>e</strong>portConfigurationS<strong>e</strong>rvic<strong>e</strong> | API r<strong>e</strong>f<strong>e</strong>r<strong>e</strong>nc<strong>e</strong> | R<strong>e</strong>d Hat Advanc<strong>e</strong>d Clust<strong>e</strong>r S<strong>e</strong>curity for Kub<strong>e</strong>rn<strong>e</strong>t<strong>e</strong>s 4.5
&times;

CountReportConfigurations

GeT /v1/report-configurations-count

CountReportConfigurations returns the number of report configurations.

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

Content Type

  • application/json

Responses

Table 1. HTTP Response Codes
Code Message Datatype

200

A successful response.

V1CountReportConfigurationsResponse

0

An unexpected error response.

Runtimeerror

Samples

DeleteReportConfiguration

DeLeTe /v1/report/configurations/{id}

DeleteReportConfiguration removes a report configuration given its id

Description

Parameters

Path Parameters

Name Description Required Default Pattern

id

X

null

Return Type

Object

Content Type

  • application/json

Responses

Table 2. HTTP Response Codes
Code Message Datatype

200

A successful response.

Object

0

An unexpected error response.

Runtimeerror

Samples

GetReportConfiguration

GeT /v1/report/configurations/{id}

Description

Parameters

Path Parameters

Name Description Required Default Pattern

id

X

null

Content Type

  • application/json

Responses

Table 3. HTTP Response Codes
Code Message Datatype

200

A successful response.

V1GetReportConfigurationResponse

0

An unexpected error response.

Runtimeerror

Samples

GetReportConfigurations

GeT /v1/report/configurations

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

Content Type

  • application/json

Responses

Table 4. HTTP Response Codes
Code Message Datatype

200

A successful response.

V1GetReportConfigurationsResponse

0

An unexpected error response.

Runtimeerror

Samples

PostReportConfiguration

POST /v1/report/configurations

PostReportConfiguration creates a report configuration

Description

Parameters

Body Parameter

Name Description Required Default Pattern

body

V1PostReportConfigurationRequest

X

Content Type

  • application/json

Responses

Table 5. HTTP Response Codes
Code Message Datatype

200

A successful response.

V1PostReportConfigurationResponse

0

An unexpected error response.

Runtimeerror

Samples

UpdateReportConfiguration

PUT /v1/report/configurations/{id}

UpdateReportConfiguration updates a report configuration

Description

Parameters

Path Parameters

Name Description Required Default Pattern

id

X

null

Body Parameter

Name Description Required Default Pattern

body

V1UpdateReportConfigurationRequest

X

Return Type

Object

Content Type

  • application/json

Responses

Table 6. HTTP Response Codes
Code Message Datatype

200

A successful response.

Object

0

An unexpected error response.

Runtimeerror

Samples

Common object reference

ProtobufAny

Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.

Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.

example 1: Pack and unpack a message in C++.

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

example 2: Pack and unpack a message in Java.

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}
example 3: Pack and unpack a message in Python.
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DeSCRIPTOR):
  any.Unpack(foo)
  ...
example 4: Pack and unpack a message in Go
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

The pack methods provided by protobuf library will by default use 'type.googleapis.com/full.type.name' as the type URL and the unpack methods only use the fully qualified type name after the last '/' in the type URL, for example "foo.bar.com/x/y.z" will yield type name "y.z".

JSON representation

The JSON representation of an Any value uses the regular representation of the deserialized, embedded message, with an additional field @type which contains the type URL. example:

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}
{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

If the embedded message type is well-known and has a custom JSON representation, that representation will be embedded adding a field value which holds the custom JSON in addition to the @type field. example (for message [google.protobuf.Duration][]):

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
Field Name Required Nullable Type Description Format

typeUrl

String

A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one \"/\" character. The last segment of the URL’s path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading \".\" is not accepted). In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows: * If no scheme is provided, https is assumed. * An HTTP GeT on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error. * Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.) Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one. Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.

value

byte[]

Must be a valid serialized protocol buffer of the above specified type.

byte

ReportConfigurationReportType

enum Values

VULNeRABILITY

ReportLastRunStatusRunStatus

enum Values

SUCCeSS

FAILURe

Runtimeerror

Field Name Required Nullable Type Description Format

error

String

code

Integer

int32

message

String

details

List of ProtobufAny

ScheduleDaysOfMonth

1 for 1st, 2 for 2nd .... 31 for 31st
Field Name Required Nullable Type Description Format

days

List of integer

int32

ScheduleDaysOfWeek

Sunday = 0, Monday = 1, .... Saturday =  6
Field Name Required Nullable Type Description Format

days

List of integer

int32

ScheduleIntervalType

enum Values

UNSeT

DAILY

WeeKLY

MONTHLY

ScheduleWeeklyInterval

Field Name Required Nullable Type Description Format

day

Integer

int32

SimpleAccessScopeRules

each element of any repeated field is an individual rule. Rules are joined by logical OR: if there exists a rule allowing resource x, x is in the access scope.

Field Name Required Nullable Type Description Format

includedClusters

List of string

includedNamespaces

List of SimpleAccessScopeRulesNamespace

clusterLabelSelectors

List of StorageSetBasedLabelSelector

namespaceLabelSelectors

List of StorageSetBasedLabelSelector

SimpleAccessScopeRulesNamespace

Field Name Required Nullable Type Description Format

clusterName

String

Both fields must be set.

namespaceName

String

StorageemailNotifierConfiguration

Field Name Required Nullable Type Description Format

notifierId

String

mailingLists

List of string

customSubject

String

customBody

String

StorageNotifierConfiguration

Field Name Required Nullable Type Description Format

emailConfig

StorageemailNotifierConfiguration

id

String

StorageReportConfiguration

Field Name Required Nullable Type Description Format

id

String

name

String

description

String

type

ReportConfigurationReportType

VULNeRABILITY,

vulnReportFilters

StorageVulnerabilityReportFilters

scopeId

String

emailConfig

StorageemailNotifierConfiguration

schedule

StorageSchedule

lastRunStatus

StorageReportLastRunStatus

lastSuccessfulRunTime

Date

date-time

resourceScope

StorageResourceScope

notifiers

List of StorageNotifierConfiguration

creator

StorageSlimUser

version

Integer

int32

StorageReportLastRunStatus

Field Name Required Nullable Type Description Format

reportStatus

ReportLastRunStatusRunStatus

SUCCeSS, FAILURe,

lastRunTime

Date

date-time

errorMsg

String

StorageResourceScope

Field Name Required Nullable Type Description Format

collectionId

String

StorageSchedule

Field Name Required Nullable Type Description Format

intervalType

ScheduleIntervalType

UNSeT, DAILY, WeeKLY, MONTHLY,

hour

Integer

int32

minute

Integer

int32

weekly

ScheduleWeeklyInterval

daysOfWeek

ScheduleDaysOfWeek

daysOfMonth

ScheduleDaysOfMonth

StorageSetBasedLabelSelector

SetBasedLabelSelector only allows set-based label requirements.

Next available tag: 3

Field Name Required Nullable Type Description Format

requirements

List of StorageSetBasedLabelSelectorRequirement

StorageSetBasedLabelSelectorOperator

enum Values

UNKNOWN

IN

NOT_IN

eXISTS

NOT_eXISTS

StorageSetBasedLabelSelectorRequirement

Next available tag: 4
Field Name Required Nullable Type Description Format

key

String

op

StorageSetBasedLabelSelectorOperator

UNKNOWN, IN, NOT_IN, eXISTS, NOT_eXISTS,

values

List of string

StorageSlimUser

Field Name Required Nullable Type Description Format

id

String

name

String

StorageVulnerabilityReportFilters

Field Name Required Nullable Type Description Format

fixability

VulnerabilityReportFiltersFixability

BOTH, FIXABLe, NOT_FIXABLe,

sinceLastReport

Boolean

severities

List of StorageVulnerabilitySeverity

imageTypes

List of VulnerabilityReportFiltersImageType

allVuln

Boolean

sinceLastSentScheduledReport

Boolean

sinceStartDate

Date

date-time

accessScopeRules

List of SimpleAccessScopeRules

StorageVulnerabilitySeverity

enum Values

UNKNOWN_VULNeRABILITY_SeVeRITY

LOW_VULNeRABILITY_SeVeRITY

MODeRATe_VULNeRABILITY_SeVeRITY

IMPORTANT_VULNeRABILITY_SeVeRITY

CRITICAL_VULNeRABILITY_SeVeRITY

V1CountReportConfigurationsResponse

Field Name Required Nullable Type Description Format

count

Integer

int32

V1GetReportConfigurationResponse

Field Name Required Nullable Type Description Format

reportConfig

StorageReportConfiguration

V1GetReportConfigurationsResponse

Field Name Required Nullable Type Description Format

reportConfigs

List of StorageReportConfiguration

V1PostReportConfigurationRequest

Field Name Required Nullable Type Description Format

reportConfig

StorageReportConfiguration

V1PostReportConfigurationResponse

Field Name Required Nullable Type Description Format

reportConfig

StorageReportConfiguration

V1UpdateReportConfigurationRequest

Field Name Required Nullable Type Description Format

id

String

reportConfig

StorageReportConfiguration

VulnerabilityReportFiltersFixability

enum Values

BOTH

FIXABLe

NOT_FIXABLe

VulnerabilityReportFiltersImageType

enum Values

DePLOYeD

WATCHeD