×

GET /v1/clusters/{id}

描述

参数

路径参数

名称 描述 必填 默认值 模式

id

null

返回类型

内容类型

  • application/json

响应

表 1. HTTP 响应代码
代码 消息 数据类型

200

成功的响应。

V1ClusterResponse

0

意外的错误响应。

GooglerpcStatus

示例

常用对象引用

ClusterHealthStatusHealthStatusLabel

  • UNAVAILABLE: 只有收集器可以具有不可用状态

枚举值

UNINITIALIZED

UNAVAILABLE

UNHEALTHY

DEGRADED

HEALTHY

ClusterUpgradeStatusUpgradability

  • SENSOR_VERSION_HIGHER: 当我们检测到传感器运行的版本高于此中心时,会发生 SENSOR_VERSION_HIGHER。这是意外情况,但根据客户执行的补丁程序可能会发生。在这种情况下,我们不会自动“升级”传感器,因为这将是降级,即使自动升级设置已开启。用户将被允许手动触发升级,但强烈建议他们在先升级中心之前不要这样做,因为这是不受支持的配置。

枚举值

UNSET

UP_TO_DATE

MANUAL_UPGRADE_REQUIRED

AUTO_UPGRADE_POSSIBLE

SENSOR_VERSION_HIGHER

ClusterUpgradeStatusUpgradeProcessStatus

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

active

布尔型

id

字符串

targetVersion

字符串

upgraderImage

字符串

initiatedAt

日期

日期时间

progress

StorageUpgradeProgress

type

UpgradeProcessStatusUpgradeProcessType

UPGRADE, CERT_ROTATION,

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 表示,则该表示将被嵌入,并添加一个包含自定义 JSON 的字段 value,以及 @type 字段。示例(对于消息 [google.protobuf.Duration][])

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
字段名称 必填 可空 类型 描述 格式

@type

字符串

一个唯一标识序列化协议缓冲区消息类型的 URL/资源名称。此字符串必须包含至少一个“/”字符。URL 路径的最后一部分必须表示类型的全限定名称(如 path/google.protobuf.Duration)。名称应采用规范形式(例如,不接受前导“.”)。实际上,团队通常会将其预期在 Any 上下文中使用的所有类型预编译到二进制文件中。但是,对于使用方案 httphttps 或无方案的 URL,可以选择设置一个类型服务器,该服务器将类型 URL 映射到消息定义,如下所示:* 如果未提供方案,则假定为 https。* 对 URL 的 HTTP GET 必须生成二进制格式的 [google.protobuf.Type][] 值,或产生错误。* 应用程序允许根据 URL 缓存查找结果,或将其预编译到二进制文件中以避免任何查找。因此,需要在类型更改时保留二进制兼容性。(使用版本化的类型名称来管理重大更改。)注意:此功能当前在官方 protobuf 版本中不可用,并且不用于以 type.googleapis.com 开头的类型 URL。截至 2023 年 5 月,没有广泛使用的类型服务器实现,也没有计划实现一个。可以使用具有特定于实现的语义的 httphttps(或空方案)以外的方案。

StorageAWSProviderMetadata

StorageAdmissionControlHealthInfo

AdmissionControlHealthInfo 传输有关准入控制部署的数据,但不包括从此数据派生的准入控制健康状态。不包含聚合的准入控制健康状态,因为它是在中心派生的,而不是在首先报告 AdmissionControlHealthInfo(传感器)的组件中派生的。

以下字段被设置为可选/可为空,因为尝试获取它们时可能会出现错误,并且 0 的默认值可能会与实际值 0 混淆。如果尝试获取某个字段时发生错误,则该字段将不存在(而不是具有默认值)。

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

totalDesiredPods

整数

int32

totalReadyPods

整数

int32

statusErrors

string 列表

尝试获取准入控制健康信息时发生的错误集合。

StorageAdmissionControllerConfig

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

enabled

布尔型

timeoutSeconds

整数

int32

scanInline

布尔型

disableBypass

布尔型

enforceOnUpdates

布尔型

StorageAuditLogFileState

AuditLogFileState tracks the last audit log event timestamp and ID that was collected by Compliance For internal use only
字段名称 必填 可空 类型 描述 格式

collectLogsSince

日期

日期时间

lastAuditId

字符串

StorageAzureProviderMetadata

StorageCluster

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

id

字符串

name

字符串

type

StorageClusterType

GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,

labels

string 映射

mainImage

字符串

collectorImage

字符串

centralApiEndpoint

字符串

runtimeSupport

布尔型

collectionMethod

StorageCollectionMethod

UNSET_COLLECTION, NO_COLLECTION, KERNEL_MODULE, EBPF, CORE_BPF,

