11.3. GetClusters
GET /v1/clusters
11.3.1. 説明 リンクのコピーリンクがクリップボードにコピーされました!
11.3.2. パラメーター リンクのコピーリンクがクリップボードにコピーされました!
11.3.2.1. クエリーパラメーター リンクのコピーリンクがクリップボードにコピーされました!
名前 | 説明 | 必須 | デフォルト | Pattern |
---|---|---|---|---|
query | - | null |
11.3.3. 戻り値のタイプ リンクのコピーリンクがクリップボードにコピーされました!
11.3.4. コンテンツタイプ リンクのコピーリンクがクリップボードにコピーされました!
- application/json
11.3.5. レスポンス リンクのコピーリンクがクリップボードにコピーされました!
コード | メッセージ | データタイプ |
---|---|---|
200 | 正常な応答。 | |
0 | 予期しないエラーの応答です。 |
11.3.6. サンプル リンクのコピーリンクがクリップボードにコピーされました!
11.3.7. 共通のオブジェクト参照 リンクのコピーリンクがクリップボードにコピーされました!
11.3.7.1. ClusterHealthStatusHealthStatusLabel リンクのコピーリンクがクリップボードにコピーされました!
- UNAVAILABLE: コレクターのみが使用できないステータスを持つことができます。
Enum 値 |
---|
UNINITIALIZED |
利用できません |
UNHEALTHY |
DEGRADED |
HEALTHY |
11.3.7.2. ClusterUpgradeStatusUpgradability リンクのコピーリンクがクリップボードにコピーされました!
- SENSOR_VERSION_HIGHER: SENSOR_VERSION_HIGHER は、センサーがこのセントラルよりも新しいバージョンを実行していることを検出すると発生します。これは予期しないものですが、お客様が行うパッチによっては発生する可能性があります。この場合、自動アップグレード設定が有効になっている場合でもダウングレードするため、センサーは自動的にアップグレードされません。ユーザーは手動でアップグレードをトリガーできますが、最初に Central をアップグレードすることなく、これはサポートされていない設定であるため、実行しないことが強く推奨されます。
Enum 値 |
---|
UNSET |
UP_TO_DATE |
MANUAL_UPGRADE_REQUIRED |
AUTO_UPGRADE_POSSIBLE |
SENSOR_VERSION_HIGHER |
11.3.7.3. ClusterUpgradeStatusUpgradeProcessStatus リンクのコピーリンクがクリップボードにコピーされました!
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
active | Boolean | ||||
id | String | ||||
targetVersion | String | ||||
upgraderImage | String | ||||
initiatedAt | Date | date-time | |||
progress | |||||
type | UPGRADE、CERT_ROTATION、 |
11.3.7.4. ProtobufAny リンクのコピーリンクがクリップボードにコピーされました!
any
には、シリアライズされたメッセージの型を記述する URL とともに、任意のシリアライズされたプロトコルバッファーメッセージが含まれます。
Protobuf ライブラリーは、パック/アンパックをサポートします。任意の値は、ユーティリティー関数の形式で、または Any タイプの追加の生成されたメソッドになります。
例 1: C++ のメッセージをパックして展開します。
例 2: Java でメッセージをパックして解凍します。
Example 3: Pack and unpack a message in Python.
Example 3: Pack and unpack a message in Python.
Example 4: Pack and unpack a message in Go
Example 4: Pack and unpack a message in Go
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; }
package google.profile;
message Person {
string first_name = 1;
string last_name = 2;
}
{ "@type": "type.googleapis.com/google.profile.Person", "firstName": <string>, "lastName": <string> }
{
"@type": "type.googleapis.com/google.profile.Person",
"firstName": <string>,
"lastName": <string>
}
埋め込みメッセージタイプがよく知られていて、カスタム JSON 表現がある場合、その表現は埋め込みされ、@type
フィールドに加えてカスタム JSON を保持するフィールド 値
が追加されます。例(メッセージ [google.protobuf.Duration][] の場合):
{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
{
"@type": "type.googleapis.com/google.protobuf.Duration",
"value": "1.212s"
}
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
typeUrl | String |
シリアライズされたプロトコルバッファーメッセージのタイプを一意に識別する URL/リソース名。この文字列には最低でも 1 つの \"/\" 文字を含める必要があります。URL のパスの最後のセグメントは、タイプの完全修飾名( | |||
value | byte[] | 上記の指定されたタイプの有効なシリアライズされたプロトコルバッファーである必要があります。 | byte |
11.3.7.5. RuntimeError リンクのコピーリンクがクリップボードにコピーされました!
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
error | String | ||||
code | Integer | int32 | |||
message | String | ||||
details | ProtobufAnyのリスト |
11.3.7.6. StorageAWSProviderMetadata リンクのコピーリンクがクリップボードにコピーされました!
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
accountId | String |
11.3.7.7. StorageAdmissionControlHealthInfo リンクのコピーリンクがクリップボードにコピーされました!
AdmissionControlHealthInfo は、アドミッションコントロールのデプロイメントに関するデータを保管しますが、このデータから派生した受付制御ヘルスステータスは含まれません。集約された受付制御の健全性ステータスは、最初に AdmissionControlHealthInfo (sensor)を報告するコンポーネントではなく、中央で派生するため、含まれません。
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
totalDesiredPods | Integer | int32 | |||
totalReadyPods | Integer | int32 | |||
statusErrors |
| アドミッションコントロールのヘルス情報を取得する際に発生したエラーのコレクション。 |
11.3.7.8. StorageAdmissionControllerConfig リンクのコピーリンクがクリップボードにコピーされました!
フィールド名 | 必須 | 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
AuditLogFileState tracks the last audit log event timestamp and ID that was collected by Compliance For internal use only
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
collectLogsSince | Date | date-time | |||
lastAuditId | String |
11.3.7.10. StorageAzureProviderMetadata リンクのコピーリンクがクリップボードにコピーされました!
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
subscriptionId | String |
11.3.7.11. StorageCluster リンクのコピーリンクがクリップボードにコピーされました!
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
id | String | ||||
name | String | ||||
type | GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER, | ||||
labels |
| ||||
mainImage | String | ||||
collectorImage | String | ||||
centralApiEndpoint | String | ||||
runtimeSupport | Boolean | ||||
collectionMethod | UNSET_COLLECTION、NO_COLLECTION、KERNEL_MODULE、EBPF、CORE_BPF | ||||
admissionController | Boolean | ||||
admissionControllerUpdates | Boolean | ||||
admissionControllerEvents | Boolean | ||||
status | |||||
dynamicConfig | |||||
tolerationsConfig | |||||
priority | String | int64 | |||
healthStatus | |||||
slimCollector | Boolean | ||||
helmConfig | |||||
mostRecentSensorId | |||||
auditLogState | Map of StorageAuditLogFileState | 内部使用のみ。 | |||
initBundleId | String | ||||
managedBy | MANAGER_TYPE_UNKNOWN、MANAGER_TYPE_MANUAL、MANAGER_TYPE_HELM_CHART、MANAGER_TYPE_KUBERNETES_OPERATOR、 |
11.3.7.12. StorageClusterCertExpiryStatus リンクのコピーリンクがクリップボードにコピーされました!
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
sensorCertExpiry | Date | date-time | |||
sensorCertNotBefore | Date | date-time |
11.3.7.13. StorageClusterHealthStatus リンクのコピーリンクがクリップボードにコピーされました!
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
id | String | ||||
collectorHealthInfo | |||||
admissionControlHealthInfo | |||||
scannerHealthInfo | |||||
sensorHealthStatus | UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY | ||||
collectorHealthStatus | UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY | ||||
overallHealthStatus | UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY | ||||
admissionControlHealthStatus | UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY | ||||
scannerHealthStatus | UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY | ||||
lastContact | Date | date-time | |||
healthInfoComplete | Boolean |
11.3.7.14. StorageClusterMetadata リンクのコピーリンクがクリップボードにコピーされました!
ClusterMetadata には、クラスターインフラストラクチャーに関するメタデータ情報が含まれます。
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
type | UNSPECIFIED、AKS、ARO、EKS、GKE、OCP、OSD、ROSA、 | ||||
name | String | name は、クラスターがクラウドプロバイダーに登録されている名前を表します。自己管理の OpenShift の場合、これは OpenShift インストーラーによって選択される名前です。 | |||
id | String |
id は、クラスターがクラウドプロバイダーに登録されている一意の ID を表します。すべてのクラスタータイプに ID が割り当てられているわけではありません。すべての OpenShift クラスターの場合、これは OCM に登録された Red Hat |
11.3.7.15. StorageClusterMetadataType リンクのコピーリンクがクリップボードにコピーされました!
Enum 値 |
---|
指定なし |
AKS |
ARO |
EKS |
GKE |
OCP |
OSD |
ROSA |
11.3.7.16. StorageClusterStatus リンクのコピーリンクがクリップボードにコピーされました!
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
sensorVersion | String | ||||
DEPRECATEDLastContact | Date | このフィールドは、リリース 49.0 以降非推奨になりました。代わりに healthStatus.lastContact を使用してください。 | date-time | ||
providerMetadata | |||||
orchestratorMetadata | |||||
upgradeStatus | |||||
certExpiryStatus |
11.3.7.17. StorageClusterType リンクのコピーリンクがクリップボードにコピーされました!
Enum 値 |
---|
GENERIC_CLUSTER |
KUBERNETES_CLUSTER |
OPENSHIFT_CLUSTER |
OPENSHIFT4_CLUSTER |
11.3.7.18. StorageClusterUpgradeStatus リンクのコピーリンクがクリップボードにコピーされました!
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
アップグレード可能性 | UNSET, UP_TO_DATE, MANUAL_UPGRADE_REQUIRED, AUTO_UPGRADE_POSSIBLE, SENSOR_VERSION_HIGHER, | ||||
upgradabilityStatusReason | String | ||||
mostRecentProcess |
11.3.7.19. StorageCollectionMethod リンクのコピーリンクがクリップボードにコピーされました!
Enum 値 |
---|
UNSET_COLLECTION |
NO_COLLECTION |
KERNEL_MODULE |
EBPF |
CORE_BPF |
11.3.7.20. StorageCollectorHealthInfo リンクのコピーリンクがクリップボードにコピーされました!
CollectorHealthInfo は、コレクターのデプロイメントに関するデータを保持しますが、このデータから取得するコレクターのヘルスステータスは含まれません。集約コレクターのヘルスステータスは、最初に CollectorHealthInfo (sensor)を報告するコンポーネントではなく、中央で派生しているため、含まれません。
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
version | String | ||||
totalDesiredPods | Integer | int32 | |||
totalReadyPods | Integer | int32 | |||
totalRegisteredNodes | Integer | int32 | |||
statusErrors |
| コレクターの正常性情報の取得の試行中に発生したエラーのコレクション。 |
11.3.7.21. StorageCompleteClusterConfig リンクのコピーリンクがクリップボードにコピーされました!
静的および動的設定を含む ID/名前識別子から完全なクラスター設定をエンコードします。
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
dynamicConfig | |||||
staticConfig | |||||
configFingerprint | String | ||||
clusterLabels |
|
11.3.7.22. StorageDynamicClusterConfig リンクのコピーリンクがクリップボードにコピーされました!
静的クラスター設定と動的クラスター設定の相違点は、動的値が Central 経由で Sensor gRPC 接続に送信されることです。これには、Secured クラスターコンポーネントを再起動せずに値をホットリロードできるという利点があります。
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
admissionControllerConfig | |||||
registryOverride | String | ||||
disableAuditLogs | Boolean |
11.3.7.23. StorageGoogleProviderMetadata リンクのコピーリンクがクリップボードにコピーされました!
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
project | String | ||||
clusterName | String | providerMetadata.cluster.name が導入されたため非推奨になりました。 |
11.3.7.24. StorageManagerType リンクのコピーリンクがクリップボードにコピーされました!
Enum 値 |
---|
MANAGER_TYPE_UNKNOWN |
MANAGER_TYPE_MANUAL |
MANAGER_TYPE_HELM_CHART |
MANAGER_TYPE_KUBERNETES_OPERATOR |
11.3.7.25. StorageOrchestratorMetadata リンクのコピーリンクがクリップボードにコピーされました!
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
version | String | ||||
openshiftVersion | String | ||||
buildDate | Date | date-time | |||
apiVersions |
|
11.3.7.26. StorageProviderMetadata リンクのコピーリンクがクリップボードにコピーされました!
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
region | String | ||||
zone | String | ||||
| |||||
aws | |||||
azure | |||||
verified | Boolean | ||||
cluster |
11.3.7.27. StorageScannerHealthInfo リンクのコピーリンクがクリップボードにコピーされました!
ScannerHealthInfo は、セキュアなクラスターにデプロイされたスキャナーインスタンスの健全性情報(ローカルスキャナーと呼ばれる)を表します。スキャナーが中央クラスターにデプロイされると、次のメッセージは使用されません。ScannerHealthInfo は、スキャナーのデプロイメントに関するデータを保管しますが、このデータから派生したスキャナーの正常性ステータスは含まれません。集約されたスキャナーの正常性ステータスは中央で派生しており、最初に ScannerHealthInfo (sensor)を報告するコンポーネントに含まれていないため、含まれません。
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
totalDesiredAnalyzerPods | Integer | int32 | |||
totalReadyAnalyzerPods | Integer | int32 | |||
totalDesiredDbPods | Integer | int32 | |||
totalReadyDbPods | Integer | int32 | |||
statusErrors |
| スキャナーの正常性情報の取得の試行中に発生したエラーのコレクション。 |
11.3.7.28. StorageSensorDeploymentIdentification リンクのコピーリンクがクリップボードにコピーされました!
StackRoxDeploymentIdentification は、StackRox Sensor デプロイメントを一意に識別するためのものです。これは、再起動または再作成されたセンサー Pod からのセンサー接続(ネットワークパーティション後)、または別の namespace またはクラスターへのデプロイメントからのセンサー接続の提供に使用されるために使用されます。
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
systemNamespaceId | String | ||||
defaultNamespaceId | String | ||||
appNamespace | String | ||||
appNamespaceId | String | ||||
appServiceaccountId | String | ||||
k8sNodeName | String |
11.3.7.29. StorageStaticClusterConfig リンクのコピーリンクがクリップボードにコピーされました!
静的クラスター設定と動的クラスター設定の相違点は、静的な値がセントラルの gRPC 接続を介して送信されないことです。これらは、たとえば、セキュアなクラスターの k8s コンポーネントの設定に使用できるマニフェストを生成するために使用されます。動的に再読み込みされ ません。
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
type | GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER, | ||||
mainImage | String | ||||
centralApiEndpoint | String | ||||
collectionMethod | UNSET_COLLECTION、NO_COLLECTION、KERNEL_MODULE、EBPF、CORE_BPF | ||||
collectorImage | String | ||||
admissionController | Boolean | ||||
admissionControllerUpdates | Boolean | ||||
tolerationsConfig | |||||
slimCollector | Boolean | ||||
admissionControllerEvents | Boolean |
11.3.7.30. StorageTolerationsConfig リンクのコピーリンクがクリップボードにコピーされました!
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
disabled | Boolean |
11.3.7.31. StorageUpgradeProgress リンクのコピーリンクがクリップボードにコピーされました!
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
upgradeState | 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 証明書のみをローテーションするアップグレードプロセスを表します。
Enum 値 |
---|
アップグレード |
CERT_ROTATION |
11.3.7.33. UpgradeProgressUpgradeState リンクのコピーリンクがクリップボードにコピーされました!
- UPGRADER_LAUNCHING: 進行中の状態。
- UPGRADE_COMPLETE: 成功状態。こちら以下のすべてのエラー状態とすべてのエラー状態を確認してください。
- UPGRADE_INITIALIZATION_ERROR: エラーの状態。
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 リンクのコピーリンクがクリップボードにコピーされました!
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
clusters | |||||
clusterIdToRetentionInfo |
11.3.7.35. V1DecommissionedClusterRetentionInfo リンクのコピーリンクがクリップボードにコピーされました!
next available tag: 3
next available tag: 3
フィールド名 | 必須 | Null 許容型 | 型 | 説明 | 形式 |
---|---|---|---|---|---|
isExcluded | Boolean | ||||
daysUntilDeletion | Integer | int32 |