搜索 - SearchService | API 参考 | Red Hat Advanced Cluster Security for Kubernetes 4.6

描述

参数

查询参数

名称描述必填默认值模式

名称	描述	必填	默认值	模式
query		-	空
categories	`字符串`	-	空

query

-

空

返回类型

V1SearchResponse

内容类型

application/json

响应

表 1. HTTP 响应代码
代码	消息	数据类型
200	成功的响应。	V1SearchResponse
0	意外的错误响应。	GooglerpcStatus

示例

公共对象引用

GooglerpcStatus

字段名称

必填

可为空

类型

描述

格式

code

整数

int32

message

字符串

details

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 库提供的打包方法默认使用 'type.googleapis.com/full.type.name' 作为类型 URL，而解包方法只使用类型 URL 中最后一个 '/' 后面的完整限定类型名称，例如 "foo.bar.com/x/y.z" 将产生类型名称 "y.z"。

JSON 表示

Any 值的 JSON 表示使用反序列化、嵌入消息的常规表示，并添加一个包含类型 URL 的附加字段 @type。示例

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 表示，则该表示将被嵌入，除了 @type 字段外，还会添加一个包含自定义 JSON 的 value 字段。示例（对于消息 [google.protobuf.Duration][]）

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

字段名称必填可为空类型描述格式

字段名称	必填	可为空	类型	描述	格式
@type			字符串	一个唯一标识序列化协议缓冲区消息类型的 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

字符串

一个唯一标识序列化协议缓冲区消息类型的 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（或空方案）之外的方案，并具有特定于实现的语义。

SearchResponseCount

字段名称	必填	可为空	类型	描述	格式
类别			V1SearchCategory		SEARCH_UNSET, ALERTS, IMAGES, IMAGE_COMPONENTS, IMAGE_VULN_EDGE, IMAGE_COMPONENT_EDGE, POLICIES, DEPLOYMENTS, ACTIVE_COMPONENT, PODS, SECRETS, PROCESS_INDICATORS, COMPLIANCE, CLUSTERS, NAMESPACES, NODES, NODE_COMPONENTS, NODE_VULN_EDGE, NODE_COMPONENT_EDGE, NODE_COMPONENT_CVE_EDGE, COMPLIANCE_STANDARD, COMPLIANCE_CONTROL_GROUP, COMPLIANCE_CONTROL, SERVICE_ACCOUNTS, ROLES, ROLEBINDINGS, REPORT_CONFIGURATIONS, PROCESS_BASELINES, SUBJECTS, RISKS, VULNERABILITIES, CLUSTER_VULNERABILITIES, IMAGE_VULNERABILITIES, NODE_VULNERABILITIES, COMPONENT_VULN_EDGE, CLUSTER_VULN_EDGE, NETWORK_ENTITY, VULN_REQUEST, NETWORK_BASELINE, NETWORK_POLICIES, PROCESS_BASELINE_RESULTS, COMPLIANCE_METADATA, COMPLIANCE_RESULTS, COMPLIANCE_DOMAIN, CLUSTER_HEALTH, POLICY_CATEGORIES, IMAGE_INTEGRATIONS, COLLECTIONS, POLICY_CATEGORY_EDGE, PROCESS_LISTENING_ON_PORT, API_TOKEN, REPORT_METADATA, REPORT_SNAPSHOT, COMPLIANCE_INTEGRATIONS, COMPLIANCE_SCAN_CONFIG, COMPLIANCE_SCAN, COMPLIANCE_CHECK_RESULTS, BLOB, ADMINISTRATION_EVENTS, COMPLIANCE_SCAN_CONFIG_STATUS, ADMINISTRATION_USAGE, COMPLIANCE_PROFILES, COMPLIANCE_RULES, COMPLIANCE_SCAN_SETTING_BINDINGS, COMPLIANCE_SUITES, CLOUD_SOURCES, DISCOVERED_CLUSTERS, COMPLIANCE_REMEDIATIONS, COMPLIANCE_BENCHMARKS, AUTH_PROVIDERS, COMPLIANCE_REPORT_SNAPSHOT,
计数			字符串		int64

字段名称

必填

可为空

类型

描述

格式

类别

V1SearchCategory

