11.5. GetCluster
GET /v1/clusters/{id}
11.5.1. 설명
11.5.2. 매개 변수
11.5.2.1. 경로 매개변수
이름 | 설명 | 필수 항목 | 기본 | 패턴 |
---|---|---|---|---|
id | X | null |
11.5.3. 반환 유형
11.5.4. 콘텐츠 유형
- application/json
11.5.5. 응답
코드 | 메시지 | datatype |
---|---|---|
200 | 성공적인 응답입니다. | |
0 | 예기치 않은 오류 응답 |
11.5.6. Samples
11.5.7. 공통 오브젝트 참조
11.5.7.1. ClusterHealthStatusHealthStatusLabel
- UNAVAILABLE: 수집기만 사용할 수 없음
열거 값 |
---|
초기화되지 않음 |
사용할 수 없음 |
비정상 |
DEGRADED |
상태 |
11.5.7.2. ClusterUpgradeStatusUpgradability
- SENSOR_VERSION_HIGHER: SENSOR_VERSION_HIGHER는 센서가 이 Central보다 최신 버전을 실행하고 있음을 감지하면 발생합니다. 이는 예기치 않은 상황이지만 고객이 수행하는 패치에 따라 발생할 수 있습니다. 이 경우 autoupgrade 설정이 켜져 있어도 다운그레이드가 되기 때문에 센서를 자동으로 "업그레이드"하지 않습니다. 사용자는 업그레이드를 수동으로 트리거할 수 있지만 지원되지 않는 구성이므로 먼저 Central을 업그레이드하지 않고 사용하지 않는 것이 좋습니다.
열거 값 |
---|
설정되지 않음 |
UP_TO_DATE |
MANUAL_UPGRADE_REQUIRED |
AUTO_UPGRADE_POSSIBLE |
SENSOR_VERSION_HIGHER |
11.5.7.3. ClusterUpgradeStatusUpgradeProcessStatus
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
활성 상태 | 부울 | ||||
id | 문자열 | ||||
targetVersion | 문자열 | ||||
upgraderImage | 문자열 | ||||
initiatedAt | 날짜 | 날짜-시간 | |||
진행 상황 | |||||
type | UPGRADE, CERT_ROTATION, |
11.5.7.4. ProtobufAny
any
는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.
protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.
예 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 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.
11.5.7.4.1. JSON 표현
Any
값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type
과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:
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 표현이 있는 경우 해당 표현에 @type
필드 외에도 사용자 지정 JSON이 포함된 필드 값을
추가합니다. 예(메시지 [google.protobuf.Duration][]).
{ "@type": "type.googleapis.com/google.protobuf.Duration", "value": "1.212s" }
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
typeUrl | 문자열 |
직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 | |||
value | byte[] | 지정된 유형의 유효한 직렬화 프로토콜 버퍼여야 합니다. | byte |
11.5.7.5. RuntimeError
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
error | 문자열 | ||||
코드 | 정수 | int32 | |||
message | 문자열 | ||||
세부 정보 |
11.5.7.6. StorageAWSProviderMetadata
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
accountId | 문자열 |
11.5.7.7. StorageAdmissionControlHealthInfo
AdmissionControlHealthInfo는 승인 제어 배포에 대한 데이터를 전달하지만 이 데이터에서 파생된 승인 제어 상태는 포함하지 않습니다. 집계된 승인 제어 상태는 먼저 AdmissionControlHealthInfo(sensor)를 보고하는 구성 요소가 아닌 중앙에서 파생되므로 포함되지 않습니다.
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
totalDesiredPods | 정수 | int32 | |||
totalReadyPods | 정수 | int32 | |||
statusErrors |
| 승인 제어 상태 정보를 가져오는 동안 발생한 오류 컬렉션입니다. |
11.5.7.8. StorageAdmissionControllerConfig
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
enabled | 부울 | ||||
timeoutSeconds | 정수 | int32 | |||
scanInline | 부울 | ||||
disableBypass | 부울 | ||||
enforceOnUpdates | 부울 |
11.5.7.9. StorageAuditLogFileState
AuditLogFileState tracks the last audit log event timestamp and ID that was collected by Compliance For internal use only
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
collectLogsSince | 날짜 | 날짜-시간 | |||
lastAuditId | 문자열 |
11.5.7.10. StorageAzureProviderMetadata
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
subscriptionId | 문자열 |
11.5.7.11. StorageCluster
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
id | 문자열 | ||||
name | 문자열 | ||||
type | GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER, | ||||
labels |
| ||||
mainImage | 문자열 | ||||
collectorImage | 문자열 | ||||
centralApiEndpoint | 문자열 | ||||
runtimeSupport | 부울 | ||||
collectionMethod | UNSET_COLLECTION, NO_COLLECTION, KERNEL_MODULE, EBPF, CORE_BPF, | ||||
admissionController | 부울 | ||||
admissionControllerUpdates | 부울 | ||||
admissionControllerEvents | 부울 | ||||
status | |||||
dynamicConfig | |||||
tolerationsConfig | |||||
priority | 문자열 | int64 | |||
healthStatus | |||||
slimCollector | 부울 | ||||
helmConfig | |||||
mostRecentSensorId | |||||
auditLogState | Map of StorageAuditLogFileState | 내부 용도로만 사용됩니다. | |||
initBundleId | 문자열 | ||||
managedBy | MANAGER_TYPE_UNKNOWN, MANAGER_TYPE_MANUAL, MANAGER_TYPE_HELM_CHART, MANAGER_TYPE_KUBERNETES_OPERATOR, |
11.5.7.12. StorageClusterCertExpiryStatus
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
sensorCertExpiry | 날짜 | 날짜-시간 | |||
sensorCertNotBefore | 날짜 | 날짜-시간 |
11.5.7.13. StorageClusterHealthStatus
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
id | 문자열 | ||||
collectorHealthInfo | |||||
admissionControlHealthInfo | |||||
scannerHealthInfo | |||||
sensorHealthStatus | 초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상 | ||||
collectorHealthStatus | 초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상 | ||||
overallHealthStatus | 초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상 | ||||
admissionControlHealthStatus | 초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상 | ||||
scannerHealthStatus | 초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상 | ||||
lastContact | 날짜 | 날짜-시간 | |||
healthInfoComplete | 부울 |
11.5.7.14. StorageClusterMetadata
ClusterMetadata에는 클러스터 인프라에 대한 메타데이터 정보가 포함되어 있습니다.
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
type | 지정되지 않음, AKS, ARO, EKS, GKE, OCP, OSD, ROSA, | ||||
name | 문자열 | name은 클러스터가 클라우드 공급자에 등록된 이름을 나타냅니다. 자체 관리형 OpenShift의 경우 OpenShift 설치 프로그램에서 선택한 이름입니다. | |||
id | 문자열 |
ID는 클러스터가 클라우드 공급자에 등록된 고유한 ID를 나타냅니다. 일부 클러스터 유형에 ID가 있는 것은 아닙니다. 모든 OpenShift 클러스터의 경우 이는 OCM에 등록된 Red Hat |
11.5.7.15. StorageClusterMetadataType
열거 값 |
---|
지정되지 않음 |
AKS |
ARO |
EKS |
GKE |
OCP |
OSD |
ROSA |
11.5.7.16. StorageClusterStatus
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
sensorVersion | 문자열 | ||||
DEPRECATEDLastContact | 날짜 | 이 필드는 더 이상 사용되지 않는 릴리스 49.0부터 시작되었습니다. 대신 healthStatus.lastContact를 사용합니다. | 날짜-시간 | ||
providerMetadata | |||||
orchestratorMetadata | |||||
upgradeStatus | |||||
certExpiryStatus |
11.5.7.17. StorageClusterType
열거 값 |
---|
GENERIC_CLUSTER |
KUBERNETES_CLUSTER |
OPENSHIFT_CLUSTER |
OPENSHIFT4_CLUSTER |
11.5.7.18. StorageClusterUpgradeStatus
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
upgradability | UNSET, UP_TO_DATE, MANUAL_UPGRADE_REQUIRED, AUTO_UPGRADE_POSSIBLE, SENSOR_VERSION_HIGHER, | ||||
upgradabilityStatusReason | 문자열 | ||||
mostRecentProcess |
11.5.7.19. StorageCollectionMethod
열거 값 |
---|
UNSET_COLLECTION |
NO_COLLECTION |
KERNEL_MODULE |
EBPF |
CORE_BPF |
11.5.7.20. StorageCollectorHealthInfo
CollectorHealthInfo는 수집기 배포에 대한 데이터를 전달하지만 이 데이터에서 파생된 수집기 상태 상태는 포함하지 않습니다. 집계된 수집기 상태는 중앙에서 파생되고 먼저 CollectorHealthInfo(sensor)를 보고하는 구성 요소에서 파생되므로 포함되지 않습니다.
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
version | 문자열 | ||||
totalDesiredPods | 정수 | int32 | |||
totalReadyPods | 정수 | int32 | |||
totalRegisteredNodes | 정수 | int32 | |||
statusErrors |
| 수집기 상태 정보를 가져오는 동안 발생한 오류 컬렉션입니다. |
11.5.7.21. StorageCompleteClusterConfig
정적 및 동적 설정을 포함하여 전체 클러스터 구성을 ID/이름 식별자로 인코딩합니다.
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
dynamicConfig | |||||
staticConfig | |||||
configFingerprint | 문자열 | ||||
clusterLabels |
|
11.5.7.22. StorageDynamicClusterConfig
정적 클러스터 구성과 동적 클러스터 구성의 차이점은 Dynamic 값이 Central을 통해 Sensor gRPC 연결로 전송된다는 것입니다. 이로 인해 보안 클러스터 구성 요소를 다시 시작하지 않고 값의 "가져오기"를 허용할 수 있습니다.
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
admissionControllerConfig | |||||
registryOverride | 문자열 | ||||
disableAuditLogs | 부울 |
11.5.7.23. StorageGoogleProviderMetadata
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
project | 문자열 | ||||
clusterName | 문자열 | providerMetadata.cluster.name 대신 더 이상 사용되지 않습니다. |
11.5.7.24. StorageManagerType
열거 값 |
---|
MANAGER_TYPE_UNKNOWN |
MANAGER_TYPE_MANUAL |
MANAGER_TYPE_HELM_CHART |
MANAGER_TYPE_KUBERNETES_OPERATOR |
11.5.7.25. StorageOrchestratorMetadata
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
version | 문자열 | ||||
openshiftVersion | 문자열 | ||||
buildDate | 날짜 | 날짜-시간 | |||
apiVersions |
|
11.5.7.26. StorageProviderMetadata
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
region | 문자열 | ||||
영역 | 문자열 | ||||
| |||||
AWS | |||||
azure | |||||
검증됨 | 부울 | ||||
cluster |
11.5.7.27. StorageScannerHealthInfo
scannerHealthInfo는 보안 클러스터("로컬 스캐너")에 배포된 스캐너 인스턴스의 상태 정보를 나타냅니다. 스캐너가 중앙 클러스터에 배포되면 다음 메시지가 사용되지 않습니다. scannerHealthInfo는 스캐너 배포에 대한 데이터를 전달하지만 이 데이터에서 파생된 스캐너 상태 상태는 포함하지 않습니다. 집계된 스캐너 상태는 중앙에서 파생되고 먼저 ScannerHealthInfo(sensor)를 보고하는 구성 요소에서 파생되므로 포함되지 않습니다.
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
totalDesiredAnalyzerPods | 정수 | int32 | |||
totalReadyAnalyzerPods | 정수 | int32 | |||
totalDesiredDbPods | 정수 | int32 | |||
totalReadyDbPods | 정수 | int32 | |||
statusErrors |
| 스캐너 상태 정보를 가져오는 동안 발생한 오류 컬렉션입니다. |
11.5.7.28. StorageSensorDeploymentIdentification
StackRoxDeploymentIdentification은 StackRox Sensor 배포를 고유하게 식별하는 것을 목표로 합니다. 센서 연결이 다시 시작되거나 다시 생성된 센서 Pod에서 제공되는지(네트워크 파티션 후에 발생할 수 있음) 또는 다른 네임스페이스 또는 클러스터의 배포에서 제공하는 데 사용됩니다.
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
systemNamespaceId | 문자열 | ||||
defaultNamespaceId | 문자열 | ||||
appNamespace | 문자열 | ||||
appNamespaceId | 문자열 | ||||
appServiceaccountId | 문자열 | ||||
k8sNodeName | 문자열 |
11.5.7.29. StorageStaticClusterConfig
정적 클러스터 구성과 동적 클러스터 구성의 차이점은 정적 값이 Central을 통해 Sensor gRPC 연결로 전송되지 않는다는 것입니다. 예를 들어 Secured Cluster의 k8s 구성 요소를 설정하는 데 사용할 수 있는 매니페스트를 생성하는 데 사용됩니다. 동적으로 다시 로드 되지 않습니다.
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
type | GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER, | ||||
mainImage | 문자열 | ||||
centralApiEndpoint | 문자열 | ||||
collectionMethod | UNSET_COLLECTION, NO_COLLECTION, KERNEL_MODULE, EBPF, CORE_BPF, | ||||
collectorImage | 문자열 | ||||
admissionController | 부울 | ||||
admissionControllerUpdates | 부울 | ||||
tolerationsConfig | |||||
slimCollector | 부울 | ||||
admissionControllerEvents | 부울 |
11.5.7.30. StorageTolerationsConfig
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
비활성화됨 | 부울 |
11.5.7.31. StorageUpgradeProgress
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
upgradeState | UPGRADE_INITIALIZING, UPGRADER_LAUNCHING, UPGRADER_LAUNCHED, PRE_FLIGHT_CHECKS_COMPLETE, UPGRADE_OPERATIONS_DONE, UPGRADE_COMPLETE, 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_ERROR_BACK UPGRADE_TIMED_OUT | ||||
upgradeStatusDetail | 문자열 | ||||
이후 | 날짜 | 날짜-시간 |
11.5.7.32. UpgradeProcessStatusUpgradeProcessType
- UPGRADE: UPGRADE는 센서 버전 업그레이드를 나타냅니다.
- CERT_ROTATION: CERT_ROTATION은 다른 항목을 변경하지 않고 클러스터에서 사용하는 TLS 인증서만 회전하는 업그레이드 프로세스를 나타냅니다.
열거 값 |
---|
업그레이드 |
CERT_ROTATION |
11.5.7.33. 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 |
11.5.7.34. V1ClusterResponse
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
cluster | |||||
clusterRetentionInfo |
11.5.7.35. V1DecommissionedClusterRetentionInfo
next available tag: 3
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
isExcluded | 부울 | ||||
daysUntilDeletion | 정수 | int32 |