Red Hat Summit 红帽全球峰会支持控制台（Console）开发人员开始试用联系人

11.3. GetClusters

GET /v1/clusters

11.3.1. 描述
复制链接

11.3.2. 参数
复制链接

11.3.2.1. 查询参数
复制链接

Expand
Name描述必填defaultpattern

query

 

-

null

 

11.3.3. 返回类型
复制链接

V1ClustersList

11.3.4. 内容类型
复制链接

  • application/json

11.3.5. 响应
复制链接

Expand
表 11.3. HTTP 响应代码
代码消息datatype

200

成功响应。

V1ClustersList

0

意外错误响应。

RuntimeError

11.3.6. Samples
复制链接

11.3.7. 常规对象参考
复制链接

11.3.7.1. ClusterHealthStatusHealthStatusLabel
复制链接

  • UNAVAILABLE ：只有收集器可以不可用状态
Expand
Enum 值

UNINITIALIZED

不可用

UNHEALTHY

DEGRADED

健康

11.3.7.2. ClusterUpgradeStatusUpgradability
复制链接

  • SENSOR_VERSION_HIGHER: SENSOR_VERSION_HIGHER 在检测到传感器运行的是比这个 Central 的新版本时。这是意外的，但可以根据客户的补丁而发生。在这种情况下，我们不会自动"升级"传感器，因为这是一个降级，即使 autoupgrade 设置是 on。允许用户手动触发升级，但强烈建议不要先升级 Central，因为这是一个不被支持的配置。
Expand
Enum 值

UNSET

UP_TO_DATE

MANUAL_UPGRADE_REQUIRED

AUTO_UPGRADE_POSSIBLE

SENSOR_VERSION_HIGHER

11.3.7.3. ClusterUpgradeStatusUpgradeProcessStatus
复制链接

Expand
字段名称必填nullable类型描述格式

active

  

布尔值

  

id

  

字符串

  

targetVersion

  

字符串

  

upgraderImage

  

字符串

  

initiatedAt

  

Date

 

date-time

progress

  

StorageUpgradeProgress

  

type

  

UpgradeProcessStatusUpgradeProcessType

 

升级, CERT_ROTATION,

11.3.7.4. ProtobufAny
复制链接

any 包含任意序列化协议缓冲区消息，以及一个描述序列化消息的类型的 URL。

protobuf 库以实用程序函数形式提供对 pack/unpack Any 值的支持，或者对 Any 类型的其他生成的方法提供其他生成的方法。

示例 1: Pack 并在 C++ 中解包信息。 

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}
Copy to Clipboard Toggle word wrap

示例 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());
}
Copy to Clipboard Toggle word wrap 
Example 3: Pack and unpack a message in Python.
Copy to Clipboard Toggle word wrap 
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...
Copy to Clipboard Toggle word wrap 
Example 4: Pack and unpack a message in Go
Copy to Clipboard Toggle word wrap 
foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}
Copy to Clipboard Toggle word wrap

默认情况下，protobuf 库提供的软件包方法将使用 'type.googleapis.com/full.type.name' 作为类型 URL，解包方法只使用类型 URL 中的完全限定类型名称，如 "foo.bar.com/x/x/y.z"。

11.3.7.4.1. JSON 表示
复制链接

any 值的 JSON 表示使用反序列化的、嵌入式消息的常规表示，以及包含类型 URL 的附加字段 @type。Example: 

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}
Copy to Clipboard Toggle word wrap 
{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}
Copy to Clipboard Toggle word wrap

如果嵌入式消息类型是知名且具有自定义 JSON 表示法，则该表示将被嵌入一个字段值，该值 除 @type 字段外还包含自定义 JSON。示例（用于消息 [google.protobuf.Duration][]）： 

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
Copy to Clipboard Toggle word wrap
Expand
字段名称必填nullable类型描述格式

typeUrl

  

字符串