SEARCH_UNSET, ALERTS, IMAGES, IMAGE_COMPONENTS, IMAGE_VULN_EDGE, IMAGE_COMPONENT_EDGE, POLICIES, DEPLOYMENTS, ACTIVE_COMPONENT, PODS, SECRETS, PROCESS_INDICATORS, COMPLIANCE, CLUSTERS, NAMESPACES, NODES, NODE_COMPONENTS, NODE_VULN_EDGE, NODE_COMPONENT_EDGE, NODE_COMPONENT_CVE_EDGE, COMPLIANCE_STANDARD, COMPLIANCE_CONTROL_GROUP, COMPLIANCE_CONTROL, SERVICE_ACCOUNTS, ROLES, ROLEBINDINGS, REPORT_CONFIGURATIONS, PROCESS_BASELINES, SUBJECTS, RISKS, VULNERABILITIES, CLUSTER_VULNERABILITIES, IMAGE_VULNERABILITIES, NODE_VULNERABILITIES, COMPONENT_VULN_EDGE, CLUSTER_VULN_EDGE, NETWORK_ENTITY, VULN_REQUEST, NETWORK_BASELINE, NETWORK_POLICIES, PROCESS_BASELINE_RESULTS, COMPLIANCE_METADATA, COMPLIANCE_RESULTS, COMPLIANCE_DOMAIN, CLUSTER_HEALTH, POLICY_CATEGORIES, IMAGE_INTEGRATIONS, COLLECTIONS, POLICY_CATEGORY_EDGE, PROCESS_LISTENING_ON_PORT, API_TOKEN, REPORT_METADATA, REPORT_SNAPSHOT, COMPLIANCE_INTEGRATIONS, COMPLIANCE_SCAN_CONFIG, COMPLIANCE_SCAN, COMPLIANCE_CHECK_RESULTS, BLOB, ADMINISTRATION_EVENTS, COMPLIANCE_SCAN_CONFIG_STATUS, ADMINISTRATION_USAGE, COMPLIANCE_PROFILES, COMPLIANCE_RULES, COMPLIANCE_SCAN_SETTING_BINDINGS, COMPLIANCE_SUITES, CLOUD_SOURCES, DISCOVERED_CLUSTERS, COMPLIANCE_REMEDIATIONS, COMPLIANCE_BENCHMARKS, AUTH_PROVIDERS, COMPLIANCE_REPORT_SNAPSHOT,

计数

字符串

int64

SearchResultMatches

字段名称必填可为空类型描述格式

值

string 列表

V1SearchCategory

Next available tag: 74

枚举值
SEARCH_UNSET
ALERTS
IMAGES
IMAGE_COMPONENTS
IMAGE_VULN_EDGE
IMAGE_COMPONENT_EDGE
POLICIES
DEPLOYMENTS
ACTIVE_COMPONENT
PODS
SECRETS
PROCESS_INDICATORS
COMPLIANCE
CLUSTERS
NAMESPACES
NODES
NODE_COMPONENTS
NODE_VULN_EDGE
NODE_COMPONENT_EDGE
NODE_COMPONENT_CVE_EDGE
COMPLIANCE_STANDARD
COMPLIANCE_CONTROL_GROUP
COMPLIANCE_CONTROL
SERVICE_ACCOUNTS
ROLES
ROLEBINDINGS
REPORT_CONFIGURATIONS
PROCESS_BASELINES
SUBJECTS
RISKS
VULNERABILITIES
CLUSTER_VULNERABILITIES
IMAGE_VULNERABILITIES
NODE_VULNERABILITIES
COMPONENT_VULN_EDGE
CLUSTER_VULN_EDGE
NETWORK_ENTITY
VULN_REQUEST
NETWORK_BASELINE
NETWORK_POLICIES
PROCESS_BASELINE_RESULTS
COMPLIANCE_METADATA
COMPLIANCE_RESULTS
COMPLIANCE_DOMAIN
CLUSTER_HEALTH
POLICY_CATEGORIES
IMAGE_INTEGRATIONS
COLLECTIONS
POLICY_CATEGORY_EDGE
PROCESS_LISTENING_ON_PORT
API_TOKEN
REPORT_METADATA
REPORT_SNAPSHOT
COMPLIANCE_INTEGRATIONS
COMPLIANCE_SCAN_CONFIG
COMPLIANCE_SCAN
COMPLIANCE_CHECK_RESULTS
BLOB
ADMINISTRATION_EVENTS
COMPLIANCE_SCAN_CONFIG_STATUS
ADMINISTRATION_USAGE
COMPLIANCE_PROFILES
COMPLIANCE_RULES
COMPLIANCE_SCAN_SETTING_BINDINGS
COMPLIANCE_SUITES
CLOUD_SOURCES
DISCOVERED_CLUSTERS
COMPLIANCE_REMEDIATIONS
COMPLIANCE_BENCHMARKS
AUTH_PROVIDERS
COMPLIANCE_REPORT_SNAPSHOT

枚举值

SEARCH_UNSET

ALERTS

IMAGES

IMAGE_COMPONENTS

IMAGE_VULN_EDGE

IMAGE_COMPONENT_EDGE

POLICIES

DEPLOYMENTS

ACTIVE_COMPONENT

PODS

SECRETS

PROCESS_INDICATORS

COMPLIANCE

CLUSTERS

NAMESPACES

NODES

NODE_COMPONENTS

NODE_VULN_EDGE

NODE_COMPONENT_EDGE

NODE_COMPONENT_CVE_EDGE

