ProcessService | API reference | Red Hat Advanced Cluster Security for Kubernetes 4.5

CountProcesses

GET /v1/processcount

CountProcesses returns the count of processes.

Description

Parameters

Query Parameters

Name	Required	Default
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

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

Return Type

V1CountProcessesResponse

Content Type

application/json

Responses

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

Samples

GetGroupedProcessBydeployment

GET /v1/processes/deployment/{deploymentId}/grouped

GetGroupedProcessBydeployment returns all the processes executed grouped by deployment.

Description

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
deploymentId		X	null

Name

Description

Required

Default

Pattern

deploymentId

null

Return Type

V1GetGroupedProcessesResponse

Content Type

application/json

Responses

Table 2. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1GetGroupedProcessesResponse
0	An unexpected error response.	RuntimeError

Samples

GetGroupedProcessBydeploymentAndContainer

GET /v1/processes/deployment/{deploymentId}/grouped/container

GetGroupedProcessBydeploymentAndContainer returns all the processes executed grouped by deployment and container.

Description

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
deploymentId		X	null

Name

Description

Required

Default

Pattern

deploymentId

null

Return Type

V1GetGroupedProcessesWithContainerResponse

Content Type

application/json

Responses

Table 3. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1GetGroupedProcessesWithContainerResponse
0	An unexpected error response.	RuntimeError

Samples

GetProcessesBydeployment

GET /v1/processes/deployment/{deploymentId}

GetProcessesBydeployment returns the processes executed in the given deployment.

Description

Parameters

Path Parameters

Name	Description	Required	Default	Pattern
deploymentId		X	null

Name

Description

Required

Default

Pattern

deploymentId

null

Return Type

V1GetProcessesResponse

Content Type

application/json

Responses

Table 4. HTTP Response Codes
Code	Message	Datatype
200	A successful response.	V1GetProcessesResponse
0	An unexpected error response.	RuntimeError

Samples

Common object reference

ProcessSignalLineageInfo

Field Name

Required

Nullable

Type

Description

Format

parentUid

Long

int64

parentExecFilePath

String

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
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

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

RuntimeError

Field Name

Required

Nullable

Type

Description

Format

error

String

code

Integer

int32

message

String

details

List of ProtobufAny

StorageProcessIndicator

Next available tag: 13

Field Name

Required

Nullable

Type

Description

Format

String

deploymentId

String

containerName

String

podId

String

podUid

String

signal

StorageProcessSignal

clusterId

String

namespace

String

containerStartTime

Date

date-time

imageId

String

StorageProcessSignal

Field Name Required Nullable Type Description Format

String

A unique UUID for identifying the message We have this here instead of at the top level because we want to have each message to be self contained.

containerId

String

time

Date

date-time

name

String

args

String

execFilePath

String

pid

Long

int64

uid

Long

int64

gid

Long

int64

lineage

List of string

scraped

Boolean

lineageInfo

List of ProcessSignalLineageInfo

V1CountProcessesResponse

Field Name	Required	Nullable	Type	Description	Format
count			Integer		int32

Field Name

Required

Nullable

Type

Description

Format

count

Integer

int32

V1GetGroupedProcessesResponse

Field Name

Required

Nullable

Type

Description

Format

groups

List of V1ProcessNameGroup

V1GetGroupedProcessesWithContainerResponse

Field Name

Required

Nullable

Type

Description

Format

groups

List of V1ProcessNameAndContainerNameGroup

V1GetProcessesResponse

Field Name

Required

Nullable

Type

Description

Format

processes

List of StorageProcessIndicator

V1ProcessGroup

Field Name

Required

Nullable

Type

Description

Format

args

String

signals

List of StorageProcessIndicator

V1ProcessNameAndContainerNameGroup

Field Name

Required

Nullable

Type

Description

Format

name

String

containerName

String

timesExecuted

Long

int64

groups

List of V1ProcessGroup

suspicious

Boolean

V1ProcessNameGroup

Field Name

Required

Nullable

Type

Description

Format

name

String

timesExecuted

Long

int64

groups

List of V1ProcessGroup