获取集群 - 集群服务 | API 参考 | Red Hat Advanced Cluster Security for Kubernetes 4.6

GET /v1/clusters

描述 (Description)

参数 (Parameters)

查询参数 (Query Parameters)

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

名称 (Name)

描述 (Description)

必填 (Required)

默认值 (Default)

模式 (Pattern)

查询 (query)

空 (null)

返回类型 (Return Type)

V1ClustersList

内容类型 (Content Type)

application/json

响应 (Responses)

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

示例 (Samples)

常用对象引用 (Common object reference)

ClusterHealthStatusHealthStatusLabel

UNAVAILABLE: 只有收集器才能具有不可用状态 (UNAVAILABLE: Only collector can have unavailable status)

枚举值 (Enum Values)
UNINITIALIZED
UNAVAILABLE
UNHEALTHY
DEGRADED
HEALTHY

枚举值 (Enum Values)

UNINITIALIZED

UNAVAILABLE

UNHEALTHY

DEGRADED

HEALTHY

ClusterUpgradeStatusUpgradability

SENSOR_VERSION_HIGHER: 当我们检测到传感器运行的版本高于此中心时，就会出现 SENSOR_VERSION_HIGHER。这是意外情况，但根据客户执行的修补程序可能会发生。在这种情况下，我们不会自动“升级”传感器，因为即使自动升级设置已启用，这也将是降级。用户将被允许手动触发升级，但强烈建议他们在先升级中心之前不要这样做，因为这是不受支持的配置。(SENSOR_VERSION_HIGHER: SENSOR_VERSION_HIGHER occurs when we detect that the sensor is running a newer version than this Central. This is unexpected, but can occur depending on the patches a customer does. In this case, we will NOT automatically "upgrade" the sensor, since that would be a downgrade, even if the autoupgrade setting is on. The user will be allowed to manually trigger the upgrade, but they are strongly discouraged from doing so without upgrading Central first, since this is an unsupported configuration.)

枚举值 (Enum Values)
UNSET
UP_TO_DATE
MANUAL_UPGRADE_REQUIRED
AUTO_UPGRADE_POSSIBLE
SENSOR_VERSION_HIGHER

枚举值 (Enum Values)

UNSET

UP_TO_DATE

MANUAL_UPGRADE_REQUIRED

AUTO_UPGRADE_POSSIBLE

SENSOR_VERSION_HIGHER

ClusterUpgradeStatusUpgradeProcessStatus

字段名称

必填 (Required)

可为空

类型

描述 (Description)

格式

active

布尔值

字符串

targetVersion

字符串

upgraderImage

字符串

initiatedAt

日期

日期时间

progress

StorageUpgradeProgress

type

UpgradeProcessStatusUpgradeProcessType

UPGRADE, CERT_ROTATION,

GooglerpcStatus

字段名称

必填 (Required)

可为空

类型

描述 (Description)

格式

code

整数

int32

message

字符串

details

ProtobufAny 列表 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表示，则该表示将被嵌入，添加一个字段value，该字段除了@type字段外还包含自定义JSON。示例（对于消息[google.protobuf.Duration][]）

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

字段名称必填 (Required) 可为空类型描述 (Description) 格式

字段名称	必填 (Required)	可为空	类型	描述 (Description)	格式
@type			字符串	唯一标识序列化协议缓冲区消息类型的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

字符串

唯一标识序列化协议缓冲区消息类型的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（或空方案）之外的方案可能会与特定于实现的语义一起使用。

StorageAWSProviderMetadata

字段名称

必填 (Required)

可为空

类型

描述 (Description)

格式

accountId

字符串

StorageAdmissionControlHealthInfo

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

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

字段名称	类型	描述 (Description)	格式
totalDesiredPods	整数		int32
totalReadyPods	整数		int32
statusErrors	字符串列表	尝试获取准入控制健康信息时发生的错误集合。

字段名称

必填 (Required)

可为空

类型

描述 (Description)

格式

totalDesiredPods

整数

int32

totalReadyPods

整数

int32

statusErrors

字符串列表

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

StorageAdmissionControllerConfig

字段名称

必填 (Required)

可为空

类型

描述 (Description)

格式

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

字段名称

必填 (Required)

可为空

类型

描述 (Description)

格式

collectLogsSince

日期

日期时间

lastAuditId

字符串

StorageAzureProviderMetadata

字段名称

必填 (Required)

可为空

类型

描述 (Description)

格式

subscriptionId

字符串

StorageCluster

字段名称

必填 (Required)

可为空

类型

描述 (Description)

格式

字符串

name

字符串

type

StorageClusterType

GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,

labels

字符串映射

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 映射 StorageAuditLogFileState

仅供内部使用。

initBundleId

字符串

managedBy

StorageManagerType

MANAGER_TYPE_UNKNOWN, MANAGER_TYPE_MANUAL, MANAGER_TYPE_HELM_CHART, MANAGER_TYPE_KUBERNETES_OPERATOR,

StorageClusterCertExpiryStatus

字段名称	必填 (Required)	可为空	类型	描述 (Description)	格式
sensorCertExpiry			日期		日期时间
sensorCertNotBefore			日期		日期时间

字段名称

必填 (Required)

可为空

类型

描述 (Description)

格式

sensorCertExpiry

日期

日期时间

sensorCertNotBefore

日期

日期时间

StorageClusterHealthStatus

字段名称

必填 (Required)

可为空

类型

描述 (Description)

格式

字符串

collectorHealthInfo

StorageCollectorHealthInfo

admissionControlHealthInfo

StorageAdmissionControlHealthInfo

scannerHealthInfo

StorageScannerHealthInfo

sensorHealthStatus

ClusterHealthStatusHealthStatusLabel