GetAggregatedResults - ComplianceService | API 参考 | Red Hat Advanced Cluster Security for Kubernetes 4.6

GET /v1/compliance/aggregatedresults

描述 (Description)

参数 (Parameters)

查询参数 (Query Parameters)

名称 (Name) 描述 (Description) 必填 (Required) 默认值 (Default) 模式 (Pattern)

名称 (Name)	描述 (Description)	必填 (Required)	默认值 (Default)
groupBy	`字符串 (String)`	-	空 (null)
unit		-	UNKNOWN
where.query		-	空 (null)
where.pagination.limit		-	空 (null)
where.pagination.offset		-	空 (null)
where.pagination.sortOption.field		-	空 (null)
where.pagination.sortOption.reversed		-	空 (null)
where.pagination.sortOption.aggregateBy.aggrFunc		-	UNSET
where.pagination.sortOption.aggregateBy.distinct		-	空 (null)

groupBy

字符串 (String)

空 (null)

unit

UNKNOWN

where.query

空 (null)

where.pagination.limit

空 (null)

where.pagination.offset

空 (null)

where.pagination.sortOption.field

空 (null)

where.pagination.sortOption.reversed

空 (null)

where.pagination.sortOption.aggregateBy.aggrFunc

UNSET

where.pagination.sortOption.aggregateBy.distinct

空 (null)

返回类型 (Return Type)

StorageComplianceAggregationResponse

内容类型 (Content Type)

application/json

响应 (Responses)

表 1. HTTP 响应代码 (Table 1. HTTP Response Codes)
代码 (Code)	消息 (Message)	数据类型 (Datatype)
200	成功响应 (A successful response.)	StorageComplianceAggregationResponse
0	意外错误响应 (An unexpected error response.)	GooglerpcStatus

示例 (Samples)

常用对象引用 (Common object reference)

ComplianceAggregationAggregationKey

Next available tag: 3

字段名称 (Field Name)

必填 (Required)

可空 (Nullable)

类型 (Type)

描述 (Description)

格式 (Format)

scope

StorageComplianceAggregationScope

UNKNOWN, STANDARD, CLUSTER, CATEGORY, CONTROL, NAMESPACE, NODE, DEPLOYMENT, CHECK,

字符串 (String)

GooglerpcStatus

字段名称 (Field Name)

必填 (Required)

可空 (Nullable)

类型 (Type)

描述 (Description)

格式 (Format)

code

整数 (Integer)

int32

message

字符串 (String)

details

ProtobufAny 列表 (List of ProtobufAny)

ProtobufAny

Any包含任意序列化协议缓冲区消息以及描述序列化消息类型的URL。

Protobuf库提供支持，以实用程序函数或Any类型的其他生成方法的形式打包/解包Any值。

示例1：在C++中打包和解包消息。

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

示例2：在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 {
  ...
}

Protobuf库提供的pack方法默认使用'type.googleapis.com/full.type.name'作为类型URL，unpack方法仅使用类型URL中最后一个'/'后的完全限定类型名称，例如"foo.bar.com/x/y.z"将产生类型名称"y.z"。

JSON 表示 (JSON representation)

Any值的JSON表示使用反序列化、嵌入消息的常规表示，并添加一个包含类型URL的附加字段@type。示例 (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>
}

如果嵌入的消息类型是众所周知的并且具有自定义 JSON 表示，则该表示将被嵌入，并添加一个字段value，该字段除了@type字段外还包含自定义 JSON。示例（对于消息[google.protobuf.Duration][]）

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

字段名称 (Field Name) 必填 (Required) 可空 (Nullable) 类型 (Type) 描述 (Description) 格式 (Format)

