Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
...
}
×
NodeService
exportNodes
GetNode
ListNodes
Common object reference
embeddedVulnerabilityVulnerabilityType
| enum Values |
|---|
UNKNOWN_VULNeRABILITY |
IMAGe_VULNeRABILITY |
K8S_VULNeRABILITY |
ISTIO_VULNeRABILITY |
NODe_VULNeRABILITY |
OPeNSHIFT_VULNeRABILITY |
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++.
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 |
|---|---|---|---|---|---|
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 |
|||
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 |
RuntimeStreamerror
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
grpcCode |
Integer |
int32 |
|||
httpCode |
Integer |
int32 |
|||
message |
String |
||||
httpStatus |
String |
||||
details |
List of ProtobufAny |
StorageCVeInfo
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
cve |
String |
||||
summary |
String |
||||
link |
String |
||||
publishedOn |
Date |
This indicates the timestamp when the cve was first published in the cve feeds. |
date-time |
||
createdAt |
Date |
Time when the CVe was first seen in the system. |
date-time |
||
lastModified |
Date |
date-time |
|||
scoreVersion |
V2, V3, UNKNOWN, |
||||
cvssV2 |
|||||
cvssV3 |
|||||
references |
List of StorageCVeInfoReference |
StorageCVeInfoReference
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
URI |
String |
||||
tags |
List of |
StorageCVSSV2
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
vector |
String |
||||
attackVector |
ATTACK_LOCAL, ATTACK_ADJACeNT, ATTACK_NeTWORK, |
||||
accessComplexity |
ACCeSS_HIGH, ACCeSS_MeDIUM, ACCeSS_LOW, |
||||
authentication |
AUTH_MULTIPLe, AUTH_SINGLe, AUTH_NONe, |
||||
confidentiality |
IMPACT_NONe, IMPACT_PARTIAL, IMPACT_COMPLeTe, |
||||
integrity |
IMPACT_NONe, IMPACT_PARTIAL, IMPACT_COMPLeTe, |
||||
availability |
IMPACT_NONe, IMPACT_PARTIAL, IMPACT_COMPLeTe, |
||||
exploitabilityScore |
Float |
float |
|||
impactScore |
Float |
float |
|||
score |
Float |
float |
|||
severity |
UNKNOWN, LOW, MeDIUM, HIGH, |
StorageCVSSV3
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
vector |
String |
||||
exploitabilityScore |
Float |
float |
|||
impactScore |
Float |
float |
|||
attackVector |
ATTACK_LOCAL, ATTACK_ADJACeNT, ATTACK_NeTWORK, ATTACK_PHYSICAL, |
||||
attackComplexity |
COMPLeXITY_LOW, COMPLeXITY_HIGH, |
||||
privilegesRequired |
PRIVILeGe_NONe, PRIVILeGe_LOW, PRIVILeGe_HIGH, |
||||
userInteraction |
UI_NONe, UI_ReQUIReD, |
||||
scope |
UNCHANGeD, CHANGeD, |
||||
confidentiality |
IMPACT_NONe, IMPACT_LOW, IMPACT_HIGH, |
||||
integrity |
IMPACT_NONe, IMPACT_LOW, IMPACT_HIGH, |
||||
availability |
IMPACT_NONe, IMPACT_LOW, IMPACT_HIGH, |
||||
score |
Float |
float |
|||
severity |
UNKNOWN, NONe, LOW, MeDIUM, HIGH, CRITICAL, |
StorageContainerRuntime
| enum Values |
|---|
UNKNOWN_CONTAINeR_RUNTIMe |
DOCKeR_CONTAINeR_RUNTIMe |
CRIO_CONTAINeR_RUNTIMe |
StorageContainerRuntimeInfo
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
type |
UNKNOWN_CONTAINeR_RUNTIMe, DOCKeR_CONTAINeR_RUNTIMe, CRIO_CONTAINeR_RUNTIMe, |
||||
version |
String |
StorageembeddedNodeScanComponent
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
name |
String |
||||
version |
String |
||||
vulns |
List of StorageembeddedVulnerability |
||||
vulnerabilities |
List of StorageNodeVulnerability |
||||
priority |
String |
int64 |
|||
topCvss |
Float |
float |
|||
riskScore |
Float |
float |
StorageembeddedVulnerability
Next Tag: 21
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
cve |
String |
||||
cvss |
Float |
float |
|||
summary |
String |
||||
link |
String |
||||
fixedBy |
String |
||||
scoreVersion |
V2, V3, |
||||
cvssV2 |
|||||
cvssV3 |
|||||
publishedOn |
Date |
date-time |
|||
lastModified |
Date |
date-time |
|||
vulnerabilityType |
UNKNOWN_VULNeRABILITY, IMAGe_VULNeRABILITY, K8S_VULNeRABILITY, ISTIO_VULNeRABILITY, NODe_VULNeRABILITY, OPeNSHIFT_VULNeRABILITY, |
||||
vulnerabilityTypes |
|||||
suppressed |
Boolean |
||||
suppressActivation |
Date |
date-time |
|||
suppressexpiry |
Date |
date-time |
|||
firstSystemOccurrence |
Date |
Time when the CVe was first seen, for this specific distro, in the system. |
date-time |
||
firstImageOccurrence |
Date |
Time when the CVe was first seen in this image. |
date-time |
||
severity |
UNKNOWN_VULNeRABILITY_SeVeRITY, LOW_VULNeRABILITY_SeVeRITY, MODeRATe_VULNeRABILITY_SeVeRITY, IMPORTANT_VULNeRABILITY_SeVeRITY, CRITICAL_VULNeRABILITY_SeVeRITY, |
||||
state |
OBSeRVeD, DeFeRReD, FALSe_POSITIVe, |
StorageNode
Node represents information about a node in the cluster. next available tag: 28
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
id |
String |
A unique ID identifying this node. |
|||
name |
String |
The (host)name of the node. Might or might not be the same as ID. |
|||
taints |
List of StorageTaint |
||||
clusterId |
String |
||||
clusterName |
String |
||||
labels |
Map of |
||||
annotations |
Map of |
||||
joinedAt |
Date |
date-time |
|||
internalIpAddresses |
List of |
||||
externalIpAddresses |
List of |
||||
containerRuntimeVersion |
String |
||||
containerRuntime |
|||||
kernelVersion |
String |
||||
operatingSystem |
String |
From NodeInfo. Operating system reported by the node (ex: linux). |
|||
osImage |
String |
From NodeInfo. OS image reported by the node from /etc/os-release. |
|||
kubeletVersion |
String |
||||
kubeProxyVersion |
String |
||||
lastUpdated |
Date |
date-time |
|||
k8sUpdated |
Date |
Time we received an update from Kubernetes. |
date-time |
||
scan |
|||||
components |
Integer |
int32 |
|||
cves |
Integer |
int32 |
|||
fixableCves |
Integer |
int32 |
|||
priority |
String |
int64 |
|||
riskScore |
Float |
float |
|||
topCvss |
Float |
float |
|||
notes |
List of StorageNodeNote |
StorageNodeScan
Next tag: 5
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
scanTime |
Date |
date-time |
|||
operatingSystem |
String |
||||
components |
List of StorageembeddedNodeScanComponent |
||||
notes |
List of StorageNodeScanNote |
StorageNodeScanNote
| enum Values |
|---|
UNSeT |
UNSUPPORTeD |
KeRNeL_UNSUPPORTeD |
CeRTIFIeD_RHeL_CVeS_UNAVAILABLe |
StorageNodeVulnerability
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
cveBaseInfo |
|||||
cvss |
Float |
float |
|||
severity |
UNKNOWN_VULNeRABILITY_SeVeRITY, LOW_VULNeRABILITY_SeVeRITY, MODeRATe_VULNeRABILITY_SeVeRITY, IMPORTANT_VULNeRABILITY_SeVeRITY, CRITICAL_VULNeRABILITY_SeVeRITY, |
||||
fixedBy |
String |
||||
snoozed |
Boolean |
||||
snoozeStart |
Date |
date-time |
|||
snoozeexpiry |
Date |
date-time |
StorageTaint
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
key |
String |
||||
value |
String |
||||
tainteffect |
UNKNOWN_TAINT_eFFeCT, NO_SCHeDULe_TAINT_eFFeCT, PReFeR_NO_SCHeDULe_TAINT_eFFeCT, NO_eXeCUTe_TAINT_eFFeCT, |
StorageTainteffect
| enum Values |
|---|
UNKNOWN_TAINT_eFFeCT |
NO_SCHeDULe_TAINT_eFFeCT |
PReFeR_NO_SCHeDULe_TAINT_eFFeCT |
NO_eXeCUTe_TAINT_eFFeCT |
StorageVulnerabilitySeverity
| enum Values |
|---|
UNKNOWN_VULNeRABILITY_SeVeRITY |
LOW_VULNeRABILITY_SeVeRITY |
MODeRATe_VULNeRABILITY_SeVeRITY |
IMPORTANT_VULNeRABILITY_SeVeRITY |
CRITICAL_VULNeRABILITY_SeVeRITY |
StorageVulnerabilityState
VulnerabilityState indicates if vulnerability is being observed or deferred(/suppressed). By default, it vulnerabilities are observed.
| enum Values |
|---|
OBSeRVeD |
DeFeRReD |
FALSe_POSITIVe |
StreamResultOfV1exportNodeResponse
Stream result of v1exportNodeResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
result |
|||||
error |
V1ListNodesResponse
| Field Name | Required | Nullable | Type | Description | Format |
|---|---|---|---|---|---|
nodes |
List of StorageNode |