唯一标识序列化协议缓冲消息的 URL/资源名称。此字符串必须至少包含一个 \"/\" 字符。URL 路径的最后一部分必须代表类型的完全限定名称（如 path/google.protobuf.Duration）。名称应采用规范形式（例如，未接受前面的 \".\"）。在实践中，团队通常会预编译到期望其在任意上下文中使用的所有类型的二进制代码。但是，对于使用方案 http、https 或无方案的 URL，可以选择设置一个类型服务器，将类型 URL 映射到消息定义，如下所示：* 如果没有提供方案，则假设 https。* URL 上的 HTTP GET 必须以二进制格式生成一个 [google.protobuf.Type][] 值，或者产生错误。* 应用程序允许根据 URL 缓存查找结果，或者预先编译到二进制文件以避免出现任何查找。因此，为了更改类型，二进制兼容性需要保留。（使用版本控制类型名称来管理中断的更改。）注意：这个功能目前在官方 protobuf 版本中可用，它不用于以 type.googleapis.com 开头的类型 URL。自 2023 年 5 月起，没有广泛使用的类型服务器实施，没有计划实施。http 之外的方案（或空方案）可以与实施特定语义一起使用。

 

value

  

byte[]

必须是上述指定类型的有效序列化协议缓冲。

BYTE

11.3.7.5. RuntimeError
复制链接

Expand
字段名称必填nullable类型描述格式

错误

  

字符串

  

code

  

整数

 

int32

message

  

字符串

  

详情

  

ProtobufAny列表

  

11.3.7.6. StorageAWSProviderMetadata
复制链接

Expand
字段名称必填nullable类型描述格式

accountId

  

字符串

  

11.3.7.7. StorageAdmissionControlHealthInfo
复制链接

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

Expand
字段名称必填nullable类型描述格式

totalDesiredPods

  

整数

 

int32

totalReadyPods

  

整数

 

int32

statusErrors

  

字符串列表

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

 

11.3.7.8. StorageAdmissionControllerConfig
复制链接

Expand
字段名称必填nullable类型描述格式

enabled

  

布尔值

  

timeoutSeconds

  

整数

 

int32

scanInline

  

布尔值

  

disableBypass

  

布尔值

  

enforceOnUpdates

  

布尔值

  

11.3.7.9. StorageAuditLogFileState
复制链接

AuditLogFileState tracks the last audit log event timestamp and ID that was collected by Compliance For internal use only
Copy to Clipboard Toggle word wrap
Expand
字段名称必填nullable类型描述格式

collectLogsSince

  

Date

 

date-time

lastAuditId

  

字符串

  

11.3.7.10. StorageAzureProviderMetadata
复制链接

Expand
字段名称必填nullable类型描述格式

subscriptionId

  

字符串

  

11.3.7.11. StorageCluster
复制链接

Expand
字段名称必填nullable类型描述格式

id

  

字符串

  

名称

  

字符串

  

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

仅供内部使用。

 

initBundleId

  

字符串

  

managedBy

  

StorageManagerType

 

MANAGER_TYPE_UNKNOWN, MANAGER_TYPE_MANUAL, MANAGER_TYPE_HELM_CHART, MANAGER_TYPE_KUBERNETES_OPERATOR,

11.3.7.12. StorageClusterCertExpiryStatus
复制链接

Expand
字段名称必填nullable类型描述格式

sensorCertExpiry

  

Date

 

date-time

sensorCertNotBefore

  

Date

 

date-time

11.3.7.13. StorageClusterHealthStatus
复制链接

Expand
字段名称必填nullable类型描述格式

id

  

字符串

  

collectorHealthInfo

  

StorageCollectorHealthInfo

  

admissionControlHealthInfo

  

StorageAdmissionControlHealthInfo

  

scannerHealthInfo

  

StorageScannerHealthInfo

  

sensorHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

未初始化、不可用、不健康、降级、健康、

collectorHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

未初始化、不可用、不健康、降级、健康、

overallHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

未初始化、不可用、不健康、降级、健康、

admissionControlHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

未初始化、不可用、不健康、降级、健康、

scannerHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

未初始化、不可用、不健康、降级、健康、

lastContact

  

Date

 

date-time

healthInfoComplete

  

布尔值

  

11.3.7.14. StorageClusterMetadata
复制链接

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

Expand
字段名称必填nullable类型描述格式

type

  

StorageClusterMetadataType

 

未指定、AKS、ARO、EKS、GKE、OCP、OSD、ROSA、