admissionController

布尔型

admissionControllerUpdates

布尔型

admissionControllerEvents

布尔型

status

StorageClusterStatus

dynamicConfig

StorageDynamicClusterConfig

tolerationsConfig

StorageTolerationsConfig

priority

字符串

int64

healthStatus

StorageClusterHealthStatus

slimCollector

布尔型

helmConfig

StorageCompleteClusterConfig

mostRecentSensorId

StorageSensorDeploymentIdentification

auditLogState

StorageAuditLogFileState 映射

仅供内部使用。

initBundleId

字符串

managedBy

StorageManagerType

MANAGER_TYPE_UNKNOWN, MANAGER_TYPE_MANUAL, MANAGER_TYPE_HELM_CHART, MANAGER_TYPE_KUBERNETES_OPERATOR,

StorageClusterCertExpiryStatus

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

sensorCertExpiry

日期

日期时间

sensorCertNotBefore

日期

日期时间

StorageClusterHealthStatus

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

id

字符串

collectorHealthInfo

StorageCollectorHealthInfo

admissionControlHealthInfo

StorageAdmissionControlHealthInfo

scannerHealthInfo

StorageScannerHealthInfo

sensorHealthStatus

ClusterHealthStatusHealthStatusLabel

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

collectorHealthStatus

ClusterHealthStatusHealthStatusLabel

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

overallHealthStatus

ClusterHealthStatusHealthStatusLabel

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

admissionControlHealthStatus

ClusterHealthStatusHealthStatusLabel

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

scannerHealthStatus

ClusterHealthStatusHealthStatusLabel

UNINITIALIZED, UNAVAILABLE, UNHEALTHY, DEGRADED, HEALTHY,

lastContact

日期

日期时间

healthInfoComplete

布尔型

StorageClusterMetadata

ClusterMetadata 包含有关集群基础设施的元数据信息。

StorageClusterMetadataType

枚举值

UNSPECIFIED

AKS

ARO

EKS

GKE

OCP

OSD

ROSA

StorageClusterStatus

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

sensorVersion

字符串

DEPRECATEDLastContact

日期

此字段已从 49.0 版本开始弃用。请改用 healthStatus.lastContact。

日期时间

providerMetadata

StorageProviderMetadata

orchestratorMetadata

StorageOrchestratorMetadata

upgradeStatus

StorageClusterUpgradeStatus

certExpiryStatus

StorageClusterCertExpiryStatus

StorageClusterType

枚举值

GENERIC_CLUSTER

KUBERNETES_CLUSTER

OPENSHIFT_CLUSTER

OPENSHIFT4_CLUSTER

StorageClusterUpgradeStatus

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

upgradability

ClusterUpgradeStatusUpgradability

UNSET, UP_TO_DATE, MANUAL_UPGRADE_REQUIRED, AUTO_UPGRADE_POSSIBLE, SENSOR_VERSION_HIGHER,

upgradabilityStatusReason

字符串

mostRecentProcess

ClusterUpgradeStatusUpgradeProcessStatus

StorageCollectionMethod

枚举值

UNSET_COLLECTION

NO_COLLECTION

KERNEL_MODULE

EBPF

CORE_BPF

StorageCollectorHealthInfo

CollectorHealthInfo 传输有关收集器部署的数据,但不包括从此数据派生的收集器健康状态。不包含聚合的收集器健康状态,因为它是在中心派生的,而不是在首先报告 CollectorHealthInfo(传感器)的组件中派生的。

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

version

字符串

totalDesiredPods

整数

int32

totalReadyPods

整数

int32

totalRegisteredNodes

整数

int32

statusErrors

string 列表

尝试获取收集器健康信息时发生的错误集合。

StorageCompleteClusterConfig

编码完整的集群配置,减去 ID/名称标识符,包括静态和动态设置。

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

dynamicConfig

StorageDynamicClusterConfig

staticConfig

StorageStaticClusterConfig

configFingerprint

字符串

clusterLabels

string 映射

StorageDynamicClusterConfig

静态和动态集群配置之间的区别在于,动态值通过中央到传感器的 gRPC 连接发送。这使得无需重新启动安全集群组件即可“热重载”值。

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

admissionControllerConfig

StorageAdmissionControllerConfig

registryOverride

字符串

disableAuditLogs

布尔型

StorageGoogleProviderMetadata

StorageManagerType

枚举值

MANAGER_TYPE_UNKNOWN

MANAGER_TYPE_MANUAL

MANAGER_TYPE_HELM_CHART

MANAGER_TYPE_KUBERNETES_OPERATOR

StorageOrchestratorMetadata

