GetNetworkPolicies - NetworkPolicyService | API reference | Red Hat Advanced Cluster Security for Kubernetes 4.6

GET /v1/networkpolicies

Description

Parameters

Query Parameters

Name	Required	Default
clusterId	-	null
deploymentQuery	-	null
namespace	-	null

Name

Description

Required

Default

Pattern

clusterId

null

deploymentQuery

null

namespace

null

Return Type

V1NetworkPoliciesResponse

Content Type

application/json

Responses

Table 1. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1NetworkPoliciesResponse
0	An unexpected error response.	GooglerpcStatus

Samples

Common object reference

GooglerpcStatus

Field Name

Required

Nullable

Type

Description

Format

code

Integer

int32

message

String

details

List of ProtobufAny

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

Field Name	Required	Nullable	Type	Description	Format
@type			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.

@type

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.

StorageIPBlock

Field Name Required Nullable Type Description Format

cidr

String

except

List of string

StorageLabelSelector

Label selector components are joined with logical AND, see     https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/

Next available tag: 3

Field Name Required Nullable Type Description Format

matchLabels

Map of string

This is actually a oneof, but we can’t make it one due to backwards compatibility constraints.

requirements

List of StorageLabelSelectorRequirement

StorageLabelSelectorOperator

Enum Values
UNKNOWN
IN
NOT_IN
EXISTS
NOT_EXISTS

Enum Values

UNKNOWN

NOT_IN

EXISTS

NOT_EXISTS

StorageLabelSelectorRequirement

Next available tag: 4

Field Name Required Nullable Type Description Format

key

String

StorageLabelSelectorOperator

UNKNOWN, IN, NOT_IN, EXISTS, NOT_EXISTS,

values

List of string

StorageNetworkPolicy

Field Name Required Nullable Type Description Format

String

name

String

clusterId

String

clusterName

String

namespace

String

labels

Map of string

annotations

Map of string

spec

StorageNetworkPolicySpec

yaml

String

apiVersion

String

created

Date

date-time

StorageNetworkPolicyEgressRule

Field Name

Required

Nullable

Type

Description

Format

ports

List of StorageNetworkPolicyPort

List of StorageNetworkPolicyPeer

StorageNetworkPolicyIngressRule

Field Name

Required

Nullable

Type

Description

Format

ports

List of StorageNetworkPolicyPort

from

List of StorageNetworkPolicyPeer

StorageNetworkPolicyPeer

Field Name

Required

Nullable

Type

Description

Format

podSelector

StorageLabelSelector

namespaceSelector

StorageLabelSelector

ipBlock

StorageIPBlock

StorageNetworkPolicyPort

Field Name

Required

Nullable

Type

Description

Format

protocol

StorageProtocol

UNSET_PROTOCOL, TCP_PROTOCOL, UDP_PROTOCOL, SCTP_PROTOCOL,

port

Integer

int32

portName

String

StorageNetworkPolicySpec

Field Name

Required

Nullable

Type

Description

Format

podSelector

StorageLabelSelector

ingress

List of StorageNetworkPolicyIngressRule

egress

List of StorageNetworkPolicyEgressRule

policyTypes

List of StorageNetworkPolicyType

StorageNetworkPolicyType

Enum Values
UNSET_NETWORK_POLICY_TYPE
INGRESS_NETWORK_POLICY_TYPE
EGRESS_NETWORK_POLICY_TYPE

Enum Values

UNSET_NETWORK_POLICY_TYPE

INGRESS_NETWORK_POLICY_TYPE

EGRESS_NETWORK_POLICY_TYPE

StorageProtocol

Enum Values
UNSET_PROTOCOL
TCP_PROTOCOL
UDP_PROTOCOL
SCTP_PROTOCOL

Enum Values

UNSET_PROTOCOL

TCP_PROTOCOL

UDP_PROTOCOL

SCTP_PROTOCOL

V1NetworkPoliciesResponse

Field Name

Required

Nullable

Type

Description

Format

networkPolicies

List of StorageNetworkPolicy