名称

  

字符串

name 代表集群注册到云供应商的名称。如果是自我管理的 OpenShift，则这是 OpenShift 安装程序选择的名称。

 

id

  

字符串

ID 代表集群注册到云供应商的唯一 ID。不是所有集群类型都有一个 id。对于所有 OpenShift 集群，这是使用 OCM 注册的红帽 cluster_id。

 

11.3.7.15. StorageClusterMetadataType
复制链接

Expand
Enum 值

未指定

AKS

ARO

EKS

GKE

OCP

OSD

ROSA

11.3.7.16. StorageClusterStatus
复制链接

Expand
字段名称必填nullable类型描述格式

sensorVersion

  

字符串

  

DEPRECATEDLastContact

  

Date

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

date-time

providerMetadata

  

StorageProviderMetadata

  

orchestratorMetadata

  

StorageOrchestratorMetadata

  

upgradeStatus

  

StorageClusterUpgradeStatus

  

certExpiryStatus

  

StorageClusterCertExpiryStatus

  

11.3.7.17. StorageClusterType
复制链接

Expand
Enum 值

GENERIC_CLUSTER

KUBERNETES_CLUSTER

OPENSHIFT_CLUSTER

OPENSHIFT4_CLUSTER

11.3.7.18. StorageClusterUpgradeStatus
复制链接

Expand
字段名称必填nullable类型描述格式

可升级性

  

ClusterUpgradeStatusUpgradability

 

UNSET, UP_TO_DATE, MANUAL_UPGRADE_REQUIRED, AUTO_UPGRADE_POSSIBLE, SENSOR_VERSION_HIGHER,

upgradabilityStatusReason

  

字符串

  

mostRecentProcess

  

ClusterUpgradeStatusUpgradeProcessStatus

  

11.3.7.19. StorageCollectionMethod
复制链接

Expand
Enum 值

UNSET_COLLECTION

NO_COLLECTION

KERNEL_MODULE

EBPF

CORE_BPF

11.3.7.20. StorageCollectorHealthInfo
复制链接

CollectorHealthInfo 传输有关收集器部署的数据，但不包括从此数据派生的收集器健康状态。不包括聚合的收集器健康状态，因为它是作为中央的，而不是在首次报告 CollectorHealthInfo （传感器）的组件中。

Expand
字段名称必填nullable类型描述格式

version

  

字符串

  

totalDesiredPods

  

整数

 

int32

totalReadyPods

  

整数

 

int32

totalRegisteredNodes

  

整数

 

int32

statusErrors

  

字符串列表

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

 

11.3.7.21. StorageCompleteClusterConfig
复制链接

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

Expand
字段名称必填nullable类型描述格式

dynamicConfig

  

StorageDynamicClusterConfig

  

staticConfig

  

StorageStaticClusterConfig

  

configFingerprint

  

字符串

  

clusterLabels

  

字符串映射

  

11.3.7.22. StorageDynamicClusterConfig
复制链接

Static 和 Dynamic 集群配置之间的区别是动态值通过 Central 发送到 Sensor gRPC 连接。这允许在不重启安全集群组件的情况下"热重新加载"值。

Expand
字段名称必填nullable类型描述格式

admissionControllerConfig

  

StorageAdmissionControllerConfig

  

registryOverride

  

字符串

  

disableAuditLogs

  

布尔值

  

11.3.7.23. StorageGoogleProviderMetadata
复制链接

Expand
字段名称必填nullable类型描述格式

project

  

字符串

  

clusterName

  

字符串

已弃用，以 providerMetadata.cluster.name 替代。

 

11.3.7.24. StorageManagerType
复制链接

Expand
Enum 值

MANAGER_TYPE_UNKNOWN

MANAGER_TYPE_MANUAL

MANAGER_TYPE_HELM_CHART

MANAGER_TYPE_KUBERNETES_OPERATOR

11.3.7.25. StorageOrchestratorMetadata
复制链接

Expand
字段名称必填nullable类型描述格式

version

  

字符串

  

openshiftVersion

  

字符串

  

buildDate

  

Date

 

date-time

apiVersions

  

字符串列表

  

11.3.7.26. StorageProviderMetadata
复制链接

