获取外部网络实体 - NetworkGraphService | API 参考 | Red Hat Advanced Cluster Security for Kubernetes 4.6

GET /v1/networkgraph/cluster/{clusterId}/externalentities

描述 (Description)

参数 (Parameters)

路径参数 (Path Parameters)

名称 (Name)	描述 (Description)	必填 (Required)	默认值 (Default)	模式 (Pattern)
集群ID (clusterId)		是 (X)	空 (null)

名称 (Name)

描述 (Description)

必填 (Required)

默认值 (Default)

模式 (Pattern)

集群ID (clusterId)

是 (X)

空 (null)

查询参数 (Query Parameters)

名称 (Name)	描述 (Description)	必填 (Required)	默认值 (Default)	模式 (Pattern)
查询 (query)		-	空 (null)

名称 (Name)

描述 (Description)

必填 (Required)

默认值 (Default)

模式 (Pattern)

查询 (query)

空 (null)

返回类型 (Return Type)

V1GetExternalNetworkEntitiesResponse

内容类型 (Content Type)

application/json

响应 (Responses)

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

示例 (Samples)

常用对象引用 (Common object reference)

DeploymentListenPort

字段名称 (Field Name)	必填 (Required)	可为空 (Nullable)	类型 (Type)	描述 (Description)	格式 (Format)
端口 (port)			长整型 (Long)		int64
4层协议 (l4protocol)			StorageL4Protocol		L4_PROTOCOL_UNKNOWN, L4_PROTOCOL_TCP, L4_PROTOCOL_UDP, L4_PROTOCOL_ICMP, L4_PROTOCOL_RAW, L4_PROTOCOL_SCTP, L4_PROTOCOL_ANY,

字段名称 (Field Name)

必填 (Required)

可为空 (Nullable)

类型 (Type)

描述 (Description)

格式 (Format)

端口 (port)

长整型 (Long)

int64

4层协议 (l4protocol)

StorageL4Protocol

L4_PROTOCOL_UNKNOWN, L4_PROTOCOL_TCP, L4_PROTOCOL_UDP, L4_PROTOCOL_ICMP, L4_PROTOCOL_RAW, L4_PROTOCOL_SCTP, L4_PROTOCOL_ANY,

GooglerpcStatus

字段名称 (Field Name)

必填 (Required)

可为空 (Nullable)

类型 (Type)

描述 (Description)

格式 (Format)

代码 (code)

整数 (Integer)

int32

消息 (message)

字符串 (String)

细节 (details)

ProtobufAny 列表 (List of ProtobufAny)

NetworkEntityInfoExternalSource

更新 central/networkgraph/aggregator/aggregator.go 中的 normalizeDupNameExtSrcs(…) 方法，以适应此消息的更新。(Update normalizeDupNameExtSrcs(…) in central/networkgraph/aggregator/aggregator.go whenever this message is updated.)

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

名称 (name)

字符串 (String)

CIDR (cidr)

字符串 (String)

默认 (default)

布尔值 (Boolean)

default 指示外部来源是用户生成的还是系统生成的。(default indicates whether the external source is user-generated or system-generated.)

已发现 (discovered)

布尔值 (Boolean)

discovered 指示外部来源是否是从监控流量中收集的。(discovered indicates whether the external source is harvested from monitored traffic.)

ProtobufAny

Any 包含任意序列化的协议缓冲区消息以及描述序列化消息类型的 URL。(Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message.)

Protobuf 库提供支持，以实用程序函数或 Any 类型的附加生成方法的形式打包/解包 Any 值。(Protobuf library provides support to pack/unpack Any values in the form of utility functions or additional generated methods of the Any type.)

示例 1：在 C++ 中打包和解包消息。(Example 1: Pack and unpack a message in C++.)

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

示例 2：在 Java 中打包和解包消息。(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 {
  ...
}

Protobuf 库提供的 pack 方法默认使用 'type.googleapis.com/full.type.name' 作为类型 URL，而 unpack 方法仅使用类型 URL 中最后一个 '/' 后的完全限定类型名称，例如 "foo.bar.com/x/y.z" 将产生类型名称 "y.z"。(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 表示 (JSON representation)

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 表示，则该表示将被嵌入，并添加一个字段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（或空方案）以外的方案可能会与特定于实现的语义一起使用。

StorageL4Protocol

枚举值
L4_PROTOCOL_UNKNOWN
L4_PROTOCOL_TCP
L4_PROTOCOL_UDP
L4_PROTOCOL_ICMP
L4_PROTOCOL_RAW
L4_PROTOCOL_SCTP
L4_PROTOCOL_ANY

枚举值

L4_PROTOCOL_UNKNOWN

L4_PROTOCOL_TCP

L4_PROTOCOL_UDP

L4_PROTOCOL_ICMP

L4_PROTOCOL_RAW

L4_PROTOCOL_SCTP

L4_PROTOCOL_ANY

StorageNetworkEntity

字段名称 (Field Name)

必填 (Required)

可为空 (Nullable)

类型 (Type)

描述 (Description)

格式 (Format)

信息

StorageNetworkEntityInfo

范围

StorageNetworkEntityScope

StorageNetworkEntityInfo

字段名称 (Field Name)

必填 (Required)

可为空 (Nullable)

类型 (Type)

描述 (Description)

格式 (Format)

类型

StorageNetworkEntityInfoType

UNKNOWN_TYPE, DEPLOYMENT, INTERNET, LISTEN_ENDPOINT, EXTERNAL_SOURCE, INTERNAL_ENTITIES,

字符串 (String)

部署

StorageNetworkEntityInfoDeployment

外部来源

NetworkEntityInfoExternalSource

StorageNetworkEntityInfoDeployment

字段名称 (Field Name)

必填 (Required)

可为空 (Nullable)

类型 (Type)

描述 (Description)

格式 (Format)

名称 (name)

字符串 (String)

命名空间

字符串 (String)

集群

字符串 (String)

监听端口

DeploymentListenPort 列表

StorageNetworkEntityInfoType

INTERNAL_ENTITIES：INTERNAL_ENTITIES 用于将所有内部实体分组到单个网络图节点下

枚举值
UNKNOWN_TYPE
DEPLOYMENT
INTERNET
LISTEN_ENDPOINT
EXTERNAL_SOURCE
INTERNAL_ENTITIES

枚举值

UNKNOWN_TYPE

DEPLOYMENT

INTERNET

LISTEN_ENDPOINT

EXTERNAL_SOURCE

INTERNAL_ENTITIES

StorageNetworkEntityScope

字段名称 (Field Name)

必填 (Required)

可为空 (Nullable)

类型 (Type)

描述 (Description)

格式 (Format)

集群ID (clusterId)

字符串 (String)

V1GetExternalNetworkEntitiesResponse

字段名称 (Field Name)

必填 (Required)

可为空 (Nullable)

类型 (Type)

描述 (Description)

格式 (Format)

实体

StorageNetworkEntity 列表