COMPLIANCE_STANDARD

COMPLIANCE_CONTROL_GROUP

COMPLIANCE_CONTROL

SERVICE_ACCOUNTS

ROLES

ROLEBINDINGS

REPORT_CONFIGURATIONS

PROCESS_BASELINES

SUBJECTS

RISKS

VULNERABILITIES

CLUSTER_VULNERABILITIES

IMAGE_VULNERABILITIES

NODE_VULNERABILITIES

COMPONENT_VULN_EDGE

CLUSTER_VULN_EDGE

NETWORK_ENTITY

VULN_REQUEST

NETWORK_BASELINE

NETWORK_POLICIES

PROCESS_BASELINE_RESULTS

COMPLIANCE_METADATA

COMPLIANCE_RESULTS

COMPLIANCE_DOMAIN

CLUSTER_HEALTH

POLICY_CATEGORIES

IMAGE_INTEGRATIONS

COLLECTIONS

POLICY_CATEGORY_EDGE

PROCESS_LISTENING_ON_PORT

API_TOKEN

REPORT_METADATA

REPORT_SNAPSHOT

COMPLIANCE_INTEGRATIONS

COMPLIANCE_SCAN_CONFIG

COMPLIANCE_SCAN

COMPLIANCE_CHECK_RESULTS

BLOB

ADMINISTRATION_EVENTS

COMPLIANCE_SCAN_CONFIG_STATUS

ADMINISTRATION_USAGE

COMPLIANCE_PROFILES

COMPLIANCE_RULES

COMPLIANCE_SCAN_SETTING_BINDINGS

COMPLIANCE_SUITES

CLOUD_SOURCES

DISCOVERED_CLUSTERS

COMPLIANCE_REMEDIATIONS

COMPLIANCE_BENCHMARKS

AUTH_PROVIDERS

COMPLIANCE_REPORT_SNAPSHOT

V1SearchResponse

字段名称

必填

可为空

类型

描述

格式

结果

V1SearchResult 列表

计数

SearchResponseCount 列表

V1SearchResult

字段名称

必填

可为空

类型

描述

格式

ID

字符串

名称

字符串

类别

V1SearchCategory

SEARCH_UNSET, ALERTS, IMAGES, IMAGE_COMPONENTS, IMAGE_VULN_EDGE, IMAGE_COMPONENT_EDGE, POLICIES, DEPLOYMENTS, ACTIVE_COMPONENT, PODS, SECRETS, PROCESS_INDICATORS, COMPLIANCE, CLUSTERS, NAMESPACES, NODES, NODE_COMPONENTS, NODE_VULN_EDGE, NODE_COMPONENT_EDGE, NODE_COMPONENT_CVE_EDGE, COMPLIANCE_STANDARD, COMPLIANCE_CONTROL_GROUP, COMPLIANCE_CONTROL, SERVICE_ACCOUNTS, ROLES, ROLEBINDINGS, REPORT_CONFIGURATIONS, PROCESS_BASELINES, SUBJECTS, RISKS, VULNERABILITIES, CLUSTER_VULNERABILITIES, IMAGE_VULNERABILITIES, NODE_VULNERABILITIES, COMPONENT_VULN_EDGE, CLUSTER_VULN_EDGE, NETWORK_ENTITY, VULN_REQUEST, NETWORK_BASELINE, NETWORK_POLICIES, PROCESS_BASELINE_RESULTS, COMPLIANCE_METADATA, COMPLIANCE_RESULTS, COMPLIANCE_DOMAIN, CLUSTER_HEALTH, POLICY_CATEGORIES, IMAGE_INTEGRATIONS, COLLECTIONS, POLICY_CATEGORY_EDGE, PROCESS_LISTENING_ON_PORT, API_TOKEN, REPORT_METADATA, REPORT_SNAPSHOT, COMPLIANCE_INTEGRATIONS, COMPLIANCE_SCAN_CONFIG, COMPLIANCE_SCAN, COMPLIANCE_CHECK_RESULTS, BLOB, ADMINISTRATION_EVENTS, COMPLIANCE_SCAN_CONFIG_STATUS, ADMINISTRATION_USAGE, COMPLIANCE_PROFILES, COMPLIANCE_RULES, COMPLIANCE_SCAN_SETTING_BINDINGS, COMPLIANCE_SUITES, CLOUD_SOURCES, DISCOVERED_CLUSTERS, COMPLIANCE_REMEDIATIONS, COMPLIANCE_BENCHMARKS, AUTH_PROVIDERS, COMPLIANCE_REPORT_SNAPSHOT,

字段匹配

SearchResultMatches 映射

分数

双精度浮点数

double

位置

字符串

位置旨在成为结果的唯一且易于理解的标识符。例如，对于部署，位置将是“$cluster_name/$namespace/$deployment_name”。它在全局搜索结果的 UI 中显示，位于每个结果名称的下方。