3.3. ListAlerts
GET /v1/alerts
list는 경고의 슬림 목록 버전을 반환합니다.
3.3.1. 설명
3.3.2. 매개 변수
3.3.2.1. 쿼리 매개변수
이름 | 설명 | 필수 항목 | 기본 | 패턴 |
---|---|---|---|---|
query | - | null | ||
pagination.limit | - | null | ||
pagination.offset | - | null | ||
pagination.sortOption.field | - | null | ||
pagination.sortOption.reversed | - | null | ||
pagination.sortOption.aggregateBy.aggrFunc | - | 설정되지 않음 | ||
pagination.sortOption.aggregateBy.distinct | - | null |
3.3.3. 반환 유형
3.3.4. 콘텐츠 유형
- application/json
3.3.5. 응답
코드 | 메시지 | datatype |
---|---|---|
200 | 성공적인 응답입니다. | |
0 | 예기치 않은 오류 응답 |
3.3.6. Samples
3.3.7. 공통 오브젝트 참조
3.3.7.1. ListAlertCommonEntityInfo
경고가 속할 수 있는 모든 엔터티에 공통된 필드입니다.
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
clusterName | 문자열 | ||||
네임스페이스 | 문자열 | ||||
clusterId | 문자열 | ||||
namespaceId | 문자열 | ||||
resourceType | 배포, 보안, CONFIGMAPS, CLUSTER_ROLES, CLUSTER_ROLE_BINDINGS, NETWORK_POLICIES, SECURITY_CONTEXT_CONSTRAINTS, EGRESS_FIREWALLS, |
3.3.7.2. ListAlertPolicyDevFields
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
SORTName | 문자열 |
3.3.7.3. ListAlertResourceEntity
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
name | 문자열 |
3.3.7.4. ProtobufAny
any
는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.
protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.
예 1: 팩 및 C++에서 메시지의 압축을 풉니다.
Foo foo = ...; Any any; any.PackFrom(foo); ... if (any.UnpackTo(&foo)) { ... }
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()); }
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.
Example 3: Pack and unpack a message in Python.
foo = Foo(...) any = Any() any.Pack(foo) ... if any.Is(Foo.DESCRIPTOR): any.Unpack(foo) ...
foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
any.Unpack(foo)
...
Example 4: Pack and unpack a message in Go
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 { ... }
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"를 생성합니다.
3.3.7.4.1. JSON 표현
Any
값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type
과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:
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"
}
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
typeUrl | 문자열 |
직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 | |||
value | byte[] | 지정된 유형의 유효한 직렬화 프로토콜 버퍼여야 합니다. | byte |
3.3.7.5. RuntimeError
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
error | 문자열 | ||||
코드 | 정수 | int32 | |||
message | 문자열 | ||||
세부 정보 |
3.3.7.6. StorageEnforcementAction
- FAIL_KUBE_REQUEST_ENFORCEMENT: FAIL_KUBE_REQUEST_ENFORCEMENT는 승인 제어 Webhook가 exec 및 port-forward 이벤트를 수신 대기할 수 있는 경우에만 적용됩니다.
- FAIL_DEPLOYMENT_CREATE_ENFORCEMENT: FAIL_DEPLOYMENT_CREATE_ENFORCEMENT는 승인 제어 Webhook가 오브젝트 생성에 적용되도록 구성된 경우에만 적용됩니다.
- FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT: FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT는 승인 제어 Webhook가 오브젝트 업데이트에 적용되도록 구성된 경우에만 적용됩니다.
열거 값 |
---|
UNSET_ENFORCEMENT |
SCALE_TO_ZERO_ENFORCEMENT |
UNSATISFIABLE_NODE_CONSTRAINT_ENFORCEMENT |
KILL_POD_ENFORCEMENT |
FAIL_BUILD_ENFORCEMENT |
FAIL_KUBE_REQUEST_ENFORCEMENT |
FAIL_DEPLOYMENT_CREATE_ENFORCEMENT |
FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT |
3.3.7.7. StorageLifecycleStage
열거 값 |
---|
배포 |
BUILD |
RUNTIME |
3.3.7.8. StorageListAlert
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
id | 문자열 | ||||
lifecycleStage | 배포, 빌드, 런타임, | ||||
time | 날짜 | 날짜-시간 | |||
policy | |||||
상태 | ACTIVE, SNO CRYOSTAT, RESOLVED, ATTEMPTED, | ||||
enforcementCount | 정수 | int32 | |||
enforcementAction | UNSET_ENFORCEMENT, SCALE_TO_ZERO_ENFORCEMENT, UNSATISFIABLE_NODE_CONSTRAINT_ENFORCEMENT, KILL_POD_ENFORCEMENT, FAIL_BUILD_ENFORCEMENT, FAIL_KUBE_REQUEST_ENFORCEMENT, FAIL_KUBE_REQUEST_ENFORCEMENT, FAIL_DEPLOYMENT_CREATE_ENFORCEMENT, FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT, | ||||
commonEntityInfo | |||||
배포 | |||||
resource |
3.3.7.9. StorageListAlertDeployment
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
id | 문자열 | ||||
name | 문자열 | ||||
clusterName | 문자열 | 이 필드는 더 이상 사용되지 않으며 CommonEntityInfo에서 찾을 수 있습니다. 향후 릴리스에서 제거될 예정입니다. | |||
네임스페이스 | 문자열 | 이 필드는 더 이상 사용되지 않으며 CommonEntityInfo에서 찾을 수 있습니다. 향후 릴리스에서 제거될 예정입니다. | |||
clusterId | 문자열 | 이 필드는 더 이상 사용되지 않으며 CommonEntityInfo에서 찾을 수 있습니다. 향후 릴리스에서 제거될 예정입니다. | |||
비활성 | 부울 | ||||
namespaceId | 문자열 | 이 필드는 더 이상 사용되지 않으며 CommonEntityInfo에서 찾을 수 있습니다. 향후 릴리스에서 제거될 예정입니다. |
3.3.7.10. StorageListAlertPolicy
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
id | 문자열 | ||||
name | 문자열 | ||||
심각도 | UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY, | ||||
description | 문자열 | ||||
카테고리 |
| ||||
developerInternalFields |
3.3.7.11. StorageListAlertResourceType
A special ListAlert-only enumeration of all resource types. Unlike Alert.Resource.ResourceType this also includes deployment as a type This must be kept in sync with Alert.Resource.ResourceType (excluding the deployment value)
A special ListAlert-only enumeration of all resource types. Unlike Alert.Resource.ResourceType this also includes deployment as a type This must be kept in sync with Alert.Resource.ResourceType (excluding the deployment value)
열거 값 |
---|
DEPLOYMENT |
SECRETS |
CONFIGMAPS |
CLUSTER_ROLES |
CLUSTER_ROLE_BINDINGS |
NETWORK_POLICIES |
SECURITY_CONTEXT_CONSTRAINTS |
EGRESS_FIREWALLS |
3.3.7.12. StorageSeverity
열거 값 |
---|
UNSET_SEVERITY |
LOW_SEVERITY |
MEDIUM_SEVERITY |
HIGH_SEVERITY |
CRITICAL_SEVERITY |
3.3.7.13. StorageViolationState
열거 값 |
---|
활성 상태 |
SNO CRYOSTATED |
RESOLVED |
ATTEMPTED |
3.3.7.14. V1ListAlertsResponse
필드 이름 | 필수 항목 | Cryostat | 유형 | 설명 | 형식 |
---|---|---|---|---|---|
경고 |