字段名称 (Field Name)	必填 (Required)	可空 (Nullable)	类型 (Type)	描述 (Description)	格式 (Format)
@type			字符串 (String)	一个URL/资源名称，唯一标识序列化协议缓冲区消息的类型。此字符串必须包含至少一个“/”字符。URL路径的最后一部分必须表示类型的完全限定名称（如`path/google.protobuf.Duration`）。名称应采用规范形式（例如，不接受前导“.”）。实际上，团队通常会预编译它们期望在 Any 上下文中使用的所有类型到二进制文件中。但是，对于使用方案`http`、`https`或无方案的URL，可以选择设置一个类型服务器，将类型URL映射到消息定义，如下所示：* 如果没有提供方案，则假定为`https`。* 对URL的HTTP GET必须产生二进制格式的[google.protobuf.Type][]值，或产生错误。* 应用程序允许根据URL缓存查找结果，或将其预编译到二进制文件中以避免任何查找。因此，需要在类型更改时保留二进制兼容性。（使用版本化的类型名称来管理重大更改。）注意：此功能当前在官方protobuf版本中不可用，并且不适用于以type.googleapis.com开头的类型URL。截至2023年5月，没有广泛使用的类型服务器实现，也没有计划实现一个。除了`http`、`https`（或空方案）之外的其他方案可能会与特定于实现的语义一起使用。

@type

字符串 (String)

一个URL/资源名称，唯一标识序列化协议缓冲区消息的类型。此字符串必须包含至少一个“/”字符。URL路径的最后一部分必须表示类型的完全限定名称（如path/google.protobuf.Duration）。名称应采用规范形式（例如，不接受前导“.”）。实际上，团队通常会预编译它们期望在 Any 上下文中使用的所有类型到二进制文件中。但是，对于使用方案http、https或无方案的URL，可以选择设置一个类型服务器，将类型URL映射到消息定义，如下所示：* 如果没有提供方案，则假定为https。* 对URL的HTTP GET必须产生二进制格式的[google.protobuf.Type][]值，或产生错误。* 应用程序允许根据URL缓存查找结果，或将其预编译到二进制文件中以避免任何查找。因此，需要在类型更改时保留二进制兼容性。（使用版本化的类型名称来管理重大更改。）注意：此功能当前在官方protobuf版本中不可用，并且不适用于以type.googleapis.com开头的类型URL。截至2023年5月，没有广泛使用的类型服务器实现，也没有计划实现一个。除了http、https（或空方案）之外的其他方案可能会与特定于实现的语义一起使用。

StorageComplianceAggregationResponse

Next available tag: 3

字段名称 (Field Name)

必填 (Required)

可空 (Nullable)

类型 (Type)

描述 (Description)

格式 (Format)

results

StorageComplianceAggregationResult列表

sources

StorageComplianceAggregationSource列表

errorMessage

字符串 (String)

StorageComplianceAggregationResult

Next available tag: 5

字段名称 (Field Name)

必填 (Required)

可空 (Nullable)

类型 (Type)

描述 (Description)

格式 (Format)

aggregationKeys

ComplianceAggregationAggregationKey列表

unit

StorageComplianceAggregationScope

UNKNOWN, STANDARD, CLUSTER, CATEGORY, CONTROL, NAMESPACE, NODE, DEPLOYMENT, CHECK,

numPassing

整数 (Integer)

int32

numFailing

整数 (Integer)

int32

numSkipped

整数 (Integer)

int32

StorageComplianceAggregationScope

枚举值
UNKNOWN
STANDARD
CLUSTER
CATEGORY
CONTROL
NAMESPACE
NODE
DEPLOYMENT
CHECK

枚举值

UNKNOWN

STANDARD

CLUSTER

StorageComplianceAggregationSource

Next available tag: 5

字段名称 (Field Name)

必填 (Required)

可空 (Nullable)

类型 (Type)

描述 (Description)

格式 (Format)

clusterId

字符串 (String)

standardId

字符串 (String)

successfulRun

StorageComplianceRunMetadata

failedRuns

StorageComplianceRunMetadata列表

StorageComplianceRunMetadata

Next available tag: 5

字段名称 (Field Name)

必填 (Required)

可空 (Nullable)

类型 (Type)

描述 (Description)

格式 (Format)

runId

字符串 (String)

standardId

字符串 (String)

clusterId

字符串 (String)

startTimestamp

日期

日期时间

finishTimestamp

日期

日期时间

success

布尔值

errorMessage

字符串 (String)

domainId

字符串 (String)