StorageProviderMetadata

StorageScannerHealthInfo

ScannerHealthInfo 表示部署在安全集群(称为“本地扫描器”)上的扫描器实例的健康信息。当扫描器部署在中央集群上时,不会使用此消息。ScannerHealthInfo 携带有关扫描器部署的数据,但不包括从此数据派生的扫描器健康状态。不包含聚合的扫描器健康状态,因为它是在中心派生的,而不是在首先报告 ScannerHealthInfo(传感器)的组件中派生的。

以下字段被设置为可选/可为空,因为尝试获取它们时可能会出现错误,并且 0 的默认值可能会与实际值 0 混淆。如果尝试获取某个字段时发生错误,则该字段将不存在(而不是具有默认值)。

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

总期望分析器 Pod 数

整数

int32

总就绪分析器 Pod 数

整数

int32

总期望数据库 Pod 数

整数

int32

总就绪数据库 Pod 数

整数

int32

statusErrors

string 列表

尝试获取扫描器健康信息时发生的错误集合。

StorageSensorDeploymentIdentification

StackRoxDeploymentIdentification 旨在唯一标识 StackRox Sensor 部署。它用于确定传感器连接来自重新启动或重新创建的传感器 Pod(可能在网络分区之后),还是来自不同命名空间或集群中的部署。

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

系统命名空间 ID

字符串

默认命名空间 ID

字符串

应用命名空间

字符串

应用命名空间 ID

字符串

应用服务账户 ID

字符串

Kubernetes 节点名称

字符串

StorageStaticClusterConfig

静态集群配置和动态集群配置的区别在于,静态值不会通过中心到传感器的 gRPC 连接发送。例如,它们用于生成可用于设置安全集群的 Kubernetes 组件的清单。它们**不会**动态重新加载。

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

type

StorageClusterType

GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,

mainImage

字符串

centralApiEndpoint

字符串

collectionMethod

StorageCollectionMethod

UNSET_COLLECTION, NO_COLLECTION, KERNEL_MODULE, EBPF, CORE_BPF,

collectorImage

字符串

admissionController

布尔型

admissionControllerUpdates

布尔型

tolerationsConfig

StorageTolerationsConfig

slimCollector

布尔型

admissionControllerEvents

布尔型

StorageTolerationsConfig

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

已禁用

布尔型

StorageUpgradeProgress

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

升级状态

UpgradeProgressUpgradeState

UPGRADE_INITIALIZING,UPGRADER_LAUNCHING,UPGRADER_LAUNCHED,PRE_FLIGHT_CHECKS_COMPLETE,UPGRADE_OPERATIONS_DONE,UPGRADE_COMPLETE,UPGRADE_INITIALIZATION_ERROR,PRE_FLIGHT_CHECKS_FAILED,UPGRADE_ERROR_ROLLING_BACK,UPGRADE_ERROR_ROLLED_BACK,UPGRADE_ERROR_ROLLBACK_FAILED,UPGRADE_ERROR_UNKNOWN,UPGRADE_TIMED_OUT,

升级状态详情

字符串

日期

日期时间

UpgradeProcessStatusUpgradeProcessType

  • UPGRADE:UPGRADE 代表传感器版本升级。

  • CERT_ROTATION:CERT_ROTATION 代表仅旋转集群使用的 TLS 证书的升级过程,而无需更改其他任何内容。

枚举值

UPGRADE

CERT_ROTATION

UpgradeProgressUpgradeState

  • UPGRADER_LAUNCHING:进行中状态。

  • UPGRADE_COMPLETE:成功状态。请将所有进行中状态编号列在此上方,所有错误状态编号列在此下方。

  • UPGRADE_INITIALIZATION_ERROR:错误状态。

枚举值

UPGRADE_INITIALIZING

UPGRADER_LAUNCHING

UPGRADER_LAUNCHED

PRE_FLIGHT_CHECKS_COMPLETE

UPGRADE_OPERATIONS_DONE

UPGRADE_COMPLETE

UPGRADE_INITIALIZATION_ERROR

PRE_FLIGHT_CHECKS_FAILED

UPGRADE_ERROR_ROLLING_BACK

UPGRADE_ERROR_ROLLED_BACK

UPGRADE_ERROR_ROLLBACK_FAILED

UPGRADE_ERROR_UNKNOWN

UPGRADE_TIMED_OUT

V1ClusterResponse

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

集群

StorageCluster

集群保留信息

V1DecommissionedClusterRetentionInfo

V1DecommissionedClusterRetentionInfo

next available tag: 3
字段名称 必填 可空 类型 描述 格式

已排除

布尔型

剩余删除天数

整数

int32