11.3. GetClusters


GET /v1/clusters

11.3.1. 説明

11.3.2. パラメーター

11.3.2.1. クエリーパラメーター

Expand
名前説明必須デフォルトPattern

query

 

-

null

 

11.3.3. 戻り値のタイプ

V1ClustersList

11.3.4. コンテンツタイプ

  • application/json

11.3.5. レスポンス

Expand
表11.3 HTTP 応答コード
コードメッセージデータタイプ

200

正常な応答。

V1ClustersList

0

予期しないエラーの応答です。

RuntimeError

11.3.6. サンプル

11.3.7. 共通のオブジェクト参照

11.3.7.1. ClusterHealthStatusHealthStatusLabel

  • UNAVAILABLE: コレクターのみが使用できないステータスを持つことができます。
Expand
Enum 値

UNINITIALIZED

利用できません

UNHEALTHY

DEGRADED

HEALTHY

11.3.7.2. ClusterUpgradeStatusUpgradability

  • SENSOR_VERSION_HIGHER: SENSOR_VERSION_HIGHER は、センサーがこのセントラルよりも新しいバージョンを実行していることを検出すると発生します。これは予期しないものですが、お客様が行うパッチによっては発生する可能性があります。この場合、自動アップグレード設定が有効になっている場合でもダウングレードするため、センサーは自動的にアップグレードされません。ユーザーは手動でアップグレードをトリガーできますが、最初に Central をアップグレードすることなく、これはサポートされていない設定であるため、実行しないことが強く推奨されます。
Expand
Enum 値

UNSET

UP_TO_DATE

MANUAL_UPGRADE_REQUIRED

AUTO_UPGRADE_POSSIBLE

SENSOR_VERSION_HIGHER

11.3.7.3. ClusterUpgradeStatusUpgradeProcessStatus

Expand
フィールド名必須Null 許容型説明形式

active

  

Boolean

  

id

  

String

  

targetVersion

  

String

  

upgraderImage

  

String

  

initiatedAt

  

Date

 

date-time

progress

  

StorageUpgradeProgress

  

type

  

UpgradeProcessStatusUpgradeProcessType

 

UPGRADE、CERT_ROTATION、

11.3.7.4. ProtobufAny

any には、シリアライズされたメッセージの型を記述する URL とともに、任意のシリアライズされたプロトコルバッファーメッセージが含まれます。

Protobuf ライブラリーは、パック/アンパックをサポートします。任意の値は、ユーティリティー関数の形式で、または Any タイプの追加の生成されたメソッドになります。

例 1: 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 として使用し、unzip メソッドは、タイプ URL の最後の//のみを使用します。たとえば、"foo.bar.com/x/y.z" のように、"foo.bar.com/x/y.z" の型名 "y.z" が生成されます。

11.3.7.4.1. JSON 表現

Any 値の JSON 表現は、デシリアライズされた埋め込みメッセージの通常の表現を使用し、タイプ URL が含まれる追加のフィールド @type を使用します。以下に例を示します。

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
フィールド名必須Null 許容型説明形式

typeUrl

  

String

シリアライズされたプロトコルバッファーメッセージのタイプを一意に識別する URL/リソース名。この文字列には最低でも 1 つの \"/\" 文字を含める必要があります。URL のパスの最後のセグメントは、タイプの完全修飾名( path/google.protobuf.Durationにあるように)を表す必要があります。名前は正規の形式である必要があります(たとえば、先頭 \".\" は受け入れられません)。実際には、チームは通常、バイナリーにプリコンパイルして、任意 のコンテキストで使用することを期待しているすべてのタイプにプレコンパイルします。ただし、スキーム httphttps、またはスキームを使用しない URL の場合、以下のようにタイプ URL をメッセージ定義にマップするタイプサーバーを設定できます。* スキームが指定されていない場合、https は想定されます。* URL の HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成するか、エラーを生成する必要があります。* アプリケーションは、URL に基づいてルックアップ結果をキャッシュするか、ルックアップを回避するためにバイナリーにプリコンパイルして使用できます。したがって、タイプへの変更時にバイナリー互換性を保持する必要があります。(バージョン付けされたタイプ名を使用して、重大な変更を管理します。)注記:この機能は現在、公式の protobuf リリースでは利用できないため、type.googleapis.com で始まるタイプ URL には使用されません。2023 年 5 月時点では、広く使用されているタイプサーバー実装はもう 1 つも実装する予定はありません。http 以外のスキーム、https (または空のスキーム)は、実装固有のセマンティクスで使用できます。

 

value

  

byte[]

上記の指定されたタイプの有効なシリアライズされたプロトコルバッファーである必要があります。

byte

11.3.7.5. RuntimeError

Expand
フィールド名必須Null 許容型説明形式

error

  

String

  

code

  

Integer

 

int32

message

  

String

  

details

  

ProtobufAnyのリスト

  