Expand
字段名称必填nullable类型描述格式

region

  

字符串

  

zone

  

字符串

  

google

  

StorageGoogleProviderMetadata

  

aws

  

StorageAWSProviderMetadata

  

azure

  

StorageAzureProviderMetadata

  

已验证

  

布尔值

  

cluster

  

StorageClusterMetadata

  

11.3.7.27. StorageScannerHealthInfo
复制链接

ScannerHealthInfo 代表部署在安全集群中（如"本地扫描程序"）的扫描程序实例的健康状况信息。当扫描程序部署到中央集群中时，不使用以下信息。ScannerHealthInfo 传输扫描程序部署的数据，但不包括从此数据派生的扫描程序健康状况。不包括聚合的扫描程序健康状态，因为它是作为中央的，而不是首先报告 ScannerHealthInfo （传感器）的组件。

Expand
字段名称必填nullable类型描述格式

totalDesiredAnalyzerPods

  

整数

 

int32

totalReadyAnalyzerPods

  

整数

 

int32

totalDesiredDbPods

  

整数

 

int32

totalReadyDbPods

  

整数

 

int32

statusErrors

  

字符串列表

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

 

11.3.7.28. StorageSensorDeploymentIdentification
复制链接

StackRoxDeploymentIdentification 旨在唯一标识 StackRox Sensor 部署。它用于确定传感器连接是否来自重启或重新创建的传感器 pod （可能在网络分区后面），还是从不同命名空间或集群中的部署。

Expand
字段名称必填nullable类型描述格式

systemNamespaceId

  

字符串

  

defaultNamespaceId

  

字符串

  

appNamespace

  

字符串

  

appNamespaceId

  

字符串

  

appServiceaccountId

  

字符串

  

k8sNodeName

  

字符串

  

11.3.7.29. StorageStaticClusterConfig
复制链接

Static 和 Dynamic 集群配置之间的区别是静态值不会通过 Central 发送到 Sensor gRPC 连接。例如，它们用于生成可用于设置安全集群的 k8s 组件的清单。它们不会被 动态重新加载。

Expand
字段名称必填nullable类型描述格式

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

  

布尔值

  

11.3.7.30. StorageTolerationsConfig
复制链接

Expand
字段名称必填nullable类型描述格式

disabled

  

布尔值

  

11.3.7.31. StorageUpgradeProgress
复制链接

Expand
字段名称必填nullable类型描述格式

upgradeState

  

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,

upgradeStatusDetail

  

字符串

  

since

  

Date

 

date-time

11.3.7.32. UpgradeProcessStatusUpgradeProcessType
复制链接

  • UPGRADE：UPGRADE 代表传感器版本升级。
  • CERT_ROTATION: CERT_ROTATION 代表一个升级过程，它只会轮转集群使用的 TLS 证书，而不更改任何其他内容。
Expand
Enum 值

UPGRADE

CERT_ROTATION

11.3.7.33. UpgradeProgressUpgradeState
复制链接

  • UPGRADER_LAUNCHING：正在进行中的状态。
  • UPGRADE_COMPLETE：成功状态.请编号以上的所有 IN-PROGRESS 状态，以及以下所有错误状态。
  • UPGRADE_INITIALIZATION_ERROR: 错误状态.
Expand
Enum 值

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

11.3.7.34. V1ClustersList
复制链接

Expand
字段名称必填nullable类型描述格式

clusters

  

StorageCluster列表

  

clusterIdToRetentionInfo

  

Map of V1DecommissionedClusterRetentionInfo

  

11.3.7.35. V1DecommissionedClusterRetentionInfo
复制链接

next available tag: 3
Copy to Clipboard Toggle word wrap
Expand
字段名称必填nullable类型描述格式

isExcluded

  

布尔值

  

daysUntilDeletion

  

整数

 

int32

返回顶部
Red Hat logoGithubredditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务，以及可以信赖的内容，帮助红帽用户创新并实现他们的目标。 了解我们当前的更新.

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情，请参阅红帽博客.

關於紅帽

我们提供强化的解决方案，使企业能够更轻松地跨平台和环境（从核心数据中心到网络边缘）工作。

Theme

© 2025 Red Hat