11.3.7.6. StorageAWSProviderMetadata

Expand

11.3.7.7. StorageAdmissionControlHealthInfo

AdmissionControlHealthInfo は、アドミッションコントロールのデプロイメントに関するデータを保管しますが、このデータから派生した受付制御ヘルスステータスは含まれません。集約された受付制御の健全性ステータスは、最初に AdmissionControlHealthInfo (sensor)を報告するコンポーネントではなく、中央で派生するため、含まれません。

Expand
フィールド名必須Null 許容型説明形式

totalDesiredPods

  

Integer

 

int32

totalReadyPods

  

Integer

 

int32

statusErrors

  

string のリスト

アドミッションコントロールのヘルス情報を取得する際に発生したエラーのコレクション。

 

11.3.7.8. StorageAdmissionControllerConfig

Expand
フィールド名必須Null 許容型説明形式

enabled

  

Boolean

  

timeoutSeconds

  

Integer

 

int32

scanInline

  

Boolean

  

disableBypass

  

Boolean

  

enforceOnUpdates

  

Boolean

  

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
フィールド名必須Null 許容型説明形式

collectLogsSince

  

Date

 

date-time

lastAuditId

  

String

  

11.3.7.10. StorageAzureProviderMetadata

Expand

11.3.7.11. StorageCluster

Expand
フィールド名必須Null 許容型説明形式

id

  

String

  

name

  

String

  

type

  

StorageClusterType

 

GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,

labels

  

文字列のマップ

  

mainImage

  

String

  

collectorImage

  

String

  

centralApiEndpoint

  

String

  

runtimeSupport

  

Boolean

  

collectionMethod

  

StorageCollectionMethod

 

UNSET_COLLECTION、NO_COLLECTION、KERNEL_MODULE、EBPF、CORE_BPF

admissionController

  

Boolean

  

admissionControllerUpdates

  

Boolean

  

admissionControllerEvents

  

Boolean

  

status

  

StorageClusterStatus

  

dynamicConfig

  

StorageDynamicClusterConfig

  

tolerationsConfig

  

StorageTolerationsConfig

  

priority

  

String

 

int64

healthStatus

  

StorageClusterHealthStatus

  

slimCollector

  

Boolean

  

helmConfig

  

StorageCompleteClusterConfig

  

mostRecentSensorId

  

StorageSensorDeploymentIdentification

  

auditLogState

  

Map of StorageAuditLogFileState

内部使用のみ。

 

initBundleId

  

String

  

managedBy

  

StorageManagerType

 

MANAGER_TYPE_UNKNOWN、MANAGER_TYPE_MANUAL、MANAGER_TYPE_HELM_CHART、MANAGER_TYPE_KUBERNETES_OPERATOR、

11.3.7.12. StorageClusterCertExpiryStatus

Expand
フィールド名必須Null 許容型説明形式

sensorCertExpiry

  

Date

 

date-time

sensorCertNotBefore

  

Date

 

date-time

11.3.7.13. StorageClusterHealthStatus

Expand
フィールド名必須Null 許容型説明形式

id

  

String

  

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

  

Date

 

date-time

healthInfoComplete

  

Boolean

  

11.3.7.14. StorageClusterMetadata

ClusterMetadata には、クラスターインフラストラクチャーに関するメタデータ情報が含まれます。

Expand

11.3.7.15. StorageClusterMetadataType

Expand
Enum 値

指定なし

AKS

ARO

EKS

GKE

OCP

OSD

ROSA

11.3.7.16. StorageClusterStatus

Expand
フィールド名必須Null 許容型説明形式

sensorVersion

  

String

  

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
フィールド名必須Null 許容型説明形式

アップグレード可能性

  

ClusterUpgradeStatusUpgradability

 

UNSET, UP_TO_DATE, MANUAL_UPGRADE_REQUIRED, AUTO_UPGRADE_POSSIBLE, SENSOR_VERSION_HIGHER,

upgradabilityStatusReason

  

String

  

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 (sensor)を報告するコンポーネントではなく、中央で派生しているため、含まれません。

Expand
フィールド名必須Null 許容型説明形式

version

  

String

  

totalDesiredPods

  

Integer

 

int32

totalReadyPods

  

Integer

 

int32

totalRegisteredNodes

  

Integer

 

int32

statusErrors

  

string のリスト

コレクターの正常性情報の取得の試行中に発生したエラーのコレクション。

 

11.3.7.21. StorageCompleteClusterConfig

静的および動的設定を含む ID/名前識別子から完全なクラスター設定をエンコードします。

Expand
フィールド名必須Null 許容型説明形式

dynamicConfig

  

StorageDynamicClusterConfig

  

staticConfig

  

StorageStaticClusterConfig

  

configFingerprint

  

String

  

clusterLabels

  

文字列のマップ

  

11.3.7.22. StorageDynamicClusterConfig

静的クラスター設定と動的クラスター設定の相違点は、動的値が Central 経由で Sensor gRPC 接続に送信されることです。これには、Secured クラスターコンポーネントを再起動せずに値をホットリロードできるという利点があります。

Expand
フィールド名必須Null 許容型説明形式

admissionControllerConfig

  

StorageAdmissionControllerConfig

  

registryOverride

  

String

  

disableAuditLogs

  

Boolean

  

11.3.7.23. StorageGoogleProviderMetadata

Expand

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

11.3.7.26. StorageProviderMetadata

Expand

11.3.7.27. StorageScannerHealthInfo

ScannerHealthInfo は、セキュアなクラスターにデプロイされたスキャナーインスタンスの健全性情報(ローカルスキャナーと呼ばれる)を表します。スキャナーが中央クラスターにデプロイされると、次のメッセージは使用されません。ScannerHealthInfo は、スキャナーのデプロイメントに関するデータを保管しますが、このデータから派生したスキャナーの正常性ステータスは含まれません。集約されたスキャナーの正常性ステータスは中央で派生しており、最初に ScannerHealthInfo (sensor)を報告するコンポーネントに含まれていないため、含まれません。

Expand
フィールド名必須Null 許容型説明形式

totalDesiredAnalyzerPods

  

Integer

 

int32

totalReadyAnalyzerPods

  

Integer

 

int32

totalDesiredDbPods

  

Integer

 

int32

totalReadyDbPods

  

Integer

 

int32

statusErrors

  

string のリスト

スキャナーの正常性情報の取得の試行中に発生したエラーのコレクション。

 

11.3.7.28. StorageSensorDeploymentIdentification

StackRoxDeploymentIdentification は、StackRox Sensor デプロイメントを一意に識別するためのものです。これは、再起動または再作成されたセンサー Pod からのセンサー接続(ネットワークパーティション後)、または別の namespace またはクラスターへのデプロイメントからのセンサー接続の提供に使用されるために使用されます。

Expand
フィールド名必須Null 許容型説明形式

systemNamespaceId

  

String

  

defaultNamespaceId

  

String

  

appNamespace

  

String

  

appNamespaceId

  

String

  

appServiceaccountId

  

String

  

k8sNodeName

  

String

  

11.3.7.29. StorageStaticClusterConfig

静的クラスター設定と動的クラスター設定の相違点は、静的な値がセントラルの gRPC 接続を介して送信されないことです。これらは、たとえば、セキュアなクラスターの k8s コンポーネントの設定に使用できるマニフェストを生成するために使用されます。動的に再読み込みされ ません

Expand
フィールド名必須Null 許容型説明形式

type

  

StorageClusterType

 

GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,

mainImage

  

String

  

centralApiEndpoint

  

String

  

collectionMethod

  

StorageCollectionMethod

 

UNSET_COLLECTION、NO_COLLECTION、KERNEL_MODULE、EBPF、CORE_BPF

collectorImage

  

String

  

admissionController

  

Boolean

  

admissionControllerUpdates

  

Boolean

  

tolerationsConfig

  

StorageTolerationsConfig

  

slimCollector

  

Boolean

  

admissionControllerEvents

  

Boolean

  

11.3.7.30. StorageTolerationsConfig

Expand
フィールド名必須Null 許容型説明形式

disabled

  

Boolean

  

11.3.7.31. StorageUpgradeProgress

Expand
フィールド名必須Null 許容型説明形式

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、UPGRA_ERROR_ROLLED_BACK、UPGRADE_ERROR_ROLLBACK_FAILED、UPGRADE_ERROR_UNKNOWN、UPGRADE_TIMED_OUT

upgradeStatusDetail

  

String

  

次以降

  

Date

 

date-time

11.3.7.32. UpgradeProcessStatusUpgradeProcessType

  • UPGRADE: UPGRADE はセンサーバージョンのアップグレードを表します。
  • CERT_ROTATION: CERT_ROTATION は、他のものを変更することなく、クラスターが使用する TLS 証明書のみをローテーションするアップグレードプロセスを表します。
Expand
Enum 値

アップグレード

CERT_ROTATION

11.3.7.33. UpgradeProgressUpgradeState

  • UPGRADER_LAUNCHING: 進行中の状態。
  • UPGRADE_COMPLETE: 成功状態。こちら以下のすべてのエラー状態とすべてのエラー状態を確認してください。
  • 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
フィールド名必須Null 許容型説明形式

clusters

  

StorageClusterの一覧

  

clusterIdToRetentionInfo

  

Map of V1DecommissionedClusterRetentionInfo

  

11.3.7.35. V1DecommissionedClusterRetentionInfo

next available tag: 3
Copy to Clipboard Toggle word wrap
Expand
フィールド名必須Null 許容型説明形式

isExcluded

  

Boolean

  

daysUntilDeletion

  

Integer

 

int32

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat