API 참조


Red Hat Advanced Cluster Security for Kubernetes 4.7

Red Hat Advanced Cluster Security for Kubernetes용 API 참조 가이드

Red Hat OpenShift Documentation Team

초록

이 문서에서는 Red Hat Advanced Cluster Security for Kubernetes API 오브젝트 및 세부 사양에 대해 설명합니다.

1장. 버전 v1

1.1. AdministrationEventService

1.1.1. ListAdministrationEvents

GET /v1/administration/events

ListAdministrationEvents는 요청된 필드로 필터링된 후 이벤트 목록을 반환합니다.

1.1.1.1. 설명
1.1.1.2. 매개 변수
1.1.1.2.1. 쿼리 매개변수
이름설명필수 항목기본패턴

pagination.limit

 

-

null

 

pagination.offset

 

-

null

 

pagination.sortOption.field

 

-

null

 

pagination.sortOption.reversed

 

-

null

 

pagination.sortOption.aggregateBy.aggrFunc

 

-

설정되지 않음

 

pagination.sortOption.aggregateBy.distinct

 

-

null

 

filter.from

특정 타임스탬프(즉, 더 낮은 경계) 후 last_occurred_at와 일치하는 이벤트를 찾습니다.

-

null

 

filter.until

특정 타임 스탬프 전에 last_occurred_at와 일치하는 이벤트, 즉 상한입니다.

-

null

 

filter.domain

특정 도메인의 이벤트 일치 문자열

-

null

 

filter.resourceType

특정 리소스 유형과 연결된 이벤트와 일치합니다. 문자열

-

null

 

filter.type

유형에 따라 이벤트를 일치시킵니다. 문자열

-

null

 

filter.level

수준에 따라 이벤트를 일치시킵니다. 문자열

-

null

 
1.1.1.3. 반환 유형

V1ListAdministrationEventsResponse

1.1.1.4. 콘텐츠 유형
  • application/json
1.1.1.5. 응답
표 1.1. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1ListAdministrationEventsResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.1.1.6. Samples
1.1.1.7. 공통 오브젝트 참조
1.1.1.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.1.1.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.1.1.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.1.1.7.3. V1AdministrationEvent

AdministrationEvents는 Central에서 보내는 관리 이벤트입니다. 비동기, 백그라운드 작업에 대한 투명도를 만드는 데 사용됩니다. 이벤트는 중앙 시스템 상태 보기의 일부입니다.

필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

이벤트의 UUID입니다.

 

type

  

V1AdministrationEventType

 

ADMINISTRATION_EVENT_TYPE_UNKNOWN, ADMINISTRATION_EVENT_TYPE_GENERIC, ADMINISTRATION_EVENT_TYPE_LOG_MESSAGE,

level

  

V1AdministrationEventLevel

 

ADMINISTRATION_EVENT_LEVEL_UNKNOWN, ADMINISTRATION_EVENT_LEVEL_INFO, ADMINISTRATION_EVENT_LEVEL_SUCCESS, ADMINISTRATION_EVENT_LEVEL_WARNING, ADMINISTISTRATION_EVENT_LEVEL_ERROR,

message

  

문자열

이벤트와 관련된 메시지입니다. 메시지에는 이 특정 이벤트에 대한 자세한 정보가 포함될 수 있습니다.

 

  

문자열

이벤트와 관련된 팁입니다. 팁에는 이벤트 유형에 따라 다양한 정보가 포함될 수 있습니다. 여기에는 이벤트를 해결하기 위한 지침 또는 정보 힌트가 포함될 수 있습니다.

 

domain

  

문자열

이벤트와 연결된 도메인입니다. 이벤트의 도메인은 이벤트가 생성된 기능 도메인을 간략하게 설명합니다. 예를 들어 \"Image Scanning\"일 수 있습니다. 특정 도메인에 연결할 수 없는 이벤트의 경우 \"General\"가 됩니다.

 

resource

  

V1AdministrationEventResource

  

numOccurrences

  

문자열

이벤트와 관련된 이벤트입니다. 이벤트가 여러 번 발생할 수 있는 경우 발생은 양을 추적합니다.

int64

lastOccurredAt

  

날짜

이벤트가 마지막으로 발생한 시간을 지정합니다.

날짜-시간

createdAt

  

날짜

이벤트가 생성된 시간을 지정합니다.

날짜-시간

1.1.1.7.4. V1AdministrationEventLevel

AdministrationEventLevel은 다양한 수준의 이벤트를 노출합니다.

열거 값

ADMINISTRATION_EVENT_LEVEL_UNKNOWN

ADMINISTRATION_EVENT_LEVEL_INFO

ADMINISTRATION_EVENT_LEVEL_SUCCESS

ADMINISTRATION_EVENT_LEVEL_WARNING

ADMINISTRATION_EVENT_LEVEL_ERROR

1.1.1.7.5. V1AdministrationEventResource

resource에는 이벤트와 연결된 리소스에 대한 모든 정보가 들어 있습니다.

필드 이름필수 항목Cryostat유형설명형식

type

  

문자열

이벤트와 관련된 리소스 유형입니다. 이벤트는 특정 이미지와 같은 기본 리소스를 참조할 수 있습니다. 이 경우 리소스 유형이 여기에 채워집니다.

 

id

  

문자열

이벤트와 연결된 리소스 ID입니다. 이벤트가 기본 리소스를 참조하는 경우 리소스 ID는 기본 리소스를 식별합니다. 관리 이벤트의 컨텍스트에 따라 리소스 ID를 설정할 수 없습니다.

 

name

  

문자열

이벤트와 관련된 리소스 이름입니다. 이벤트가 기본 리소스를 참조하는 경우 리소스 이름은 기본 리소스를 식별합니다. 관리 이벤트의 컨텍스트에 따라 리소스 이름을 설정할 수 없습니다.

 
1.1.1.7.6. V1AdministrationEventType

AdministrationEventType은 다양한 유형의 이벤트를 노출합니다.

열거 값

ADMINISTRATION_EVENT_TYPE_UNKNOWN

ADMINISTRATION_EVENT_TYPE_GENERIC

ADMINISTRATION_EVENT_TYPE_LOG_MESSAGE

1.1.1.7.7. V1ListAdministrationEventsResponse
필드 이름필수 항목Cryostat유형설명형식

이벤트

  

V1AdministrationEvent목록

  

1.1.2. GetAdministrationEvent

GET /v1/administration/events/{id}

GetAdministrationEvent는 ID로 이벤트를 검색합니다.

1.1.2.1. 설명
1.1.2.2. 매개 변수
1.1.2.2.1. 경로 매개변수
이름설명필수 항목기본패턴

id

 

X

null

 
1.1.2.3. 반환 유형

V1GetAdministrationEventResponse

1.1.2.4. 콘텐츠 유형
  • application/json
1.1.2.5. 응답
표 1.2. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1GetAdministrationEventResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.1.2.6. Samples
1.1.2.7. 공통 오브젝트 참조
1.1.2.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.1.2.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.1.2.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.1.2.7.3. V1AdministrationEvent

AdministrationEvents는 Central에서 보내는 관리 이벤트입니다. 비동기, 백그라운드 작업에 대한 투명도를 만드는 데 사용됩니다. 이벤트는 중앙 시스템 상태 보기의 일부입니다.

필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

이벤트의 UUID입니다.

 

type

  

V1AdministrationEventType

 

ADMINISTRATION_EVENT_TYPE_UNKNOWN, ADMINISTRATION_EVENT_TYPE_GENERIC, ADMINISTRATION_EVENT_TYPE_LOG_MESSAGE,

level

  

V1AdministrationEventLevel

 

ADMINISTRATION_EVENT_LEVEL_UNKNOWN, ADMINISTRATION_EVENT_LEVEL_INFO, ADMINISTRATION_EVENT_LEVEL_SUCCESS, ADMINISTRATION_EVENT_LEVEL_WARNING, ADMINISTISTRATION_EVENT_LEVEL_ERROR,

message

  

문자열

이벤트와 관련된 메시지입니다. 메시지에는 이 특정 이벤트에 대한 자세한 정보가 포함될 수 있습니다.

 

  

문자열

이벤트와 관련된 팁입니다. 팁에는 이벤트 유형에 따라 다양한 정보가 포함될 수 있습니다. 여기에는 이벤트를 해결하기 위한 지침 또는 정보 힌트가 포함될 수 있습니다.

 

domain

  

문자열

이벤트와 연결된 도메인입니다. 이벤트의 도메인은 이벤트가 생성된 기능 도메인을 간략하게 설명합니다. 예를 들어 \"Image Scanning\"일 수 있습니다. 특정 도메인에 연결할 수 없는 이벤트의 경우 \"General\"가 됩니다.

 

resource

  

V1AdministrationEventResource

  

numOccurrences

  

문자열

이벤트와 관련된 이벤트입니다. 이벤트가 여러 번 발생할 수 있는 경우 발생은 양을 추적합니다.

int64

lastOccurredAt

  

날짜

이벤트가 마지막으로 발생한 시간을 지정합니다.

날짜-시간

createdAt

  

날짜

이벤트가 생성된 시간을 지정합니다.

날짜-시간

1.1.2.7.4. V1AdministrationEventLevel

AdministrationEventLevel은 다양한 수준의 이벤트를 노출합니다.

열거 값

ADMINISTRATION_EVENT_LEVEL_UNKNOWN

ADMINISTRATION_EVENT_LEVEL_INFO

ADMINISTRATION_EVENT_LEVEL_SUCCESS

ADMINISTRATION_EVENT_LEVEL_WARNING

ADMINISTRATION_EVENT_LEVEL_ERROR

1.1.2.7.5. V1AdministrationEventResource

resource에는 이벤트와 연결된 리소스에 대한 모든 정보가 들어 있습니다.

필드 이름필수 항목Cryostat유형설명형식

type

  

문자열

이벤트와 관련된 리소스 유형입니다. 이벤트는 특정 이미지와 같은 기본 리소스를 참조할 수 있습니다. 이 경우 리소스 유형이 여기에 채워집니다.

 

id

  

문자열

이벤트와 연결된 리소스 ID입니다. 이벤트가 기본 리소스를 참조하는 경우 리소스 ID는 기본 리소스를 식별합니다. 관리 이벤트의 컨텍스트에 따라 리소스 ID를 설정할 수 없습니다.

 

name

  

문자열

이벤트와 관련된 리소스 이름입니다. 이벤트가 기본 리소스를 참조하는 경우 리소스 이름은 기본 리소스를 식별합니다. 관리 이벤트의 컨텍스트에 따라 리소스 이름을 설정할 수 없습니다.

 
1.1.2.7.6. V1AdministrationEventType

AdministrationEventType은 다양한 유형의 이벤트를 노출합니다.

열거 값

ADMINISTRATION_EVENT_TYPE_UNKNOWN

ADMINISTRATION_EVENT_TYPE_GENERIC

ADMINISTRATION_EVENT_TYPE_LOG_MESSAGE

1.1.2.7.7. V1GetAdministrationEventResponse
필드 이름필수 항목Cryostat유형설명형식

event

  

V1AdministrationEvent

  

1.1.3. CountAdministrationEvents

GET /v1/count/administration/events

CountAdministrationEvents는 요청된 필드로 필터링한 후 이벤트 수를 반환합니다.

1.1.3.1. 설명
1.1.3.2. 매개 변수
1.1.3.2.1. 쿼리 매개변수
이름설명필수 항목기본패턴

filter.from

특정 타임스탬프(즉, 더 낮은 경계) 후 last_occurred_at와 일치하는 이벤트를 찾습니다.

-

null

 

filter.until

특정 타임 스탬프 전에 last_occurred_at와 일치하는 이벤트, 즉 상한입니다.

-

null

 

filter.domain

특정 도메인의 이벤트 일치 문자열

-

null

 

filter.resourceType

특정 리소스 유형과 연결된 이벤트와 일치합니다. 문자열

-

null

 

filter.type

유형에 따라 이벤트를 일치시킵니다. 문자열

-

null

 

filter.level

수준에 따라 이벤트를 일치시킵니다. 문자열

-

null

 
1.1.3.3. 반환 유형

V1CountAdministrationEventsResponse

1.1.3.4. 콘텐츠 유형
  • application/json
1.1.3.5. 응답
표 1.3. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1CountAdministrationEventsResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.1.3.6. Samples
1.1.3.7. 공통 오브젝트 참조
1.1.3.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.1.3.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.1.3.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.1.3.7.3. V1CountAdministrationEventsResponse
필드 이름필수 항목Cryostat유형설명형식

count

  

정수

필터링 및 중복 제거 후 총 이벤트 수입니다.

int32

1.2. AdministrationUsageService

1.2.1. GetCurrentSecuredUnitsUsage

GET /v1/administration/usage/secured-units/current

GetCurrentSecuredUnitsUsage는 현재 보안된 단위 사용량 메트릭 값을 반환합니다.

1.2.1.1. 설명

보안 단위 지표는 5분마다 연결된 모든 클러스터에서 수집되므로 반환된 결과에는 약 5분 동안 정확한 연결된 클러스터에 대한 데이터와 연결이 끊긴 클러스터에 대한 일부 오래된 데이터가 포함될 수 있습니다.

1.2.1.2. 매개 변수
1.2.1.3. 반환 유형

V1SecuredUnitsUsageResponse

1.2.1.4. 콘텐츠 유형
  • application/json
1.2.1.5. 응답
표 1.4. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1SecuredUnitsUsageResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.2.1.6. Samples
1.2.1.7. 공통 오브젝트 참조
1.2.1.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.2.1.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.2.1.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.2.1.7.3. V1SecuredUnitsUsageResponse

SecuredUnitsUsageResponse에는 현재 관찰 가능한 관리 사용 지표 값이 있습니다.

필드 이름필수 항목Cryostat유형설명형식

numNodes

  

문자열

 

int64

numCpuUnits

  

문자열

 

int64

1.2.2. GetMaxSecuredUnitsUsage

GET /v1/administration/usage/secured-units/max

GetMaxSecuredUnitsUsage는 이 최대값이 집계되어 저장된 시간과 함께 지정된 시간 동안 관찰되는 최대 보안 단위 사용량을 반환합니다.

1.2.2.1. 설명

사용량 메트릭은 연결된 모든 클러스터에서 지속적으로 수집됩니다. 최대 값은 일정 기간 동안 메모리에 보관된 다음 주기적으로 데이터베이스에 저장됩니다. 연결이 끊긴 클러스터의 마지막 데이터가 고려됩니다.

1.2.2.2. 매개 변수
1.2.2.2.1. 쿼리 매개변수
이름설명필수 항목기본패턴

from

 

-

null

 

다음으로 변경

 

-

null

 
1.2.2.3. 반환 유형

V1MaxSecuredUnitsUsageResponse

1.2.2.4. 콘텐츠 유형
  • application/json
1.2.2.5. 응답
표 1.5. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1MaxSecuredUnitsUsageResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.2.2.6. Samples
1.2.2.7. 공통 오브젝트 참조
1.2.2.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.2.2.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.2.2.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.2.2.7.3. V1MaxSecuredUnitsUsageResponse

MaxSecuredUnitsUsageResponse는 보안 노드의 최대 값과 함께 보안 노드의 최대 값과 CPU 단위(Kubernetes에서 보고됨)를 보유하고 있으며 집계 기간 정확도(1h)를 사용하여 이러한 값이 집계된 시간입니다.

필드 이름필수 항목Cryostat유형설명형식

maxNodesAt

  

날짜

 

날짜-시간

maxNodes

  

문자열

 

int64

maxCpuUnitsAt

  

날짜

 

날짜-시간

maxCpuUnits

  

문자열

 

int64

1.3. AlertService

1.3.1. CountAlerts

GET /v1/alertscount

CountAlerts는 get 요청과 일치하는 경고 수를 계산합니다.

1.3.1.1. 설명
1.3.1.2. 매개 변수
1.3.1.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

 
1.3.1.3. 반환 유형

V1CountAlertsResponse

1.3.1.4. 콘텐츠 유형
  • application/json
1.3.1.5. 응답
표 1.6. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1CountAlertsResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.3.1.6. Samples
1.3.1.7. 공통 오브젝트 참조
1.3.1.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.3.1.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.3.1.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.3.1.7.3. V1CountAlertsResponse
필드 이름필수 항목Cryostat유형설명형식

count

  

정수

 

int32

1.3.2. DeleteAlerts

DELETE /v1/alerts

1.3.2.1. 설명
1.3.2.2. 매개 변수
1.3.2.2.1. 쿼리 매개변수
이름설명필수 항목기본패턴

query.query

 

-

null

 

query.pagination.limit

 

-

null

 

query.pagination.offset

 

-

null

 

query.pagination.sortOption.field

 

-

null

 

query.pagination.sortOption.reversed

 

-

null

 

query.pagination.sortOption.aggregateBy.aggrFunc

 

-

설정되지 않음

 

query.pagination.sortOption.aggregateBy.distinct

 

-

null

 

확인

 

-

null

 
1.3.2.3. 반환 유형

V1DeleteAlertsResponse

1.3.2.4. 콘텐츠 유형
  • application/json
1.3.2.5. 응답
표 1.7. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1DeleteAlertsResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.3.2.6. Samples
1.3.2.7. 공통 오브젝트 참조
1.3.2.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.3.2.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.3.2.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.3.2.7.3. V1DeleteAlertsResponse
필드 이름필수 항목Cryostat유형설명형식

numDeleted

  

long

 

int64

dryRun

  

부울

  

1.3.3. ListAlerts

GET /v1/alerts

list는 경고의 슬림 목록 버전을 반환합니다.

1.3.3.1. 설명
1.3.3.2. 매개 변수
1.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

 
1.3.3.3. 반환 유형

V1ListAlertsResponse

1.3.3.4. 콘텐츠 유형
  • application/json
1.3.3.5. 응답
표 1.8. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1ListAlertsResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.3.3.6. Samples
1.3.3.7. 공통 오브젝트 참조
1.3.3.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.3.3.7.2. ListAlertCommonEntityInfo

경고가 속할 수 있는 모든 엔터티에 공통된 필드입니다.

필드 이름필수 항목Cryostat유형설명형식

clusterName

  

문자열

  

네임스페이스

  

문자열

  

clusterId

  

문자열

  

namespaceId

  

문자열

  

resourceType

  

StorageListAlertResourceType

 

배포, 보안, CONFIGMAPS, CLUSTER_ROLES, CLUSTER_ROLE_BINDINGS, NETWORK_POLICIES, SECURITY_CONTEXT_CONSTRAINTS, EGRESS_FIREWALLS,

1.3.3.7.3. ListAlertPolicyDevFields
필드 이름필수 항목Cryostat유형설명형식

SORTName

  

문자열

  
1.3.3.7.4. ListAlertResourceEntity
필드 이름필수 항목Cryostat유형설명형식

name

  

문자열

  
1.3.3.7.5. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.3.3.7.5.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.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

1.3.3.7.7. StorageLifecycleStage
열거 값

배포

BUILD

RUNTIME

1.3.3.7.8. StorageListAlert
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

lifecycleStage

  

StorageLifecycleStage

 

배포, 빌드, 런타임,

time

  

날짜

 

날짜-시간

policy

  

StorageListAlertPolicy

  

상태

  

StorageViolationState

 

ACTIVE, RESOLVED, ATTEMPTED,

enforcementCount

  

정수

 

int32

enforcementAction

  

StorageEnforcementAction

 

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

  

ListAlertCommonEntityInfo

  

배포

  

StorageListAlertDeployment

  

resource

  

ListAlertResourceEntity

  
1.3.3.7.9. StorageListAlertDeployment
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

clusterName

  

문자열

이 필드는 더 이상 사용되지 않으며 CommonEntityInfo에서 찾을 수 있습니다. 향후 릴리스에서 제거될 예정입니다. 이 필드는 CommonEntityInfo로 이동했습니다.

 

네임스페이스

  

문자열

이 필드는 더 이상 사용되지 않으며 CommonEntityInfo에서 찾을 수 있습니다. 향후 릴리스에서 제거될 예정입니다. 이 필드는 CommonEntityInfo로 이동했습니다.

 

clusterId

  

문자열

이 필드는 더 이상 사용되지 않으며 CommonEntityInfo에서 찾을 수 있습니다. 향후 릴리스에서 제거될 예정입니다. 이 필드는 CommonEntityInfo로 이동했습니다.

 

비활성

  

부울

  

namespaceId

  

문자열

이 필드는 더 이상 사용되지 않으며 CommonEntityInfo에서 찾을 수 있습니다. 향후 릴리스에서 제거될 예정입니다. 이 필드는 CommonEntityInfo로 이동했습니다.

 

deploymentType

  

문자열

  
1.3.3.7.10. StorageListAlertPolicy
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

심각도

  

StorageSeverity

 

UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY,

description

  

문자열

  

카테고리

  

문자열목록

  

developerInternalFields

  

ListAlertPolicyDevFields

  
1.3.3.7.11. StorageListAlertResourceType
Copy to Clipboard Toggle word wrap
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

1.3.3.7.12. StorageSeverity
열거 값

UNSET_SEVERITY

LOW_SEVERITY

MEDIUM_SEVERITY

HIGH_SEVERITY

CRITICAL_SEVERITY

1.3.3.7.13. StorageViolationState
열거 값

ACTIVE

RESOLVED

ATTEMPTED

1.3.3.7.14. V1ListAlertsResponse
필드 이름필수 항목Cryostat유형설명형식

경고

  

StorageListAlert목록

  

1.3.4. GetAlert

GET /v1/alerts/{id}

GetAlert는 ID가 지정된 경고를 반환합니다.

1.3.4.1. 설명
1.3.4.2. 매개 변수
1.3.4.2.1. 경로 매개변수
이름설명필수 항목기본패턴

id

 

X

null

 
1.3.4.3. 반환 유형

StorageAlert

1.3.4.4. 콘텐츠 유형
  • application/json
1.3.4.5. 응답
표 1.9. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

StorageAlert

0

예기치 않은 오류 응답

GooglerpcStatus

1.3.4.6. Samples
1.3.4.7. 공통 오브젝트 참조
1.3.4.7.1. AlertDeploymentContainer
필드 이름필수 항목Cryostat유형설명형식

image

  

StorageContainerImage

  

name

  

문자열

  
1.3.4.7.2. AlertEnforcement
필드 이름필수 항목Cryostat유형설명형식

작업

  

StorageEnforcementAction

 

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,

message

  

문자열

  
1.3.4.7.3. AlertEntityType
열거 값

설정되지 않음

DEPLOYMENT

CONTAINER_IMAGE

리소스

1.3.4.7.4. AlertProcessViolation
필드 이름필수 항목Cryostat유형설명형식

message

  

문자열

  

프로세스

  

스토리지ProcessIndicator목록

  
1.3.4.7.5. AlertResourceResourceType
열거 값

알 수 없음

SECRETS

CONFIGMAPS

CLUSTER_ROLES

CLUSTER_ROLE_BINDINGS

NETWORK_POLICIES

SECURITY_CONTEXT_CONSTRAINTS

EGRESS_FIREWALLS

1.3.4.7.6. AlertViolation
필드 이름필수 항목Cryostat유형설명형식

message

  

문자열

  

keyValueAttrs

  

ViolationKeyValueAttrs

  

networkFlowInfo

  

ViolationNetworkFlowInfo

  

type

  

AlertViolationType

 

GENERIC, K8S_EVENT, NETWORK_FLOW, NETWORK_POLICY,

time

  

날짜

위반 시간을 나타냅니다. 이 필드는 정책 경고가 여러 번 발생하는 경우 경고가 마지막으로 발생한 시간을 나타내는 최상위 필드 '시간'과 다릅니다. 55.0부터 이 필드는 kubernetes 이벤트 위반에만 설정되지만 나중에는 이에 국한되지 않을 수 있습니다.

날짜-시간

1.3.4.7.7. AlertViolationType
열거 값

일반

K8S_EVENT

NETWORK_FLOW

NETWORK_POLICY

1.3.4.7.8. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.3.4.7.9. KeyValueAttrsKeyValueAttr
필드 이름필수 항목Cryostat유형설명형식

key

  

문자열

  

value

  

문자열

  
1.3.4.7.10. NetworkFlowInfoEntity
필드 이름필수 항목Cryostat유형설명형식

name

  

문자열

  

entityType

  

StorageNetworkEntityInfoType

 

UNKNOWN_TYPE, DEPLOYMENT, INTERNET, LISTEN_ENDPOINT, EXTERNAL_SOURCE, INTERNAL_ENTITIES

deploymentNamespace

  

문자열

  

deploymentType

  

문자열

  

port

  

정수

 

int32

1.3.4.7.11. PolicyMitreAttackVectors
필드 이름필수 항목Cryostat유형설명형식

전략

  

문자열

  

기술

  

문자열목록

  
1.3.4.7.12. ProcessSignalLineageInfo
필드 이름필수 항목Cryostat유형설명형식

parentUid

  

long

 

int64

parentExecFilePath

  

문자열

  
1.3.4.7.13. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.3.4.7.13.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.3.4.7.14. StorageAlert
Copy to Clipboard Toggle word wrap
Next available tag: 24
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

policy

  

StoragePolicy

  

lifecycleStage

  

StorageLifecycleStage

 

배포, 빌드, 런타임,

clusterId

  

문자열

  

clusterName

  

문자열

  

네임스페이스

  

문자열

  

namespaceId

  

문자열

  

배포

  

StorageAlertDeployment

  

image

  

StorageContainerImage

  

resource

  

StorageAlertResource

  

위반

  

AlertViolation목록

런타임 단계 경고의 경우 최대 40개의 위반이 유지됩니다.

 

processViolation

  

AlertProcessViolation

  

적용

  

AlertEnforcement

  

time

  

날짜

 

날짜-시간

firstOccurred

  

날짜

 

날짜-시간

resolvedAt

  

날짜

경고가 해결된 시간입니다. ViolationState가 RESOLVED인 경우에만 설정합니다.

날짜-시간

상태

  

StorageViolationState

 

ACTIVE, RESOLVED, ATTEMPTED,

platformComponent

  

부울

  

entityType

  

AlertEntityType

 

설정되지 않음, 배포, CONTAINER_IMAGE, 리소스

1.3.4.7.15. StorageAlertDeployment
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

type

  

문자열

  

네임스페이스

  

문자열

범위 관리 및 검색을 위해 경고에서 이 필드를 복제해야 합니다.

 

namespaceId

  

문자열

범위 관리 및 검색을 위해 경고에서 이 필드를 복제해야 합니다.

 

labels

  

문자열

  

clusterId

  

문자열

범위 관리 및 검색을 위해 경고에서 이 필드를 복제해야 합니다.

 

clusterName

  

문자열

범위 관리 및 검색을 위해 경고에서 이 필드를 복제해야 합니다.

 

컨테이너

  

AlertDeploymentContainer목록

  

annotations

  

문자열

  

비활성

  

부울

  
1.3.4.7.16. StorageAlertResource
Copy to Clipboard Toggle word wrap
Represents an alert on a kubernetes resource other than a deployment (configmaps, secrets, etc.)
필드 이름필수 항목Cryostat유형설명형식

resourceType

  

AlertResourceResourceType

 

알 수 없는 보안, 보안, CONFIGMAPS, CLUSTER_ROLES, CLUSTER_ROLE_BINDINGS, NETWORK_POLICIES, SECURITY_CONTEXT_CONSTRAINTS, EGRESS_FIREWALLS,

name

  

문자열

  

clusterId

  

문자열

범위 관리 및 검색을 위해 경고에서 이 필드를 복제해야 합니다.

 

clusterName

  

문자열

범위 관리 및 검색을 위해 경고에서 이 필드를 복제해야 합니다.

 

네임스페이스

  

문자열

범위 관리 및 검색을 위해 경고에서 이 필드를 복제해야 합니다.

 

namespaceId

  

문자열

범위 관리 및 검색을 위해 경고에서 이 필드를 복제해야 합니다.

 
1.3.4.7.17. StorageBooleanOperator
열거 값

또는

1.3.4.7.18. StorageContainerImage
Copy to Clipboard Toggle word wrap
Next tag: 12
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

StorageImageName

  

notPullable

  

부울

  

isClusterLocal

  

부울

  
1.3.4.7.19. 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

1.3.4.7.20. StorageEventSource
열거 값

NOT_APPLICABLE

DEPLOYMENT_EVENT

AUDIT_LOG_EVENT

1.3.4.7.21. StorageExclusion
필드 이름필수 항목Cryostat유형설명형식

name

  

문자열

  

배포

  

StorageExclusionDeployment

  

image

  

StorageExclusionImage

  

만료

  

날짜

 

날짜-시간

1.3.4.7.22. StorageExclusionDeployment
필드 이름필수 항목Cryostat유형설명형식

name

  

문자열

  

scope

  

StorageScope

  
1.3.4.7.23. StorageExclusionImage
필드 이름필수 항목Cryostat유형설명형식

name

  

문자열

  
1.3.4.7.24. StorageImageName
필드 이름필수 항목Cryostat유형설명형식

레지스트리

  

문자열

  

remote

  

문자열

  

tag

  

문자열

  

fullname

  

문자열

  
1.3.4.7.25. StorageL4Protocol
열거 값

L4_PROTOCOL_UNKNOWN

L4_PROTOCOL_TCP

L4_PROTOCOL_UDP

L4_PROTOCOL_ICMP

L4_PROTOCOL_RAW

L4_PROTOCOL_SCTP

L4_PROTOCOL_ANY

1.3.4.7.26. StorageLifecycleStage
열거 값

배포

BUILD

RUNTIME

1.3.4.7.27. StorageNetworkEntityInfoType
  • INTERNAL_ENTITIES: INTERNAL_ENTITIES는 단일 네트워크 그래프 노드 아래의 모든 내부 엔티티를 그룹화하기 위한 것입니다.
열거 값

UNKNOWN_TYPE

DEPLOYMENT

인터넷

LISTEN_ENDPOINT

EXTERNAL_SOURCE

INTERNAL_ENTITIES

1.3.4.7.28. StoragePolicy
Copy to Clipboard Toggle word wrap
Next tag: 28
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

정책 이름입니다. 고유해야 합니다.

 

description

  

문자열

이 정책에 대한 무료 텍스트 설명입니다.

 

이유

  

문자열

  

수정

  

문자열

이 정책 위반을 해결하는 방법을 설명합니다.

 

비활성화됨

  

부울

이 정책이 실행될지 여부를 토글하고 적극적으로 경고를 실행합니다.

 

카테고리

  

문자열목록

이 정책이 적용되는 카테고리 목록입니다. 범주 이름은 이미 중앙에 있어야 합니다.

 

lifecycleStages

  

StorageLifecycleStage목록

이 정책이 적용되는 정책을 설명합니다. 선택 사항은 DEPLOY, BUILD, RUNTIME입니다.

 

eventSource

  

StorageEventSource

 

NOT_APPLICABLE, DEPLOYMENT_EVENT, AUDIT_LOG_EVENT,

제외

  

StorageExclusion목록

이 정책에서 제외해야 하는 배포 또는 이미지를 정의합니다.

 

scope

  

StorageScope목록

이 정책에 포함되어야 하는 클러스터, 네임스페이스 및 배포를 정의합니다. 정의된 범위에는 모든 것이 포함되어 있지 않습니다.

 

심각도

  

StorageSeverity

 

UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY,

enforcementActions

  

StorageEnforcementAction목록

FAIL_DEPLOYMENT_CREATE_ENFORCEMENT는 오브젝트 생성/업데이트에 적용하도록 승인 제어 Webhook가 구성된 경우에만 적용됩니다. FAIL_KUBE_REQUEST_ENFORCEMENT는 승인 제어 Webhook가 exec 및 port-forward 이벤트를 수신 대기할 수 있는 경우에만 적용됩니다. FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT는 오브젝트 업데이트를 적용하도록 승인 제어 Webhook가 구성된 경우에만 적용됩니다. 이 정책의 위반이 식별될 때 수행할 적용 작업을 나열합니다. 가능한 값은 UNSET_ENFORCEMENT, SCALE_TO_ZERO_ENFORCEMENT, UNSATISFIABLE_NODE_CONSTRAINT_ENFORCEMENT, KILL_POD_ENFORCEMENT, FAIL_BUILD_ENFORCEMENT, FAIL_KUBE_ENFORCEMENT, FAIL_KUBE_ENFORCEMENT, FAIL_KUBE_ENFORCEMENT FAIL_DEPLOYMENT_CREATE_ENFORCEMENT, and. FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT.

 

Notifiers

  

문자열목록

이 정책의 위반이 식별될 때 트리거되어야 하는 알림자의 ID 목록입니다. ID는 UUID 형식이어야 하며 Central API를 통해 찾을 수 있습니다.

 

lastUpdated

  

날짜

 

날짜-시간

SORTName

  

문자열

내부 용도로만 사용됩니다.

 

SORTLifecycleStage

  

문자열

내부 용도로만 사용됩니다.

 

SORTEnforcement

  

부울

내부 용도로만 사용됩니다.

 

policyVersion

  

문자열

  

policySections

  

StoragePolicySection목록

PolicySections는 이 정책에 대한 위반 기준을 정의합니다.

 

mitreAttackVectors

  

PolicyMitreAttackVectors목록

  

criteriaLocked

  

부울

읽기 전용 필드입니다. true인 경우 정책의 기준 필드가 읽기 전용으로 렌더링됩니다.

 

mitreVectorsLocked

  

부울

읽기 전용 필드입니다. true인 경우 정책의 MITRE ATT&CK 필드가 읽기 전용으로 렌더링됩니다.

 

isDefault

  

부울

읽기 전용 필드입니다. true인 경우 정책이 기본 정책이고 false인 경우 사용자 지정 정책을 나타냅니다.

 

소스

  

StoragePolicySource

 

선언적, 선언적,

1.3.4.7.29. StoragePolicyGroup
필드 이름필수 항목Cryostat유형설명형식

fieldName

  

문자열

이 PolicyGroup이 평가한 배포 또는 이미지의 필드를 정의합니다. 사용 가능한 값의 전체 목록은 https://docs.openshift.com/acs/operating/manage-security-policies.html#policy-criteria_manage-security-policies 를 참조하십시오.

 

booleanOperator

  

StorageBooleanOperator

 

또는,

negate

  

부울

이 PolicyGroup의 평가가 거부되었는지 확인합니다. 기본값은 false입니다.

 

  

StoragePolicyValue목록

  
1.3.4.7.30. StoragePolicySection
필드 이름필수 항목Cryostat유형설명형식

sectionName

  

문자열

  

policyGroups

  

StoragePolicyGroup목록

이 섹션을 구성하는 정책 그룹 세트입니다. 각 그룹은 개별 기준으로 간주할 수 있습니다.

 
1.3.4.7.31. StoragePolicySource
열거 값

IMPERATIVE

DECLARATIVE

1.3.4.7.32. StoragePolicyValue
필드 이름필수 항목Cryostat유형설명형식

value

  

문자열

  
1.3.4.7.33. StorageProcessIndicator
Copy to Clipboard Toggle word wrap
Next available tag: 13
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

deploymentId

  

문자열

  

containerName

  

문자열

  

podId

  

문자열

  

podUid

  

문자열

  

신호

  

StorageProcessSignal

  

clusterId

  

문자열

  

네임스페이스

  

문자열

  

containerStartTime

  

날짜

 

날짜-시간

imageId

  

문자열

  
1.3.4.7.34. StorageProcessSignal
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

각 메시지를 자체 포함하려고 하므로 최상위 수준 대신 이 메시지를 식별하는 고유한 UUID입니다.

 

containerId

  

문자열

  

time

  

날짜

 

날짜-시간

name

  

문자열

  

args

  

문자열

  

execFilePath

  

문자열

  

pid

  

long

 

int64

uid

  

long

 

int64

gid

  

long

 

int64

lineage

  

문자열목록

  

스크랩됨

  

부울

  

lineageInfo

  

ProcessSignalLineageInfo목록

  
1.3.4.7.35. StorageScope
필드 이름필수 항목Cryostat유형설명형식

cluster

  

문자열

  

네임스페이스

  

문자열

  

label

  

StorageScopeLabel

  
1.3.4.7.36. StorageScopeLabel
필드 이름필수 항목Cryostat유형설명형식

key

  

문자열

  

value

  

문자열

  
1.3.4.7.37. StorageSeverity
열거 값

UNSET_SEVERITY

LOW_SEVERITY

MEDIUM_SEVERITY

HIGH_SEVERITY

CRITICAL_SEVERITY

1.3.4.7.38. StorageViolationState
열거 값

ACTIVE

RESOLVED

ATTEMPTED

1.3.4.7.39. ViolationKeyValueAttrs
필드 이름필수 항목Cryostat유형설명형식

attrs

  

List of KeyValueAttrsKeyValueAttr

  
1.3.4.7.40. ViolationNetworkFlowInfo
필드 이름필수 항목Cryostat유형설명형식

프로토콜

  

StorageL4Protocol

 

L4_PROTOCOL_UNKNOWN, L4_PROTOCOL_TCP, L4_PROTOCOL_UDP, L4_PROTOCOL_ICMP, L4_PROTOCOL_RAW, L4_PROTOCOL_SCTP, L4_PROTOCOL_ANY,

소스

  

NetworkFlowInfoEntity

  

대상

  

NetworkFlowInfoEntity

  

1.3.5. ResolveAlert

PATCH /v1/alerts/{id}/resolve

ResolveAlert는 지정된 경고를 (ID별) 해결된 것으로 표시합니다.

1.3.5.1. 설명
1.3.5.2. 매개 변수
1.3.5.2.1. 경로 매개변수
이름설명필수 항목기본패턴

id

 

X

null

 
1.3.5.2.2. 본문 매개변수
이름설명필수 항목기본패턴

body

AlertServiceResolveAlertBody

X

  
1.3.5.3. 반환 유형

개체

1.3.5.4. 콘텐츠 유형
  • application/json
1.3.5.5. 응답
표 1.10. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

개체

0

예기치 않은 오류 응답

GooglerpcStatus

1.3.5.6. Samples
1.3.5.7. 공통 오브젝트 참조
1.3.5.7.1. AlertServiceResolveAlertBody
필드 이름필수 항목Cryostat유형설명형식

화이트리스트

  

부울

  

addToBaseline

  

부울

  
1.3.5.7.2. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.3.5.7.3. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.3.5.7.3.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 

1.3.6. ResolveAlerts

PATCH /v1/alerts/resolve

ResolveAlertsByQuery는 검색 쿼리와 일치하는 경고를 해결된 것으로 표시합니다.

1.3.6.1. 설명
1.3.6.2. 매개 변수
1.3.6.2.1. 본문 매개변수
이름설명필수 항목기본패턴

body

V1ResolveAlertsRequest

X

  
1.3.6.3. 반환 유형

개체

1.3.6.4. 콘텐츠 유형
  • application/json
1.3.6.5. 응답
표 1.11. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

개체

0

예기치 않은 오류 응답

GooglerpcStatus

1.3.6.6. Samples
1.3.6.7. 공통 오브젝트 참조
1.3.6.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.3.6.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.3.6.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.3.6.7.3. V1ResolveAlertsRequest
필드 이름필수 항목Cryostat유형설명형식

query

  

문자열

  

1.3.7. GetAlertsCounts

GET /v1/alerts/summary/counts

GetAlertsCounts는 요청된 클러스터 또는 카테고리의 경고 수를 반환합니다.

1.3.7.1. 설명
1.3.7.2. 매개 변수
1.3.7.2.1. 쿼리 매개변수
이름설명필수 항목기본패턴

request.query

 

-

null

 

request.pagination.limit

 

-

null

 

request.pagination.offset

 

-

null

 

request.pagination.sortOption.field

 

-

null

 

request.pagination.sortOption.reversed

 

-

null

 

request.pagination.sortOption.aggregateBy.aggrFunc

 

-

설정되지 않음

 

request.pagination.sortOption.aggregateBy.distinct

 

-

null

 

groupBy

 

-

설정되지 않음

 
1.3.7.3. 반환 유형

V1GetAlertsCountsResponse

1.3.7.4. 콘텐츠 유형
  • application/json
1.3.7.5. 응답
표 1.12. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1GetAlertsCountsResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.3.7.6. Samples
1.3.7.7. 공통 오브젝트 참조
1.3.7.7.1. AlertGroupAlertCounts
필드 이름필수 항목Cryostat유형설명형식

심각도

  

StorageSeverity

 

UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY,

count

  

문자열

 

int64

1.3.7.7.2. GetAlertsCountsResponseAlertGroup
필드 이름필수 항목Cryostat유형설명형식

group

  

문자열

  

  

AlertGroupAlertCounts목록

  
1.3.7.7.3. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.3.7.7.4. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.3.7.7.4.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.3.7.7.5. StorageSeverity
열거 값

UNSET_SEVERITY

LOW_SEVERITY

MEDIUM_SEVERITY

HIGH_SEVERITY

CRITICAL_SEVERITY

1.3.7.7.6. V1GetAlertsCountsResponse
필드 이름필수 항목Cryostat유형설명형식

groups

  

List of GetAlertsCountsResponseAlertGroup

  

1.3.8. GetAlertsGroup

GET /v1/alerts/summary/groups

GetAlertsGroup은 정책별로 그룹화된 경고를 반환합니다.

1.3.8.1. 설명
1.3.8.2. 매개 변수
1.3.8.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

 
1.3.8.3. 반환 유형

V1GetAlertsGroupResponse

1.3.8.4. 콘텐츠 유형
  • application/json
1.3.8.5. 응답
표 1.13. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1GetAlertsGroupResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.3.8.6. Samples
1.3.8.7. 공통 오브젝트 참조
1.3.8.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.3.8.7.2. ListAlertPolicyDevFields
필드 이름필수 항목Cryostat유형설명형식

SORTName

  

문자열

  
1.3.8.7.3. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.3.8.7.3.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.3.8.7.4. StorageListAlertPolicy
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

심각도

  

StorageSeverity

 

UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY,

description

  

문자열

  

카테고리

  

문자열목록

  

developerInternalFields

  

ListAlertPolicyDevFields

  
1.3.8.7.5. StorageSeverity
열거 값

UNSET_SEVERITY

LOW_SEVERITY

MEDIUM_SEVERITY

HIGH_SEVERITY

CRITICAL_SEVERITY

1.3.8.7.6. V1GetAlertsGroupResponse
필드 이름필수 항목Cryostat유형설명형식

alertsByPolicies

  

List of V1GetAlertsGroupResponsePolicyGroup

  
1.3.8.7.7. V1GetAlertsGroupResponsePolicyGroup
필드 이름필수 항목Cryostat유형설명형식

policy

  

StorageListAlertPolicy

  

numAlerts

  

문자열

 

int64

1.3.9. GetAlertTimeseries

GET /v1/alerts/summary/timeseries

GetAlertTimeseries는 시간별로 정렬된 경고를 반환합니다.

1.3.9.1. 설명
1.3.9.2. 매개 변수
1.3.9.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

 
1.3.9.3. 반환 유형

V1GetAlertTimeseriesResponse

1.3.9.4. 콘텐츠 유형
  • application/json
1.3.9.5. 응답
표 1.14. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1GetAlertTimeseriesResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.3.9.6. Samples
1.3.9.7. 공통 오브젝트 참조
1.3.9.7.1. ClusterAlertsAlertEvents
필드 이름필수 항목Cryostat유형설명형식

심각도

  

StorageSeverity

 

UNSET_SEVERITY, LOW_SEVERITY, MEDIUM_SEVERITY, HIGH_SEVERITY, CRITICAL_SEVERITY,

이벤트

  

List of V1AlertEvent

  
1.3.9.7.2. GetAlertTimeseriesResponseClusterAlerts
필드 이름필수 항목Cryostat유형설명형식

cluster

  

문자열

  

심각도

  

ClusterAlertsAlertEvents목록

  
1.3.9.7.3. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.3.9.7.4. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.3.9.7.4.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.3.9.7.5. StorageSeverity
열거 값

UNSET_SEVERITY

LOW_SEVERITY

MEDIUM_SEVERITY

HIGH_SEVERITY

CRITICAL_SEVERITY

1.3.9.7.6. V1AlertEvent
필드 이름필수 항목Cryostat유형설명형식

time

  

문자열

 

int64

type

  

V1Type

 

생성됨, 제거됨,

id

  

문자열

  
1.3.9.7.7. V1GetAlertTimeseriesResponse
필드 이름필수 항목Cryostat유형설명형식

클러스터

  

List of GetAlertTimeseriesResponseClusterAlerts

  
1.3.9.7.8. V1Type
열거 값

CREATED

REMOVED

1.4. APITokenService

1.4.1. ListAllowedTokenRoles

GET /v1/apitokens/generate/allowed-roles

GetAllowedTokenRoles는 사용자가 API 토큰을 요청할 수 있는 역할을 반환합니다.

1.4.1.1. 설명
1.4.1.2. 매개 변수
1.4.1.3. 반환 유형

V1ListAllowedTokenRolesResponse

1.4.1.4. 콘텐츠 유형
  • application/json
1.4.1.5. 응답
표 1.15. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1ListAllowedTokenRolesResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.4.1.6. Samples
1.4.1.7. 공통 오브젝트 참조
1.4.1.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.4.1.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.4.1.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.4.1.7.3. V1ListAllowedTokenRolesResponse
필드 이름필수 항목Cryostat유형설명형식

roleNames

  

문자열목록

  

1.4.2. GenerateToken

POST /v1/apitokens/generate

GenerateToken은 지정된 사용자 및 역할에 대한 API 토큰을 생성합니다.

1.4.2.1. 설명
1.4.2.2. 매개 변수
1.4.2.2.1. 본문 매개변수
이름설명필수 항목기본패턴

body

V1GenerateTokenRequest

X

  
1.4.2.3. 반환 유형

V1GenerateTokenResponse

1.4.2.4. 콘텐츠 유형
  • application/json
1.4.2.5. 응답
표 1.16. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1GenerateTokenResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.4.2.6. Samples
1.4.2.7. 공통 오브젝트 참조
1.4.2.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.4.2.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.4.2.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.4.2.7.3. StorageTokenMetadata
Copy to Clipboard Toggle word wrap
Next available tag: 8
1.4.2.7.4. V1GenerateTokenRequest
필드 이름필수 항목Cryostat유형설명형식

name

  

문자열

  

role

  

문자열

  

역할

  

문자열목록

  

만료

  

날짜

 

날짜-시간

1.4.2.7.5. V1GenerateTokenResponse
필드 이름필수 항목Cryostat유형설명형식

token

  

문자열

  

메타데이터

  

StorageTokenMetadata

  

1.4.3. GetAPITokens

GET /v1/apitokens

GetAPITokens는 모든 API 토큰을 반환합니다.

1.4.3.1. 설명
1.4.3.2. 매개 변수
1.4.3.2.1. 쿼리 매개변수
이름설명필수 항목기본패턴

취소됨

 

-

null

 
1.4.3.3. 반환 유형

V1GetAPITokensResponse

1.4.3.4. 콘텐츠 유형
  • application/json
1.4.3.5. 응답
표 1.17. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1GetAPITokensResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.4.3.6. Samples
1.4.3.7. 공통 오브젝트 참조
1.4.3.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.4.3.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.4.3.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.4.3.7.3. StorageTokenMetadata
Copy to Clipboard Toggle word wrap
Next available tag: 8
1.4.3.7.4. V1GetAPITokensResponse
필드 이름필수 항목Cryostat유형설명형식

토큰

  

StorageTokenMetadata목록

  

1.4.4. GetAPIToken

GET /v1/apitokens/{id}

GetAPIToken은 지정된 ID에 대한 API 토큰 메타데이터를 반환합니다.

1.4.4.1. 설명
1.4.4.2. 매개 변수
1.4.4.2.1. 경로 매개변수
이름설명필수 항목기본패턴

id

 

X

null

 
1.4.4.3. 반환 유형

StorageTokenMetadata

1.4.4.4. 콘텐츠 유형
  • application/json
1.4.4.5. 응답
표 1.18. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

StorageTokenMetadata

0

예기치 않은 오류 응답

GooglerpcStatus

1.4.4.6. Samples
1.4.4.7. 공통 오브젝트 참조
1.4.4.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.4.4.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.4.4.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.4.4.7.3. StorageTokenMetadata
Copy to Clipboard Toggle word wrap
Next available tag: 8

1.4.5. RevokeToken

PATCH /v1/apitokens/revoke/{id}

RevokeToken은 지정된 ID의 API 토큰을 제거합니다.

1.4.5.1. 설명
1.4.5.2. 매개 변수
1.4.5.2.1. 경로 매개변수
이름설명필수 항목기본패턴

id

 

X

null

 
1.4.5.3. 반환 유형

개체

1.4.5.4. 콘텐츠 유형
  • application/json
1.4.5.5. 응답
표 1.19. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

개체

0

예기치 않은 오류 응답

GooglerpcStatus

1.4.5.6. Samples
1.4.5.7. 공통 오브젝트 참조
1.4.5.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.4.5.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.4.5.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 

1.5. AuthProviderService

1.5.1. ExchangeToken

POST /v1/authProviders/exchangeToken

1.5.1.1. 설명
1.5.1.2. 매개 변수
1.5.1.2.1. 본문 매개변수
이름설명필수 항목기본패턴

body

V1ExchangeTokenRequest

X

  
1.5.1.3. 반환 유형

V1ExchangeTokenResponse

1.5.1.4. 콘텐츠 유형
  • application/json
1.5.1.5. 응답
표 1.20. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1ExchangeTokenResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.5.1.6. Samples
1.5.1.7. 공통 오브젝트 참조
1.5.1.7.1. AuthProviderRequiredAttribute

RequiredAttribute를 사용하면 인증 공급자가 모두 반환해야 하는 속성 세트를 지정할 수 있습니다. Central에서 발행한 토큰의 외부 클레임 내에 속성이 없는 경우 이 IdP에 대한 인증 요청이 실패한 것으로 간주됩니다.

필드 이름필수 항목Cryostat유형설명형식

attributeKey

  

문자열

  

attributeValue

  

문자열

  
1.5.1.7.2. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.5.1.7.3. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.5.1.7.3.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.5.1.7.4. StorageAccess
열거 값

NO_ACCESS

READ_ACCESS

READ_WRITE_ACCESS

1.5.1.7.5. StorageAuthProvider

다음 태그: 15.

필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

type

  

문자열

  

uiEndpoint

  

문자열

  

enabled

  

부울

  

config

  

문자열

구성에는 인증 공급자 특정 구성이 있습니다. 각 구성 옵션은 지정된 auth 공급자 유형에 따라 다릅니다. OIDC: - \"issuer\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier. - \"client_id\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier에 따른 클라이언트 ID입니다. - \"client_secret\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.3.1 에 따른 클라이언트 시크릿입니다. - \"do_use_client_secret\": \"true\"로 설정합니다. https://www.rfc-editor.org/rfc/rfc6749.html#section-2.2 클라이언트 ID와 클라이언트 시크릿 없이 구성을 생성하려면 다음을 수행합니다. - \"mode\": OIDC 콜백 모드 오프라인 토큰을 발행해서는 안 되는 경우 \"fragment\", \"post\" 또는 \"query\". - \"disable_offline_access_scope\": 오프라인 토큰이 발행되지 않아야 합니다. - \"extra_scopes\": \"openid 프로필 이메일\"에 따라 요청하기 위해 공백으로 구분된 추가 범위 문자열입니다. https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 OpenShift Auth: 추가 구성 옵션 없이 지원합니다. 사용자 PKI: - \"keys\": 신뢰할 수 있는 인증서 PEM 인코딩. SAML: - \"sp_issuer\": https://datatracker.ietf.org/doc/html/rfc7522#section-3. - \"idp_metadata_url\": https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf 에 따른 메타데이터 URL입니다. - \"idp_issuer\": IdP 발행자. - \"idp_cert_pem\": IdP에 대해 인코딩한 인증서 PEM endpoint. - \"idp_sso_url\": IdP SSO URL. - \"idp_nameid_format\": IdP 이름 ID 형식입니다. IAP: - \"audience\": 사용할 대상입니다.

 

loginUrl

  

문자열

로그인 URL은 백엔드에서 제공하며 요청에 지정할 수 없습니다.

 

검증됨

  

부울

  

extraUiEndpoints

  

문자열목록

ui_endpoint 외에도 허용할 UI 끝점입니다. 즉, 로그인 요청이 이러한 요청 중 하나에서 발생하는 경우 인증 요청은 ui_endpoint가 아닌 콜백 URL에 이러한 요청을 사용합니다.

 

활성 상태

  

부울

  

requiredAttributes

  

AuthProviderRequiredAttribute목록

  

traits

  

StorageTraits

  

claimMappings

  

문자열

Rox 토큰 속성에 복사할 IdP 토큰의 클레임을 지정합니다. 이 맵의 각 키에는 매핑하려는 IdP 토큰의 경로가 포함되어 있습니다. 경로는 \".\" 기호로 구분됩니다. 예를 들어 IdP 토큰 페이로드가 다음과 같은 경우 { \"a\": { \"b\" : \"c\", \"d\": true, \"e\", \"val2\", \"val3\" ], \"val3\" ], \"f\": [ true, false, false ], \"G\": 123.0, \"h\": [ 1, 2, 3] } } then \"a.b\"는 유효한 키가 되고 \"a.z\"는 유효하지 않습니다. 다음과 같은 유형의 클레임을 지원합니다. * string(path \"a.") * bool(path \"a.d\") * string array(path \"a.e\") * bool 배열(path \"a.f.\") 당사는 다음과 같은 유형의 클레임을 지원하지 않습니다. * 복잡한 클레임(path \"a\") * float/integer claims(path \"a.g\") * float/integer array claims(path \"a.h\") 이 맵의 각 값에는 클레임을 추가하려는 Rox 토큰 특성 이름이 포함되어 있습니다. 예를 들어 value가 \"groups\"인 경우 클레임은 토큰의 \"external_user.Attributes.groups\"에 있습니다. 참고: 이 기능은 OIDC 인증 공급자에 대해서만 지원합니다.

 

lastUpdated

  

날짜

마지막 업데이트됨은 인증 공급자가 마지막으로 업데이트된 시간을 나타냅니다. 이 타임스탬프 전에 인증 공급자가 발행한 토큰이 있는 경우 유효하지 않은 것으로 간주됩니다. 결과적으로 모든 클라이언트는 토큰을 다시 발행해야 합니다(새로 고침 또는 추가 로그인 시도를 통해).

날짜-시간

1.5.1.7.6. StorageServiceIdentity
필드 이름필수 항목Cryostat유형설명형식

serialStr

  

문자열

  

직렬

  

문자열

 

int64

id

  

문자열

  

type

  

StorageServiceType

 

UNKNOWN_SERVICE, SENSOR_SERVICE, CENTRAL_SERVICE, CENTRAL_DB_SERVICE, REMOTE_SERVICE, MONITORING_UI_SERVICE, MONITORING_DB_SERVICE, MONITORING_CLIENT_SERVICE, BENCHMARK_SERVICE, SCANNER_SERVICE, SCANNER_DB_SERVICE, ADMISSION_CONTROL_SERVICE, SCANNER_V4_INDEXER_SERVICE, SCANNER_V4_MATCHER_SERVICE, SCANNER_V4_SERVICE, SCANNER_V4_SERVICE, SCANNER_V4_SERVICE, SCANNER_V4_SERVICE, REGISTRANT_SERVICE

initBundleId

  

문자열

  
1.5.1.7.7. StorageServiceType
Copy to Clipboard Toggle word wrap
Next available tag: 18
  • SCANNER_V4_SERVICE: 스캐너 V4가 콤보 모드로 실행될 때 사용됩니다.
열거 값

UNKNOWN_SERVICE

SENSOR_SERVICE

CENTRAL_SERVICE

CENTRAL_DB_SERVICE

REMOTE_SERVICE

COLLECTOR_SERVICE

MONITORING_UI_SERVICE

MONITORING_DB_SERVICE

MONITORING_CLIENT_SERVICE

BENCHMARK_SERVICE

SCANNER_SERVICE

SCANNER_DB_SERVICE

ADMISSION_CONTROL_SERVICE

SCANNER_V4_INDEXER_SERVICE

SCANNER_V4_MATCHER_SERVICE

SCANNER_V4_DB_SERVICE

SCANNER_V4_SERVICE

REGISTRANT_SERVICE

1.5.1.7.8. StorageTraits
필드 이름필수 항목Cryostat유형설명형식

mutabilityMode

  

TraitsMutabilityMode

 

ALLOW_MUTATE, ALLOW_MUTATE_FORCED,

가시성

  

traditionalitsVisibility

 

표시, 숨겨진,

origin

  

traditional presentationsOrigin

 

IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED,

1.5.1.7.9. StorageUserInfo
필드 이름필수 항목Cryostat유형설명형식

사용자 이름

  

문자열

  

FriendlyName

  

문자열

  

권한

  

UserInfoResourceToAccess

  

역할

  

StorageUserInfoRole목록

  
1.5.1.7.10. StorageUserInfoRole

역할은 이전 형식의 storage.Role과 호환되므로 역할 이름 및 관련 권한만 포함됩니다.

필드 이름필수 항목Cryostat유형설명형식

name

  

문자열

  

resourceToAccess

  

StorageAccess

  
1.5.1.7.11. TraitsMutabilityMode

실험적. 참고: 시간이 지남에 따라 MutabilityMode 사용을 참조하십시오. 이는 향후 대체될 예정입니다(ROX-14276). MutabilityMode는 오브젝트를 수정할 수 있는지 여부와 방법을 지정합니다. 기본값은 ALLOW_MUTATE이며 수정 제한이 없음을 의미합니다. 이는 MutabilityMode 사양이 없는 것과 동일합니다. ALLOW_MUTATE_FORCED는 강제로 강제로 제거하는 것을 제외한 모든 수정 작업을 금지합니다.

이 필드의 상태를 변경할 때는 주의하십시오. 예를 들어 ALLOW_MUTATE에서 ALLOW_MUTATE_FORCED로 오브젝트를 수정할 수 있지만 ALLOW_MUTATE로 다시 수정하는 등 추가 변경 사항이 금지됩니다.

열거 값

ALLOW_MUTATE

ALLOW_MUTATE_FORCED

1.5.1.7.12. traditional presentationsOrigin

origin은 개체의 원본을 지정합니다. 오브젝트에는 4개의 서로 다른 원본이 있을 수 있습니다. - IMPERATIVE: 오브젝트는 API를 통해 생성되었습니다. 이는 기본적으로 가정됩니다. - DEFAULT: 오브젝트는 기본 역할, 액세스 범위 등과 같은 기본 오브젝트입니다. - DECLARATIVE: 오브젝트는 선언적 구성을 통해 생성됩니다. - DECLARATIVE_ORPHANED: 오브젝트는 선언적 구성을 통해 생성된 다음(예: 다른 오브젝트에서 참조하기 때문에) 실패로 삭제(예: 대상자 규칙)에 따라 다른 규칙을 적용합니다. DECLARATIVE 원본이 있는 오브젝트는 선언적 구성을 통해서만 API를 통해 수정할 수 없습니다. 또한 IMPERATIVE 원본과 함께 오브젝트를 참조할 수 없습니다. DEFAULT 원본이 있는 오브젝트는 API 또는 선언적 구성을 통해 수정할 수 없습니다. 다른 모든 오브젝트에서 참조할 수 있습니다. IMPERATIVE 원본이 있는 오브젝트는 선언적 구성이 아닌 API를 통해 수정할 수 있습니다. 다른 모든 개체를 참조할 수 있습니다. DECLARATIVE_ORPHANED 원본이 있는 오브젝트는 API 또는 선언적 구성을 통해 수정할 수 없습니다. DECLARATIVE_ORPHANED 리소스는 선언적 구성으로 다시 정의되면 DECLARATIVE 리소스가 될 수 있습니다. 이 원본이 있는 오브젝트는 더 이상 다른 리소스에서 참조하지 않은 직후 시스템에서 정리됩니다. 다른 모든 오브젝트에서 참조할 수 있습니다.

열거 값

IMPERATIVE

DEFAULT

DECLARATIVE

DECLARATIVE_ORPHANED

1.5.1.7.13. traditionalitsVisibility

EXPERIMENTAL. visibility를 사용하면 특정 API에 개체를 볼 수 있는지 여부를 지정할 수 있습니다.

열거 값

VISIBLE

HIDDEN

1.5.1.7.14. UserInfoResourceToAccess

ResourceToAccess는 권한 컬렉션을 나타냅니다. 이전 형식의 storage.Role과 호환되며 집계된 권한만 필요한 위치에서 교체합니다.

필드 이름필수 항목Cryostat유형설명형식

resourceToAccess

  

StorageAccess

  
1.5.1.7.15. V1AuthStatus
필드 이름필수 항목Cryostat유형설명형식

userId

  

문자열

  

serviceId

  

StorageServiceIdentity

  

만료

  

날짜

 

날짜-시간

refreshUrl

  

문자열

  

authProvider

  

StorageAuthProvider

  

userInfo

  

StorageUserInfo

  

userAttributes

  

V1UserAttribute목록

  

idpToken

  

문자열

기본 ID 공급자에 의해 ACS로 반환되는 토큰입니다. 이 필드는 몇 가지 특정 컨텍스트에서만 설정됩니다. 응답에 있는 이 필드에 의존하지 마십시오.

 
1.5.1.7.16. V1ExchangeTokenRequest
필드 이름필수 항목Cryostat유형설명형식

externalToken

  

문자열

외부 인증 토큰입니다. 서버는 응답 및 로그에서 이 인증 정보의 값을 마스킹합니다.

 

type

  

문자열

  

상태

  

문자열

  
1.5.1.7.17. V1ExchangeTokenResponse
필드 이름필수 항목Cryostat유형설명형식

token

  

문자열

  

clientState

  

문자열

  

test

  

부울

  

user

  

V1AuthStatus

  
1.5.1.7.18. V1UserAttribute
필드 이름필수 항목Cryostat유형설명형식

key

  

문자열

  

  

문자열목록

  

1.5.2. GetAuthProviders

GET /v1/authProviders

1.5.2.1. 설명
1.5.2.2. 매개 변수
1.5.2.2.1. 쿼리 매개변수
이름설명필수 항목기본패턴

name

 

-

null

 

type

 

-

null

 
1.5.2.3. 반환 유형

V1GetAuthProvidersResponse

1.5.2.4. 콘텐츠 유형
  • application/json
1.5.2.5. 응답
표 1.21. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1GetAuthProvidersResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.5.2.6. Samples
1.5.2.7. 공통 오브젝트 참조
1.5.2.7.1. AuthProviderRequiredAttribute

RequiredAttribute를 사용하면 인증 공급자가 모두 반환해야 하는 속성 세트를 지정할 수 있습니다. Central에서 발행한 토큰의 외부 클레임 내에 속성이 없는 경우 이 IdP에 대한 인증 요청이 실패한 것으로 간주됩니다.

필드 이름필수 항목Cryostat유형설명형식

attributeKey

  

문자열

  

attributeValue

  

문자열

  
1.5.2.7.2. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.5.2.7.3. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.5.2.7.3.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.5.2.7.4. StorageAuthProvider

다음 태그: 15.

필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

type

  

문자열

  

uiEndpoint

  

문자열

  

enabled

  

부울

  

config

  

문자열

구성에는 인증 공급자 특정 구성이 있습니다. 각 구성 옵션은 지정된 auth 공급자 유형에 따라 다릅니다. OIDC: - \"issuer\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier. - \"client_id\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier에 따른 클라이언트 ID입니다. - \"client_secret\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.3.1 에 따른 클라이언트 시크릿입니다. - \"do_use_client_secret\": \"true\"로 설정합니다. https://www.rfc-editor.org/rfc/rfc6749.html#section-2.2 클라이언트 ID와 클라이언트 시크릿 없이 구성을 생성하려면 다음을 수행합니다. - \"mode\": OIDC 콜백 모드 오프라인 토큰을 발행해서는 안 되는 경우 \"fragment\", \"post\" 또는 \"query\". - \"disable_offline_access_scope\": 오프라인 토큰이 발행되지 않아야 합니다. - \"extra_scopes\": \"openid 프로필 이메일\"에 따라 요청하기 위해 공백으로 구분된 추가 범위 문자열입니다. https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 OpenShift Auth: 추가 구성 옵션 없이 지원합니다. 사용자 PKI: - \"keys\": 신뢰할 수 있는 인증서 PEM 인코딩. SAML: - \"sp_issuer\": https://datatracker.ietf.org/doc/html/rfc7522#section-3. - \"idp_metadata_url\": https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf 에 따른 메타데이터 URL입니다. - \"idp_issuer\": IdP 발행자. - \"idp_cert_pem\": IdP에 대해 인코딩한 인증서 PEM endpoint. - \"idp_sso_url\": IdP SSO URL. - \"idp_nameid_format\": IdP 이름 ID 형식입니다. IAP: - \"audience\": 사용할 대상입니다.

 

loginUrl

  

문자열

로그인 URL은 백엔드에서 제공하며 요청에 지정할 수 없습니다.

 

검증됨

  

부울

  

extraUiEndpoints

  

문자열목록

ui_endpoint 외에도 허용할 UI 끝점입니다. 즉, 로그인 요청이 이러한 요청 중 하나에서 발생하는 경우 인증 요청은 ui_endpoint가 아닌 콜백 URL에 이러한 요청을 사용합니다.

 

활성 상태

  

부울

  

requiredAttributes

  

AuthProviderRequiredAttribute목록

  

traits

  

StorageTraits

  

claimMappings

  

문자열

Rox 토큰 속성에 복사할 IdP 토큰의 클레임을 지정합니다. 이 맵의 각 키에는 매핑하려는 IdP 토큰의 경로가 포함되어 있습니다. 경로는 \".\" 기호로 구분됩니다. 예를 들어 IdP 토큰 페이로드가 다음과 같은 경우 { \"a\": { \"b\" : \"c\", \"d\": true, \"e\", \"val2\", \"val3\" ], \"val3\" ], \"f\": [ true, false, false ], \"G\": 123.0, \"h\": [ 1, 2, 3] } } then \"a.b\"는 유효한 키가 되고 \"a.z\"는 유효하지 않습니다. 다음과 같은 유형의 클레임을 지원합니다. * string(path \"a.") * bool(path \"a.d\") * string array(path \"a.e\") * bool 배열(path \"a.f.\") 당사는 다음과 같은 유형의 클레임을 지원하지 않습니다. * 복잡한 클레임(path \"a\") * float/integer claims(path \"a.g\") * float/integer array claims(path \"a.h\") 이 맵의 각 값에는 클레임을 추가하려는 Rox 토큰 특성 이름이 포함되어 있습니다. 예를 들어 value가 \"groups\"인 경우 클레임은 토큰의 \"external_user.Attributes.groups\"에 있습니다. 참고: 이 기능은 OIDC 인증 공급자에 대해서만 지원합니다.

 

lastUpdated

  

날짜

마지막 업데이트됨은 인증 공급자가 마지막으로 업데이트된 시간을 나타냅니다. 이 타임스탬프 전에 인증 공급자가 발행한 토큰이 있는 경우 유효하지 않은 것으로 간주됩니다. 결과적으로 모든 클라이언트는 토큰을 다시 발행해야 합니다(새로 고침 또는 추가 로그인 시도를 통해).

날짜-시간

1.5.2.7.5. StorageTraits
필드 이름필수 항목Cryostat유형설명형식

mutabilityMode

  

TraitsMutabilityMode

 

ALLOW_MUTATE, ALLOW_MUTATE_FORCED,

가시성

  

traditionalitsVisibility

 

표시, 숨겨진,

origin

  

traditional presentationsOrigin

 

IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED,

1.5.2.7.6. TraitsMutabilityMode

실험적. 참고: 시간이 지남에 따라 MutabilityMode 사용을 참조하십시오. 이는 향후 대체될 예정입니다(ROX-14276). MutabilityMode는 오브젝트를 수정할 수 있는지 여부와 방법을 지정합니다. 기본값은 ALLOW_MUTATE이며 수정 제한이 없음을 의미합니다. 이는 MutabilityMode 사양이 없는 것과 동일합니다. ALLOW_MUTATE_FORCED는 강제로 강제로 제거하는 것을 제외한 모든 수정 작업을 금지합니다.

이 필드의 상태를 변경할 때는 주의하십시오. 예를 들어 ALLOW_MUTATE에서 ALLOW_MUTATE_FORCED로 오브젝트를 수정할 수 있지만 ALLOW_MUTATE로 다시 수정하는 등 추가 변경 사항이 금지됩니다.

열거 값

ALLOW_MUTATE

ALLOW_MUTATE_FORCED

1.5.2.7.7. traditional presentationsOrigin

origin은 개체의 원본을 지정합니다. 오브젝트에는 4개의 서로 다른 원본이 있을 수 있습니다. - IMPERATIVE: 오브젝트는 API를 통해 생성되었습니다. 이는 기본적으로 가정됩니다. - DEFAULT: 오브젝트는 기본 역할, 액세스 범위 등과 같은 기본 오브젝트입니다. - DECLARATIVE: 오브젝트는 선언적 구성을 통해 생성됩니다. - DECLARATIVE_ORPHANED: 오브젝트는 선언적 구성을 통해 생성된 다음(예: 다른 오브젝트에서 참조하기 때문에) 실패로 삭제(예: 대상자 규칙)에 따라 다른 규칙을 적용합니다. DECLARATIVE 원본이 있는 오브젝트는 선언적 구성을 통해서만 API를 통해 수정할 수 없습니다. 또한 IMPERATIVE 원본과 함께 오브젝트를 참조할 수 없습니다. DEFAULT 원본이 있는 오브젝트는 API 또는 선언적 구성을 통해 수정할 수 없습니다. 다른 모든 오브젝트에서 참조할 수 있습니다. IMPERATIVE 원본이 있는 오브젝트는 선언적 구성이 아닌 API를 통해 수정할 수 있습니다. 다른 모든 개체를 참조할 수 있습니다. DECLARATIVE_ORPHANED 원본이 있는 오브젝트는 API 또는 선언적 구성을 통해 수정할 수 없습니다. DECLARATIVE_ORPHANED 리소스는 선언적 구성으로 다시 정의되면 DECLARATIVE 리소스가 될 수 있습니다. 이 원본이 있는 오브젝트는 더 이상 다른 리소스에서 참조하지 않은 직후 시스템에서 정리됩니다. 다른 모든 오브젝트에서 참조할 수 있습니다.

열거 값

IMPERATIVE

DEFAULT

DECLARATIVE

DECLARATIVE_ORPHANED

1.5.2.7.8. traditionalitsVisibility

EXPERIMENTAL. visibility를 사용하면 특정 API에 개체를 볼 수 있는지 여부를 지정할 수 있습니다.

열거 값

VISIBLE

HIDDEN

1.5.2.7.9. V1GetAuthProvidersResponse
필드 이름필수 항목Cryostat유형설명형식

authProviders

  

StorageAuthProvider목록

  

1.5.3. DeleteAuthProvider

DELETE /v1/authProviders/{id}

1.5.3.1. 설명
1.5.3.2. 매개 변수
1.5.3.2.1. 경로 매개변수
이름설명필수 항목기본패턴

id

 

X

null

 
1.5.3.2.2. 쿼리 매개변수
이름설명필수 항목기본패턴

force

 

-

null

 
1.5.3.3. 반환 유형

개체

1.5.3.4. 콘텐츠 유형
  • application/json
1.5.3.5. 응답
표 1.22. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

개체

0

예기치 않은 오류 응답

GooglerpcStatus

1.5.3.6. Samples
1.5.3.7. 공통 오브젝트 참조
1.5.3.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.5.3.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.5.3.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 

1.5.4. GetAuthProvider

GET /v1/authProviders/{id}

1.5.4.1. 설명
1.5.4.2. 매개 변수
1.5.4.2.1. 경로 매개변수
이름설명필수 항목기본패턴

id

 

X

null

 
1.5.4.3. 반환 유형

StorageAuthProvider

1.5.4.4. 콘텐츠 유형
  • application/json
1.5.4.5. 응답
표 1.23. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

StorageAuthProvider

0

예기치 않은 오류 응답

GooglerpcStatus

1.5.4.6. Samples
1.5.4.7. 공통 오브젝트 참조
1.5.4.7.1. AuthProviderRequiredAttribute

RequiredAttribute를 사용하면 인증 공급자가 모두 반환해야 하는 속성 세트를 지정할 수 있습니다. Central에서 발행한 토큰의 외부 클레임 내에 속성이 없는 경우 이 IdP에 대한 인증 요청이 실패한 것으로 간주됩니다.

필드 이름필수 항목Cryostat유형설명형식

attributeKey

  

문자열

  

attributeValue

  

문자열

  
1.5.4.7.2. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.5.4.7.3. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.5.4.7.3.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.5.4.7.4. StorageAuthProvider

다음 태그: 15.

필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

type

  

문자열

  

uiEndpoint

  

문자열

  

enabled

  

부울

  

config

  

문자열

구성에는 인증 공급자 특정 구성이 있습니다. 각 구성 옵션은 지정된 auth 공급자 유형에 따라 다릅니다. OIDC: - \"issuer\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier. - \"client_id\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier에 따른 클라이언트 ID입니다. - \"client_secret\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.3.1 에 따른 클라이언트 시크릿입니다. - \"do_use_client_secret\": \"true\"로 설정합니다. https://www.rfc-editor.org/rfc/rfc6749.html#section-2.2 클라이언트 ID와 클라이언트 시크릿 없이 구성을 생성하려면 다음을 수행합니다. - \"mode\": OIDC 콜백 모드 오프라인 토큰을 발행해서는 안 되는 경우 \"fragment\", \"post\" 또는 \"query\". - \"disable_offline_access_scope\": 오프라인 토큰이 발행되지 않아야 합니다. - \"extra_scopes\": \"openid 프로필 이메일\"에 따라 요청하기 위해 공백으로 구분된 추가 범위 문자열입니다. https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 OpenShift Auth: 추가 구성 옵션 없이 지원합니다. 사용자 PKI: - \"keys\": 신뢰할 수 있는 인증서 PEM 인코딩. SAML: - \"sp_issuer\": https://datatracker.ietf.org/doc/html/rfc7522#section-3. - \"idp_metadata_url\": https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf 에 따른 메타데이터 URL입니다. - \"idp_issuer\": IdP 발행자. - \"idp_cert_pem\": IdP에 대해 인코딩한 인증서 PEM endpoint. - \"idp_sso_url\": IdP SSO URL. - \"idp_nameid_format\": IdP 이름 ID 형식입니다. IAP: - \"audience\": 사용할 대상입니다.

 

loginUrl

  

문자열

로그인 URL은 백엔드에서 제공하며 요청에 지정할 수 없습니다.

 

검증됨

  

부울

  

extraUiEndpoints

  

문자열목록

ui_endpoint 외에도 허용할 UI 끝점입니다. 즉, 로그인 요청이 이러한 요청 중 하나에서 발생하는 경우 인증 요청은 ui_endpoint가 아닌 콜백 URL에 이러한 요청을 사용합니다.

 

활성 상태

  

부울

  

requiredAttributes

  

AuthProviderRequiredAttribute목록

  

traits

  

StorageTraits

  

claimMappings

  

문자열

Rox 토큰 속성에 복사할 IdP 토큰의 클레임을 지정합니다. 이 맵의 각 키에는 매핑하려는 IdP 토큰의 경로가 포함되어 있습니다. 경로는 \".\" 기호로 구분됩니다. 예를 들어 IdP 토큰 페이로드가 다음과 같은 경우 { \"a\": { \"b\" : \"c\", \"d\": true, \"e\", \"val2\", \"val3\" ], \"val3\" ], \"f\": [ true, false, false ], \"G\": 123.0, \"h\": [ 1, 2, 3] } } then \"a.b\"는 유효한 키가 되고 \"a.z\"는 유효하지 않습니다. 다음과 같은 유형의 클레임을 지원합니다. * string(path \"a.") * bool(path \"a.d\") * string array(path \"a.e\") * bool 배열(path \"a.f.\") 당사는 다음과 같은 유형의 클레임을 지원하지 않습니다. * 복잡한 클레임(path \"a\") * float/integer claims(path \"a.g\") * float/integer array claims(path \"a.h\") 이 맵의 각 값에는 클레임을 추가하려는 Rox 토큰 특성 이름이 포함되어 있습니다. 예를 들어 value가 \"groups\"인 경우 클레임은 토큰의 \"external_user.Attributes.groups\"에 있습니다. 참고: 이 기능은 OIDC 인증 공급자에 대해서만 지원합니다.

 

lastUpdated

  

날짜

마지막 업데이트됨은 인증 공급자가 마지막으로 업데이트된 시간을 나타냅니다. 이 타임스탬프 전에 인증 공급자가 발행한 토큰이 있는 경우 유효하지 않은 것으로 간주됩니다. 결과적으로 모든 클라이언트는 토큰을 다시 발행해야 합니다(새로 고침 또는 추가 로그인 시도를 통해).

날짜-시간

1.5.4.7.5. StorageTraits
필드 이름필수 항목Cryostat유형설명형식

mutabilityMode

  

TraitsMutabilityMode

 

ALLOW_MUTATE, ALLOW_MUTATE_FORCED,

가시성

  

traditionalitsVisibility

 

표시, 숨겨진,

origin

  

traditional presentationsOrigin

 

IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED,

1.5.4.7.6. TraitsMutabilityMode

실험적. 참고: 시간이 지남에 따라 MutabilityMode 사용을 참조하십시오. 이는 향후 대체될 예정입니다(ROX-14276). MutabilityMode는 오브젝트를 수정할 수 있는지 여부와 방법을 지정합니다. 기본값은 ALLOW_MUTATE이며 수정 제한이 없음을 의미합니다. 이는 MutabilityMode 사양이 없는 것과 동일합니다. ALLOW_MUTATE_FORCED는 강제로 강제로 제거하는 것을 제외한 모든 수정 작업을 금지합니다.

이 필드의 상태를 변경할 때는 주의하십시오. 예를 들어 ALLOW_MUTATE에서 ALLOW_MUTATE_FORCED로 오브젝트를 수정할 수 있지만 ALLOW_MUTATE로 다시 수정하는 등 추가 변경 사항이 금지됩니다.

열거 값

ALLOW_MUTATE

ALLOW_MUTATE_FORCED

1.5.4.7.7. traditional presentationsOrigin

origin은 개체의 원본을 지정합니다. 오브젝트에는 4개의 서로 다른 원본이 있을 수 있습니다. - IMPERATIVE: 오브젝트는 API를 통해 생성되었습니다. 이는 기본적으로 가정됩니다. - DEFAULT: 오브젝트는 기본 역할, 액세스 범위 등과 같은 기본 오브젝트입니다. - DECLARATIVE: 오브젝트는 선언적 구성을 통해 생성됩니다. - DECLARATIVE_ORPHANED: 오브젝트는 선언적 구성을 통해 생성된 다음(예: 다른 오브젝트에서 참조하기 때문에) 실패로 삭제(예: 대상자 규칙)에 따라 다른 규칙을 적용합니다. DECLARATIVE 원본이 있는 오브젝트는 선언적 구성을 통해서만 API를 통해 수정할 수 없습니다. 또한 IMPERATIVE 원본과 함께 오브젝트를 참조할 수 없습니다. DEFAULT 원본이 있는 오브젝트는 API 또는 선언적 구성을 통해 수정할 수 없습니다. 다른 모든 오브젝트에서 참조할 수 있습니다. IMPERATIVE 원본이 있는 오브젝트는 선언적 구성이 아닌 API를 통해 수정할 수 있습니다. 다른 모든 개체를 참조할 수 있습니다. DECLARATIVE_ORPHANED 원본이 있는 오브젝트는 API 또는 선언적 구성을 통해 수정할 수 없습니다. DECLARATIVE_ORPHANED 리소스는 선언적 구성으로 다시 정의되면 DECLARATIVE 리소스가 될 수 있습니다. 이 원본이 있는 오브젝트는 더 이상 다른 리소스에서 참조하지 않은 직후 시스템에서 정리됩니다. 다른 모든 오브젝트에서 참조할 수 있습니다.

열거 값

IMPERATIVE

DEFAULT

DECLARATIVE

DECLARATIVE_ORPHANED

1.5.4.7.8. traditionalitsVisibility

EXPERIMENTAL. visibility를 사용하면 특정 API에 개체를 볼 수 있는지 여부를 지정할 수 있습니다.

열거 값

VISIBLE

HIDDEN

1.5.5. UpdateAuthProvider

PATCH /v1/authProviders/{id}

1.5.5.1. 설명
1.5.5.2. 매개 변수
1.5.5.2.1. 경로 매개변수
이름설명필수 항목기본패턴

id

 

X

null

 
1.5.5.2.2. 본문 매개변수
이름설명필수 항목기본패턴

body

AuthProviderServiceUpdateAuthProviderBody

X

  
1.5.5.3. 반환 유형

StorageAuthProvider

1.5.5.4. 콘텐츠 유형
  • application/json
1.5.5.5. 응답
표 1.24. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

StorageAuthProvider

0

예기치 않은 오류 응답

GooglerpcStatus

1.5.5.6. Samples
1.5.5.7. 공통 오브젝트 참조
1.5.5.7.1. AuthProviderRequiredAttribute

RequiredAttribute를 사용하면 인증 공급자가 모두 반환해야 하는 속성 세트를 지정할 수 있습니다. Central에서 발행한 토큰의 외부 클레임 내에 속성이 없는 경우 이 IdP에 대한 인증 요청이 실패한 것으로 간주됩니다.

필드 이름필수 항목Cryostat유형설명형식

attributeKey

  

문자열

  

attributeValue

  

문자열

  
1.5.5.7.2. AuthProviderServiceUpdateAuthProviderBody
필드 이름필수 항목Cryostat유형설명형식

name

  

문자열

  

enabled

  

부울

  
1.5.5.7.3. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.5.5.7.4. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.5.5.7.4.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.5.5.7.5. StorageAuthProvider

다음 태그: 15.

필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

type

  

문자열

  

uiEndpoint

  

문자열

  

enabled

  

부울

  

config

  

문자열

구성에는 인증 공급자 특정 구성이 있습니다. 각 구성 옵션은 지정된 auth 공급자 유형에 따라 다릅니다. OIDC: - \"issuer\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier. - \"client_id\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier에 따른 클라이언트 ID입니다. - \"client_secret\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.3.1 에 따른 클라이언트 시크릿입니다. - \"do_use_client_secret\": \"true\"로 설정합니다. https://www.rfc-editor.org/rfc/rfc6749.html#section-2.2 클라이언트 ID와 클라이언트 시크릿 없이 구성을 생성하려면 다음을 수행합니다. - \"mode\": OIDC 콜백 모드 오프라인 토큰을 발행해서는 안 되는 경우 \"fragment\", \"post\" 또는 \"query\". - \"disable_offline_access_scope\": 오프라인 토큰이 발행되지 않아야 합니다. - \"extra_scopes\": \"openid 프로필 이메일\"에 따라 요청하기 위해 공백으로 구분된 추가 범위 문자열입니다. https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 OpenShift Auth: 추가 구성 옵션 없이 지원합니다. 사용자 PKI: - \"keys\": 신뢰할 수 있는 인증서 PEM 인코딩. SAML: - \"sp_issuer\": https://datatracker.ietf.org/doc/html/rfc7522#section-3. - \"idp_metadata_url\": https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf 에 따른 메타데이터 URL입니다. - \"idp_issuer\": IdP 발행자. - \"idp_cert_pem\": IdP에 대해 인코딩한 인증서 PEM endpoint. - \"idp_sso_url\": IdP SSO URL. - \"idp_nameid_format\": IdP 이름 ID 형식입니다. IAP: - \"audience\": 사용할 대상입니다.

 

loginUrl

  

문자열

로그인 URL은 백엔드에서 제공하며 요청에 지정할 수 없습니다.

 

검증됨

  

부울

  

extraUiEndpoints

  

문자열목록

ui_endpoint 외에도 허용할 UI 끝점입니다. 즉, 로그인 요청이 이러한 요청 중 하나에서 발생하는 경우 인증 요청은 ui_endpoint가 아닌 콜백 URL에 이러한 요청을 사용합니다.

 

활성 상태

  

부울

  

requiredAttributes

  

AuthProviderRequiredAttribute목록

  

traits

  

StorageTraits

  

claimMappings

  

문자열

Rox 토큰 속성에 복사할 IdP 토큰의 클레임을 지정합니다. 이 맵의 각 키에는 매핑하려는 IdP 토큰의 경로가 포함되어 있습니다. 경로는 \".\" 기호로 구분됩니다. 예를 들어 IdP 토큰 페이로드가 다음과 같은 경우 { \"a\": { \"b\" : \"c\", \"d\": true, \"e\", \"val2\", \"val3\" ], \"val3\" ], \"f\": [ true, false, false ], \"G\": 123.0, \"h\": [ 1, 2, 3] } } then \"a.b\"는 유효한 키가 되고 \"a.z\"는 유효하지 않습니다. 다음과 같은 유형의 클레임을 지원합니다. * string(path \"a.") * bool(path \"a.d\") * string array(path \"a.e\") * bool 배열(path \"a.f.\") 당사는 다음과 같은 유형의 클레임을 지원하지 않습니다. * 복잡한 클레임(path \"a\") * float/integer claims(path \"a.g\") * float/integer array claims(path \"a.h\") 이 맵의 각 값에는 클레임을 추가하려는 Rox 토큰 특성 이름이 포함되어 있습니다. 예를 들어 value가 \"groups\"인 경우 클레임은 토큰의 \"external_user.Attributes.groups\"에 있습니다. 참고: 이 기능은 OIDC 인증 공급자에 대해서만 지원합니다.

 

lastUpdated

  

날짜

마지막 업데이트됨은 인증 공급자가 마지막으로 업데이트된 시간을 나타냅니다. 이 타임스탬프 전에 인증 공급자가 발행한 토큰이 있는 경우 유효하지 않은 것으로 간주됩니다. 결과적으로 모든 클라이언트는 토큰을 다시 발행해야 합니다(새로 고침 또는 추가 로그인 시도를 통해).

날짜-시간

1.5.5.7.6. StorageTraits
필드 이름필수 항목Cryostat유형설명형식

mutabilityMode

  

TraitsMutabilityMode

 

ALLOW_MUTATE, ALLOW_MUTATE_FORCED,

가시성

  

traditionalitsVisibility

 

표시, 숨겨진,

origin

  

traditional presentationsOrigin

 

IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED,

1.5.5.7.7. TraitsMutabilityMode

실험적. 참고: 시간이 지남에 따라 MutabilityMode 사용을 참조하십시오. 이는 향후 대체될 예정입니다(ROX-14276). MutabilityMode는 오브젝트를 수정할 수 있는지 여부와 방법을 지정합니다. 기본값은 ALLOW_MUTATE이며 수정 제한이 없음을 의미합니다. 이는 MutabilityMode 사양이 없는 것과 동일합니다. ALLOW_MUTATE_FORCED는 강제로 강제로 제거하는 것을 제외한 모든 수정 작업을 금지합니다.

이 필드의 상태를 변경할 때는 주의하십시오. 예를 들어 ALLOW_MUTATE에서 ALLOW_MUTATE_FORCED로 오브젝트를 수정할 수 있지만 ALLOW_MUTATE로 다시 수정하는 등 추가 변경 사항이 금지됩니다.

열거 값

ALLOW_MUTATE

ALLOW_MUTATE_FORCED

1.5.5.7.8. traditional presentationsOrigin

origin은 개체의 원본을 지정합니다. 오브젝트에는 4개의 서로 다른 원본이 있을 수 있습니다. - IMPERATIVE: 오브젝트는 API를 통해 생성되었습니다. 이는 기본적으로 가정됩니다. - DEFAULT: 오브젝트는 기본 역할, 액세스 범위 등과 같은 기본 오브젝트입니다. - DECLARATIVE: 오브젝트는 선언적 구성을 통해 생성됩니다. - DECLARATIVE_ORPHANED: 오브젝트는 선언적 구성을 통해 생성된 다음(예: 다른 오브젝트에서 참조하기 때문에) 실패로 삭제(예: 대상자 규칙)에 따라 다른 규칙을 적용합니다. DECLARATIVE 원본이 있는 오브젝트는 선언적 구성을 통해서만 API를 통해 수정할 수 없습니다. 또한 IMPERATIVE 원본과 함께 오브젝트를 참조할 수 없습니다. DEFAULT 원본이 있는 오브젝트는 API 또는 선언적 구성을 통해 수정할 수 없습니다. 다른 모든 오브젝트에서 참조할 수 있습니다. IMPERATIVE 원본이 있는 오브젝트는 선언적 구성이 아닌 API를 통해 수정할 수 있습니다. 다른 모든 개체를 참조할 수 있습니다. DECLARATIVE_ORPHANED 원본이 있는 오브젝트는 API 또는 선언적 구성을 통해 수정할 수 없습니다. DECLARATIVE_ORPHANED 리소스는 선언적 구성으로 다시 정의되면 DECLARATIVE 리소스가 될 수 있습니다. 이 원본이 있는 오브젝트는 더 이상 다른 리소스에서 참조하지 않은 직후 시스템에서 정리됩니다. 다른 모든 오브젝트에서 참조할 수 있습니다.

열거 값

IMPERATIVE

DEFAULT

DECLARATIVE

DECLARATIVE_ORPHANED

1.5.5.7.9. traditionalitsVisibility

EXPERIMENTAL. visibility를 사용하면 특정 API에 개체를 볼 수 있는지 여부를 지정할 수 있습니다.

열거 값

VISIBLE

HIDDEN

1.5.6. PutAuthProvider

PUT /v1/authProviders/{id}

1.5.6.1. 설명
1.5.6.2. 매개 변수
1.5.6.2.1. 경로 매개변수
이름설명필수 항목기본패턴

id

 

X

null

 
1.5.6.2.2. 본문 매개변수
이름설명필수 항목기본패턴

body

AuthProviderServicePutAuthProviderBody

X

  
1.5.6.3. 반환 유형

StorageAuthProvider

1.5.6.4. 콘텐츠 유형
  • application/json
1.5.6.5. 응답
표 1.25. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

StorageAuthProvider

0

예기치 않은 오류 응답

GooglerpcStatus

1.5.6.6. Samples
1.5.6.7. 공통 오브젝트 참조
1.5.6.7.1. AuthProviderRequiredAttribute

RequiredAttribute를 사용하면 인증 공급자가 모두 반환해야 하는 속성 세트를 지정할 수 있습니다. Central에서 발행한 토큰의 외부 클레임 내에 속성이 없는 경우 이 IdP에 대한 인증 요청이 실패한 것으로 간주됩니다.

필드 이름필수 항목Cryostat유형설명형식

attributeKey

  

문자열

  

attributeValue

  

문자열

  
1.5.6.7.2. AuthProviderServicePutAuthProviderBody

다음 태그: 15.

필드 이름필수 항목Cryostat유형설명형식

name

  

문자열

  

type

  

문자열

  

uiEndpoint

  

문자열

  

enabled

  

부울

  

config

  

문자열

구성에는 인증 공급자 특정 구성이 있습니다. 각 구성 옵션은 지정된 auth 공급자 유형에 따라 다릅니다. OIDC: - \"issuer\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier. - \"client_id\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier에 따른 클라이언트 ID입니다. - \"client_secret\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.3.1 에 따른 클라이언트 시크릿입니다. - \"do_use_client_secret\": \"true\"로 설정합니다. https://www.rfc-editor.org/rfc/rfc6749.html#section-2.2 클라이언트 ID와 클라이언트 시크릿 없이 구성을 생성하려면 다음을 수행합니다. - \"mode\": OIDC 콜백 모드 오프라인 토큰을 발행해서는 안 되는 경우 \"fragment\", \"post\" 또는 \"query\". - \"disable_offline_access_scope\": 오프라인 토큰이 발행되지 않아야 합니다. - \"extra_scopes\": \"openid 프로필 이메일\"에 따라 요청하기 위해 공백으로 구분된 추가 범위 문자열입니다. https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 OpenShift Auth: 추가 구성 옵션 없이 지원합니다. 사용자 PKI: - \"keys\": 신뢰할 수 있는 인증서 PEM 인코딩. SAML: - \"sp_issuer\": https://datatracker.ietf.org/doc/html/rfc7522#section-3. - \"idp_metadata_url\": https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf 에 따른 메타데이터 URL입니다. - \"idp_issuer\": IdP 발행자. - \"idp_cert_pem\": IdP에 대해 인코딩한 인증서 PEM endpoint. - \"idp_sso_url\": IdP SSO URL. - \"idp_nameid_format\": IdP 이름 ID 형식입니다. IAP: - \"audience\": 사용할 대상입니다.

 

loginUrl

  

문자열

로그인 URL은 백엔드에서 제공하며 요청에 지정할 수 없습니다.

 

검증됨

  

부울

  

extraUiEndpoints

  

문자열목록

ui_endpoint 외에도 허용할 UI 끝점입니다. 즉, 로그인 요청이 이러한 요청 중 하나에서 발생하는 경우 인증 요청은 ui_endpoint가 아닌 콜백 URL에 이러한 요청을 사용합니다.

 

활성 상태

  

부울

  

requiredAttributes

  

AuthProviderRequiredAttribute목록

  

traits

  

StorageTraits

  

claimMappings

  

문자열

Rox 토큰 속성에 복사할 IdP 토큰의 클레임을 지정합니다. 이 맵의 각 키에는 매핑하려는 IdP 토큰의 경로가 포함되어 있습니다. 경로는 \".\" 기호로 구분됩니다. 예를 들어 IdP 토큰 페이로드가 다음과 같은 경우 { \"a\": { \"b\" : \"c\", \"d\": true, \"e\", \"val2\", \"val3\" ], \"val3\" ], \"f\": [ true, false, false ], \"G\": 123.0, \"h\": [ 1, 2, 3] } } then \"a.b\"는 유효한 키가 되고 \"a.z\"는 유효하지 않습니다. 다음과 같은 유형의 클레임을 지원합니다. * string(path \"a.") * bool(path \"a.d\") * string array(path \"a.e\") * bool 배열(path \"a.f.\") 당사는 다음과 같은 유형의 클레임을 지원하지 않습니다. * 복잡한 클레임(path \"a\") * float/integer claims(path \"a.g\") * float/integer array claims(path \"a.h\") 이 맵의 각 값에는 클레임을 추가하려는 Rox 토큰 특성 이름이 포함되어 있습니다. 예를 들어 value가 \"groups\"인 경우 클레임은 토큰의 \"external_user.Attributes.groups\"에 있습니다. 참고: 이 기능은 OIDC 인증 공급자에 대해서만 지원합니다.

 

lastUpdated

  

날짜

마지막 업데이트됨은 인증 공급자가 마지막으로 업데이트된 시간을 나타냅니다. 이 타임스탬프 전에 인증 공급자가 발행한 토큰이 있는 경우 유효하지 않은 것으로 간주됩니다. 결과적으로 모든 클라이언트는 토큰을 다시 발행해야 합니다(새로 고침 또는 추가 로그인 시도를 통해).

날짜-시간

1.5.6.7.3. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.5.6.7.4. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.5.6.7.4.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.5.6.7.5. StorageAuthProvider

다음 태그: 15.

필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

type

  

문자열

  

uiEndpoint

  

문자열

  

enabled

  

부울

  

config

  

문자열

구성에는 인증 공급자 특정 구성이 있습니다. 각 구성 옵션은 지정된 auth 공급자 유형에 따라 다릅니다. OIDC: - \"issuer\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier. - \"client_id\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier에 따른 클라이언트 ID입니다. - \"client_secret\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.3.1 에 따른 클라이언트 시크릿입니다. - \"do_use_client_secret\": \"true\"로 설정합니다. https://www.rfc-editor.org/rfc/rfc6749.html#section-2.2 클라이언트 ID와 클라이언트 시크릿 없이 구성을 생성하려면 다음을 수행합니다. - \"mode\": OIDC 콜백 모드 오프라인 토큰을 발행해서는 안 되는 경우 \"fragment\", \"post\" 또는 \"query\". - \"disable_offline_access_scope\": 오프라인 토큰이 발행되지 않아야 합니다. - \"extra_scopes\": \"openid 프로필 이메일\"에 따라 요청하기 위해 공백으로 구분된 추가 범위 문자열입니다. https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 OpenShift Auth: 추가 구성 옵션 없이 지원합니다. 사용자 PKI: - \"keys\": 신뢰할 수 있는 인증서 PEM 인코딩. SAML: - \"sp_issuer\": https://datatracker.ietf.org/doc/html/rfc7522#section-3. - \"idp_metadata_url\": https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf 에 따른 메타데이터 URL입니다. - \"idp_issuer\": IdP 발행자. - \"idp_cert_pem\": IdP에 대해 인코딩한 인증서 PEM endpoint. - \"idp_sso_url\": IdP SSO URL. - \"idp_nameid_format\": IdP 이름 ID 형식입니다. IAP: - \"audience\": 사용할 대상입니다.

 

loginUrl

  

문자열

로그인 URL은 백엔드에서 제공하며 요청에 지정할 수 없습니다.

 

검증됨

  

부울

  

extraUiEndpoints

  

문자열목록

ui_endpoint 외에도 허용할 UI 끝점입니다. 즉, 로그인 요청이 이러한 요청 중 하나에서 발생하는 경우 인증 요청은 ui_endpoint가 아닌 콜백 URL에 이러한 요청을 사용합니다.

 

활성 상태

  

부울

  

requiredAttributes

  

AuthProviderRequiredAttribute목록

  

traits

  

StorageTraits

  

claimMappings

  

문자열

Rox 토큰 속성에 복사할 IdP 토큰의 클레임을 지정합니다. 이 맵의 각 키에는 매핑하려는 IdP 토큰의 경로가 포함되어 있습니다. 경로는 \".\" 기호로 구분됩니다. 예를 들어 IdP 토큰 페이로드가 다음과 같은 경우 { \"a\": { \"b\" : \"c\", \"d\": true, \"e\", \"val2\", \"val3\" ], \"val3\" ], \"f\": [ true, false, false ], \"G\": 123.0, \"h\": [ 1, 2, 3] } } then \"a.b\"는 유효한 키가 되고 \"a.z\"는 유효하지 않습니다. 다음과 같은 유형의 클레임을 지원합니다. * string(path \"a.") * bool(path \"a.d\") * string array(path \"a.e\") * bool 배열(path \"a.f.\") 당사는 다음과 같은 유형의 클레임을 지원하지 않습니다. * 복잡한 클레임(path \"a\") * float/integer claims(path \"a.g\") * float/integer array claims(path \"a.h\") 이 맵의 각 값에는 클레임을 추가하려는 Rox 토큰 특성 이름이 포함되어 있습니다. 예를 들어 value가 \"groups\"인 경우 클레임은 토큰의 \"external_user.Attributes.groups\"에 있습니다. 참고: 이 기능은 OIDC 인증 공급자에 대해서만 지원합니다.

 

lastUpdated

  

날짜

마지막 업데이트됨은 인증 공급자가 마지막으로 업데이트된 시간을 나타냅니다. 이 타임스탬프 전에 인증 공급자가 발행한 토큰이 있는 경우 유효하지 않은 것으로 간주됩니다. 결과적으로 모든 클라이언트는 토큰을 다시 발행해야 합니다(새로 고침 또는 추가 로그인 시도를 통해).

날짜-시간

1.5.6.7.6. StorageTraits
필드 이름필수 항목Cryostat유형설명형식

mutabilityMode

  

TraitsMutabilityMode

 

ALLOW_MUTATE, ALLOW_MUTATE_FORCED,

가시성

  

traditionalitsVisibility

 

표시, 숨겨진,

origin

  

traditional presentationsOrigin

 

IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED,

1.5.6.7.7. TraitsMutabilityMode

실험적. 참고: 시간이 지남에 따라 MutabilityMode 사용을 참조하십시오. 이는 향후 대체될 예정입니다(ROX-14276). MutabilityMode는 오브젝트를 수정할 수 있는지 여부와 방법을 지정합니다. 기본값은 ALLOW_MUTATE이며 수정 제한이 없음을 의미합니다. 이는 MutabilityMode 사양이 없는 것과 동일합니다. ALLOW_MUTATE_FORCED는 강제로 강제로 제거하는 것을 제외한 모든 수정 작업을 금지합니다.

이 필드의 상태를 변경할 때는 주의하십시오. 예를 들어 ALLOW_MUTATE에서 ALLOW_MUTATE_FORCED로 오브젝트를 수정할 수 있지만 ALLOW_MUTATE로 다시 수정하는 등 추가 변경 사항이 금지됩니다.

열거 값

ALLOW_MUTATE

ALLOW_MUTATE_FORCED

1.5.6.7.8. traditional presentationsOrigin

origin은 개체의 원본을 지정합니다. 오브젝트에는 4개의 서로 다른 원본이 있을 수 있습니다. - IMPERATIVE: 오브젝트는 API를 통해 생성되었습니다. 이는 기본적으로 가정됩니다. - DEFAULT: 오브젝트는 기본 역할, 액세스 범위 등과 같은 기본 오브젝트입니다. - DECLARATIVE: 오브젝트는 선언적 구성을 통해 생성됩니다. - DECLARATIVE_ORPHANED: 오브젝트는 선언적 구성을 통해 생성된 다음(예: 다른 오브젝트에서 참조하기 때문에) 실패로 삭제(예: 대상자 규칙)에 따라 다른 규칙을 적용합니다. DECLARATIVE 원본이 있는 오브젝트는 선언적 구성을 통해서만 API를 통해 수정할 수 없습니다. 또한 IMPERATIVE 원본과 함께 오브젝트를 참조할 수 없습니다. DEFAULT 원본이 있는 오브젝트는 API 또는 선언적 구성을 통해 수정할 수 없습니다. 다른 모든 오브젝트에서 참조할 수 있습니다. IMPERATIVE 원본이 있는 오브젝트는 선언적 구성이 아닌 API를 통해 수정할 수 있습니다. 다른 모든 개체를 참조할 수 있습니다. DECLARATIVE_ORPHANED 원본이 있는 오브젝트는 API 또는 선언적 구성을 통해 수정할 수 없습니다. DECLARATIVE_ORPHANED 리소스는 선언적 구성으로 다시 정의되면 DECLARATIVE 리소스가 될 수 있습니다. 이 원본이 있는 오브젝트는 더 이상 다른 리소스에서 참조하지 않은 직후 시스템에서 정리됩니다. 다른 모든 오브젝트에서 참조할 수 있습니다.

열거 값

IMPERATIVE

DEFAULT

DECLARATIVE

DECLARATIVE_ORPHANED

1.5.6.7.9. traditionalitsVisibility

EXPERIMENTAL. visibility를 사용하면 특정 API에 개체를 볼 수 있는지 여부를 지정할 수 있습니다.

열거 값

VISIBLE

HIDDEN

1.5.7. PostAuthProvider

POST /v1/authProviders

1.5.7.1. 설명
1.5.7.2. 매개 변수
1.5.7.2.1. 본문 매개변수
이름설명필수 항목기본패턴

provider

StorageAuthProvider

X

  
1.5.7.3. 반환 유형

StorageAuthProvider

1.5.7.4. 콘텐츠 유형
  • application/json
1.5.7.5. 응답
표 1.26. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

StorageAuthProvider

0

예기치 않은 오류 응답

GooglerpcStatus

1.5.7.6. Samples
1.5.7.7. 공통 오브젝트 참조
1.5.7.7.1. AuthProviderRequiredAttribute

RequiredAttribute를 사용하면 인증 공급자가 모두 반환해야 하는 속성 세트를 지정할 수 있습니다. Central에서 발행한 토큰의 외부 클레임 내에 속성이 없는 경우 이 IdP에 대한 인증 요청이 실패한 것으로 간주됩니다.

필드 이름필수 항목Cryostat유형설명형식

attributeKey

  

문자열

  

attributeValue

  

문자열

  
1.5.7.7.2. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.5.7.7.3. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.5.7.7.3.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.5.7.7.4. StorageAuthProvider

다음 태그: 15.

필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

type

  

문자열

  

uiEndpoint

  

문자열

  

enabled

  

부울

  

config

  

문자열

구성에는 인증 공급자 특정 구성이 있습니다. 각 구성 옵션은 지정된 auth 공급자 유형에 따라 다릅니다. OIDC: - \"issuer\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier. - \"client_id\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier에 따른 클라이언트 ID입니다. - \"client_secret\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.3.1 에 따른 클라이언트 시크릿입니다. - \"do_use_client_secret\": \"true\"로 설정합니다. https://www.rfc-editor.org/rfc/rfc6749.html#section-2.2 클라이언트 ID와 클라이언트 시크릿 없이 구성을 생성하려면 다음을 수행합니다. - \"mode\": OIDC 콜백 모드 오프라인 토큰을 발행해서는 안 되는 경우 \"fragment\", \"post\" 또는 \"query\". - \"disable_offline_access_scope\": 오프라인 토큰이 발행되지 않아야 합니다. - \"extra_scopes\": \"openid 프로필 이메일\"에 따라 요청하기 위해 공백으로 구분된 추가 범위 문자열입니다. https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 OpenShift Auth: 추가 구성 옵션 없이 지원합니다. 사용자 PKI: - \"keys\": 신뢰할 수 있는 인증서 PEM 인코딩. SAML: - \"sp_issuer\": https://datatracker.ietf.org/doc/html/rfc7522#section-3. - \"idp_metadata_url\": https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf 에 따른 메타데이터 URL입니다. - \"idp_issuer\": IdP 발행자. - \"idp_cert_pem\": IdP에 대해 인코딩한 인증서 PEM endpoint. - \"idp_sso_url\": IdP SSO URL. - \"idp_nameid_format\": IdP 이름 ID 형식입니다. IAP: - \"audience\": 사용할 대상입니다.

 

loginUrl

  

문자열

로그인 URL은 백엔드에서 제공하며 요청에 지정할 수 없습니다.

 

검증됨

  

부울

  

extraUiEndpoints

  

문자열목록

ui_endpoint 외에도 허용할 UI 끝점입니다. 즉, 로그인 요청이 이러한 요청 중 하나에서 발생하는 경우 인증 요청은 ui_endpoint가 아닌 콜백 URL에 이러한 요청을 사용합니다.

 

활성 상태

  

부울

  

requiredAttributes

  

AuthProviderRequiredAttribute목록

  

traits

  

StorageTraits

  

claimMappings

  

문자열

Rox 토큰 속성에 복사할 IdP 토큰의 클레임을 지정합니다. 이 맵의 각 키에는 매핑하려는 IdP 토큰의 경로가 포함되어 있습니다. 경로는 \".\" 기호로 구분됩니다. 예를 들어 IdP 토큰 페이로드가 다음과 같은 경우 { \"a\": { \"b\" : \"c\", \"d\": true, \"e\", \"val2\", \"val3\" ], \"val3\" ], \"f\": [ true, false, false ], \"G\": 123.0, \"h\": [ 1, 2, 3] } } then \"a.b\"는 유효한 키가 되고 \"a.z\"는 유효하지 않습니다. 다음과 같은 유형의 클레임을 지원합니다. * string(path \"a.") * bool(path \"a.d\") * string array(path \"a.e\") * bool 배열(path \"a.f.\") 당사는 다음과 같은 유형의 클레임을 지원하지 않습니다. * 복잡한 클레임(path \"a\") * float/integer claims(path \"a.g\") * float/integer array claims(path \"a.h\") 이 맵의 각 값에는 클레임을 추가하려는 Rox 토큰 특성 이름이 포함되어 있습니다. 예를 들어 value가 \"groups\"인 경우 클레임은 토큰의 \"external_user.Attributes.groups\"에 있습니다. 참고: 이 기능은 OIDC 인증 공급자에 대해서만 지원합니다.

 

lastUpdated

  

날짜

마지막 업데이트됨은 인증 공급자가 마지막으로 업데이트된 시간을 나타냅니다. 이 타임스탬프 전에 인증 공급자가 발행한 토큰이 있는 경우 유효하지 않은 것으로 간주됩니다. 결과적으로 모든 클라이언트는 토큰을 다시 발행해야 합니다(새로 고침 또는 추가 로그인 시도를 통해).

날짜-시간

1.5.7.7.5. StorageTraits
필드 이름필수 항목Cryostat유형설명형식

mutabilityMode

  

TraitsMutabilityMode

 

ALLOW_MUTATE, ALLOW_MUTATE_FORCED,

가시성

  

traditionalitsVisibility

 

표시, 숨겨진,

origin

  

traditional presentationsOrigin

 

IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED,

1.5.7.7.6. TraitsMutabilityMode

실험적. 참고: 시간이 지남에 따라 MutabilityMode 사용을 참조하십시오. 이는 향후 대체될 예정입니다(ROX-14276). MutabilityMode는 오브젝트를 수정할 수 있는지 여부와 방법을 지정합니다. 기본값은 ALLOW_MUTATE이며 수정 제한이 없음을 의미합니다. 이는 MutabilityMode 사양이 없는 것과 동일합니다. ALLOW_MUTATE_FORCED는 강제로 강제로 제거하는 것을 제외한 모든 수정 작업을 금지합니다.

이 필드의 상태를 변경할 때는 주의하십시오. 예를 들어 ALLOW_MUTATE에서 ALLOW_MUTATE_FORCED로 오브젝트를 수정할 수 있지만 ALLOW_MUTATE로 다시 수정하는 등 추가 변경 사항이 금지됩니다.

열거 값

ALLOW_MUTATE

ALLOW_MUTATE_FORCED

1.5.7.7.7. traditional presentationsOrigin

origin은 개체의 원본을 지정합니다. 오브젝트에는 4개의 서로 다른 원본이 있을 수 있습니다. - IMPERATIVE: 오브젝트는 API를 통해 생성되었습니다. 이는 기본적으로 가정됩니다. - DEFAULT: 오브젝트는 기본 역할, 액세스 범위 등과 같은 기본 오브젝트입니다. - DECLARATIVE: 오브젝트는 선언적 구성을 통해 생성됩니다. - DECLARATIVE_ORPHANED: 오브젝트는 선언적 구성을 통해 생성된 다음(예: 다른 오브젝트에서 참조하기 때문에) 실패로 삭제(예: 대상자 규칙)에 따라 다른 규칙을 적용합니다. DECLARATIVE 원본이 있는 오브젝트는 선언적 구성을 통해서만 API를 통해 수정할 수 없습니다. 또한 IMPERATIVE 원본과 함께 오브젝트를 참조할 수 없습니다. DEFAULT 원본이 있는 오브젝트는 API 또는 선언적 구성을 통해 수정할 수 없습니다. 다른 모든 오브젝트에서 참조할 수 있습니다. IMPERATIVE 원본이 있는 오브젝트는 선언적 구성이 아닌 API를 통해 수정할 수 있습니다. 다른 모든 개체를 참조할 수 있습니다. DECLARATIVE_ORPHANED 원본이 있는 오브젝트는 API 또는 선언적 구성을 통해 수정할 수 없습니다. DECLARATIVE_ORPHANED 리소스는 선언적 구성으로 다시 정의되면 DECLARATIVE 리소스가 될 수 있습니다. 이 원본이 있는 오브젝트는 더 이상 다른 리소스에서 참조하지 않은 직후 시스템에서 정리됩니다. 다른 모든 오브젝트에서 참조할 수 있습니다.

열거 값

IMPERATIVE

DEFAULT

DECLARATIVE

DECLARATIVE_ORPHANED

1.5.7.7.8. traditionalitsVisibility

EXPERIMENTAL. visibility를 사용하면 특정 API에 개체를 볼 수 있는지 여부를 지정할 수 있습니다.

열거 값

VISIBLE

HIDDEN

1.5.8. ListAvailableProviderTypes

GET /v1/availableAuthProviders

1.5.8.1. 설명
1.5.8.2. 매개 변수
1.5.8.3. 반환 유형

V1AvailableProviderTypesResponse

1.5.8.4. 콘텐츠 유형
  • application/json
1.5.8.5. 응답
표 1.27. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1AvailableProviderTypesResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.5.8.6. Samples
1.5.8.7. 공통 오브젝트 참조
1.5.8.7.1. AvailableProviderTypesResponseAuthProviderType
필드 이름필수 항목Cryostat유형설명형식

type

  

문자열

  

suggestedAttributes

  

문자열목록

  
1.5.8.7.2. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.5.8.7.3. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.5.8.7.3.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.5.8.7.4. V1AvailableProviderTypesResponse
필드 이름필수 항목Cryostat유형설명형식

authProviderTypes

  

List of AvailableProviderTypesResponseAuthProviderType

  

1.5.9. GetLoginAuthProviders

GET /v1/login/authproviders

1.5.9.1. 설명
1.5.9.2. 매개 변수
1.5.9.3. 반환 유형

V1GetLoginAuthProvidersResponse

1.5.9.4. 콘텐츠 유형
  • application/json
1.5.9.5. 응답
표 1.28. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1GetLoginAuthProvidersResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.5.9.6. Samples
1.5.9.7. 공통 오브젝트 참조
1.5.9.7.1. GetLoginAuthProvidersResponseLoginAuthProvider
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

type

  

문자열

  

loginUrl

  

문자열

  
1.5.9.7.2. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.5.9.7.3. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.5.9.7.3.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.5.9.7.4. V1GetLoginAuthProvidersResponse
필드 이름필수 항목Cryostat유형설명형식

authProviders

  

List of GetLoginAuthProvidersResponseLoginAuthProvider

  

1.6. AuthService

1.6.1. UpdateAuthMachineToMachineConfig

PUT /v1/auth/m2m/{config.id}

UpdateAuthMachineToMachineConfig는 기존 인증 머신을 머신 구성으로 업데이트합니다. 머신 구성에 대한 인증 머신이 없으면 새 머신이 생성됩니다.

1.6.1.1. 설명
1.6.1.2. 매개 변수
1.6.1.2.1. 경로 매개변수
이름설명필수 항목기본패턴

config.id

구성의 UUID입니다. 머신 구성에 머신을 추가할 때 이 필드를 설정하지 않아야 합니다.

X

null

 
1.6.1.2.2. 본문 매개변수
이름설명필수 항목기본패턴

body

AuthServiceUpdateAuthMachineToMachineConfigBody

X

  
1.6.1.3. 반환 유형

개체

1.6.1.4. 콘텐츠 유형
  • application/json
1.6.1.5. 응답
표 1.29. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

개체

0

예기치 않은 오류 응답

GooglerpcStatus

1.6.1.6. Samples
1.6.1.7. 공통 오브젝트 참조
1.6.1.7.1. AuthMachineToMachineConfigMapping

매핑은 ID 토큰의 클레임 값을 Central 내의 특정 역할에 매핑합니다.

필드 이름필수 항목Cryostat유형설명형식

key

  

문자열

사용할 ID 토큰의 클레임 값 내의 키입니다.

 

valueExpression

  

문자열

지정된 키로 식별되는 ID 토큰 클레임의 값에 대해 평가할 정규식입니다. 이 정규식은 RE2 형식으로 되어 있습니다. https://github.com/google/re2/wiki/Syntax.

 

role

  

문자열

키와 값이 특정 ID 토큰과 일치할 때 발행해야 하는 역할입니다.

 
1.6.1.7.2. AuthServiceUpdateAuthMachineToMachineConfigBody
필드 이름필수 항목Cryostat유형설명형식

config

  

AuthServiceUpdateAuthMachineToMachineConfigBodyConfig

  
1.6.1.7.3. AuthServiceUpdateAuthMachineToMachineConfigBodyConfig

AuthMachineToMachineConfig는 중앙 액세스 토큰을 사용하여 타사에서 ID 토큰을 교환하는 규칙을 결정합니다. M2M은 구성의 의도된 사용 사례이므로 Machine to machine을 나타냅니다.

필드 이름필수 항목Cryostat유형설명형식

type

  

V1AuthMachineToMachineConfigType

 

일반, GITHUB_ACTIONS, KUBE_SERVICE_ACCOUNT,

tokenExpirationDuration

  

문자열

ExchangeAuthMachineToMachineToken API 호출에서 반환된 토큰 만료를 설정합니다. 가능한 유효한 시간 단위는 s, m, h입니다. 허용되는 최대 만료 기간은 24h입니다. 예를 들면 2h45m입니다. 기간 검증에 대한 자세한 내용은 https://pkg.go.dev/time#ParseDuration 을 참조하십시오.

 

매핑

  

List of AuthMachineToMachineConfigMapping

액세스 토큰을 성공적으로 생성하려면 유효한 역할을 확인하려면 하나 이상의 매핑이 필요합니다.

 

issuer

  

문자열

관련 OIDC 공급자의 발행자에서 교환하기 위해 ID 토큰을 발행합니다. type이 GENERIC인 경우 URL을 포함하는 비어 있지 않은 문자열이어야 합니다. GitHub 작업의 경우 비어 있거나 https://token.actions.githubusercontent.com 로 설정해야 합니다. 발행자는 고유한 키이므로 하나의 GITHUB_ACTIONS 구성이 있을 수 있으며 각 GENERIC 구성에 고유한 발행자가 있어야 합니다.

 
1.6.1.7.4. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.6.1.7.5. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.6.1.7.5.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.6.1.7.6. V1AuthMachineToMachineConfigType

머신 구성에 대한 인증 머신 유형입니다. 현재 토큰 확인 및 교환에 사용할 GitHub 작업 또는 기타 일반 OIDC 공급자를 지원합니다.

열거 값

일반

GITHUB_ACTIONS

KUBE_SERVICE_ACCOUNT

1.6.2. ExchangeAuthMachineToMachineToken

POST /v1/auth/m2m/exchange

ExchangeAuthMachineToMachineToken은 구성된 인증 머신을 머신 구성에 따라 중앙 액세스 토큰에 대해 지정된 ID 토큰을 조작합니다.

1.6.2.1. 설명
1.6.2.2. 매개 변수
1.6.2.2.1. 본문 매개변수
이름설명필수 항목기본패턴

body

V1ExchangeAuthMachineToMachineTokenRequest

X

  
1.6.2.3. 반환 유형

V1ExchangeAuthMachineToMachineTokenResponse

1.6.2.4. 콘텐츠 유형
  • application/json
1.6.2.5. 응답
표 1.30. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1ExchangeAuthMachineToMachineTokenResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.6.2.6. Samples
1.6.2.7. 공통 오브젝트 참조
1.6.2.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.6.2.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.6.2.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.6.2.7.3. V1ExchangeAuthMachineToMachineTokenRequest
필드 이름필수 항목Cryostat유형설명형식

idToken

  

문자열

교환해야 하는 ID 토큰입니다.

 
1.6.2.7.4. V1ExchangeAuthMachineToMachineTokenResponse
필드 이름필수 항목Cryostat유형설명형식

accessToken

  

문자열

교환된 액세스 토큰입니다.

 

1.6.3. ListAuthMachineToMachineConfigs

GET /v1/auth/m2m

ListAuthMachineToMachineConfigs는 사용 가능한 인증 머신을 머신 구성에 나열합니다.

1.6.3.1. 설명
1.6.3.2. 매개 변수
1.6.3.3. 반환 유형

V1ListAuthMachineToMachineConfigResponse

1.6.3.4. 콘텐츠 유형
  • application/json
1.6.3.5. 응답
표 1.31. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1ListAuthMachineToMachineConfigResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.6.3.6. Samples
1.6.3.7. 공통 오브젝트 참조
1.6.3.7.1. AuthMachineToMachineConfigMapping

매핑은 ID 토큰의 클레임 값을 Central 내의 특정 역할에 매핑합니다.

필드 이름필수 항목Cryostat유형설명형식

key

  

문자열

사용할 ID 토큰의 클레임 값 내의 키입니다.

 

valueExpression

  

문자열

지정된 키로 식별되는 ID 토큰 클레임의 값에 대해 평가할 정규식입니다. 이 정규식은 RE2 형식으로 되어 있습니다. https://github.com/google/re2/wiki/Syntax.

 

role

  

문자열

키와 값이 특정 ID 토큰과 일치할 때 발행해야 하는 역할입니다.

 
1.6.3.7.2. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.6.3.7.3. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.6.3.7.3.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.6.3.7.4. V1AuthMachineToMachineConfig

AuthMachineToMachineConfig는 중앙 액세스 토큰을 사용하여 타사에서 ID 토큰을 교환하는 규칙을 결정합니다. M2M은 구성의 의도된 사용 사례이므로 Machine to machine을 나타냅니다.

필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

구성의 UUID입니다. 머신 구성에 머신을 추가할 때 이 필드를 설정하지 않아야 합니다.

 

type

  

V1AuthMachineToMachineConfigType

 

일반, GITHUB_ACTIONS, KUBE_SERVICE_ACCOUNT,

tokenExpirationDuration

  

문자열

ExchangeAuthMachineToMachineToken API 호출에서 반환된 토큰 만료를 설정합니다. 가능한 유효한 시간 단위는 s, m, h입니다. 허용되는 최대 만료 기간은 24h입니다. 예를 들면 2h45m입니다. 기간 검증에 대한 자세한 내용은 https://pkg.go.dev/time#ParseDuration 을 참조하십시오.

 

매핑

  

List of AuthMachineToMachineConfigMapping

액세스 토큰을 성공적으로 생성하려면 유효한 역할을 확인하려면 하나 이상의 매핑이 필요합니다.

 

issuer

  

문자열

관련 OIDC 공급자의 발행자에서 교환하기 위해 ID 토큰을 발행합니다. type이 GENERIC인 경우 URL을 포함하는 비어 있지 않은 문자열이어야 합니다. GitHub 작업의 경우 비어 있거나 https://token.actions.githubusercontent.com 로 설정해야 합니다. 발행자는 고유한 키이므로 하나의 GITHUB_ACTIONS 구성이 있을 수 있으며 각 GENERIC 구성에 고유한 발행자가 있어야 합니다.

 
1.6.3.7.5. V1AuthMachineToMachineConfigType

머신 구성에 대한 인증 머신 유형입니다. 현재 토큰 확인 및 교환에 사용할 GitHub 작업 또는 기타 일반 OIDC 공급자를 지원합니다.

열거 값

일반

GITHUB_ACTIONS

KUBE_SERVICE_ACCOUNT

1.6.3.7.6. V1ListAuthMachineToMachineConfigResponse
필드 이름필수 항목Cryostat유형설명형식

configs

  

List of V1AuthMachineToMachineConfig

  

1.6.4. DeleteAuthMachineToMachineConfig

DELETE /v1/auth/m2m/{id}

DeleteAuthMachineToMachineConfig는 특정 인증 머신을 머신 구성에 삭제합니다. 머신 구성에 지정된 인증 머신이 삭제되지 않으면 오류가 반환되지 않습니다.

1.6.4.1. 설명
1.6.4.2. 매개 변수
1.6.4.2.1. 경로 매개변수
이름설명필수 항목기본패턴

id

 

X

null

 
1.6.4.3. 반환 유형

개체

1.6.4.4. 콘텐츠 유형
  • application/json
1.6.4.5. 응답
표 1.32. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

개체

0

예기치 않은 오류 응답

GooglerpcStatus

1.6.4.6. Samples
1.6.4.7. 공통 오브젝트 참조
1.6.4.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.6.4.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.6.4.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 

1.6.5. GetAuthMachineToMachineConfig

GET /v1/auth/m2m/{id}

GetAuthMachineToMachineConfig는 머신 구성에 특정 인증 머신을 검색합니다.

1.6.5.1. 설명
1.6.5.2. 매개 변수
1.6.5.2.1. 경로 매개변수
이름설명필수 항목기본패턴

id

 

X

null

 
1.6.5.3. 반환 유형

V1GetAuthMachineToMachineConfigResponse

1.6.5.4. 콘텐츠 유형
  • application/json
1.6.5.5. 응답
표 1.33. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1GetAuthMachineToMachineConfigResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.6.5.6. Samples
1.6.5.7. 공통 오브젝트 참조
1.6.5.7.1. AuthMachineToMachineConfigMapping

매핑은 ID 토큰의 클레임 값을 Central 내의 특정 역할에 매핑합니다.

필드 이름필수 항목Cryostat유형설명형식

key

  

문자열

사용할 ID 토큰의 클레임 값 내의 키입니다.

 

valueExpression

  

문자열

지정된 키로 식별되는 ID 토큰 클레임의 값에 대해 평가할 정규식입니다. 이 정규식은 RE2 형식으로 되어 있습니다. https://github.com/google/re2/wiki/Syntax.

 

role

  

문자열

키와 값이 특정 ID 토큰과 일치할 때 발행해야 하는 역할입니다.

 
1.6.5.7.2. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.6.5.7.3. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.6.5.7.3.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.6.5.7.4. V1AuthMachineToMachineConfig

AuthMachineToMachineConfig는 중앙 액세스 토큰을 사용하여 타사에서 ID 토큰을 교환하는 규칙을 결정합니다. M2M은 구성의 의도된 사용 사례이므로 Machine to machine을 나타냅니다.

필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

구성의 UUID입니다. 머신 구성에 머신을 추가할 때 이 필드를 설정하지 않아야 합니다.

 

type

  

V1AuthMachineToMachineConfigType

 

일반, GITHUB_ACTIONS, KUBE_SERVICE_ACCOUNT,

tokenExpirationDuration

  

문자열

ExchangeAuthMachineToMachineToken API 호출에서 반환된 토큰 만료를 설정합니다. 가능한 유효한 시간 단위는 s, m, h입니다. 허용되는 최대 만료 기간은 24h입니다. 예를 들면 2h45m입니다. 기간 검증에 대한 자세한 내용은 https://pkg.go.dev/time#ParseDuration 을 참조하십시오.

 

매핑

  

List of AuthMachineToMachineConfigMapping

액세스 토큰을 성공적으로 생성하려면 유효한 역할을 확인하려면 하나 이상의 매핑이 필요합니다.

 

issuer

  

문자열

관련 OIDC 공급자의 발행자에서 교환하기 위해 ID 토큰을 발행합니다. type이 GENERIC인 경우 URL을 포함하는 비어 있지 않은 문자열이어야 합니다. GitHub 작업의 경우 비어 있거나 https://token.actions.githubusercontent.com 로 설정해야 합니다. 발행자는 고유한 키이므로 하나의 GITHUB_ACTIONS 구성이 있을 수 있으며 각 GENERIC 구성에 고유한 발행자가 있어야 합니다.

 
1.6.5.7.5. V1AuthMachineToMachineConfigType

머신 구성에 대한 인증 머신 유형입니다. 현재 토큰 확인 및 교환에 사용할 GitHub 작업 또는 기타 일반 OIDC 공급자를 지원합니다.

열거 값

일반

GITHUB_ACTIONS

KUBE_SERVICE_ACCOUNT

1.6.5.7.6. V1GetAuthMachineToMachineConfigResponse
필드 이름필수 항목Cryostat유형설명형식

config

  

V1AuthMachineToMachineConfig

  

1.6.6. AddAuthMachineToMachineConfig

POST /v1/auth/m2m

AddAuthMachineToMachineConfig는 머신 구성에 새 인증 머신을 생성합니다.

1.6.6.1. 설명
1.6.6.2. 매개 변수
1.6.6.2.1. 본문 매개변수
이름설명필수 항목기본패턴

body

V1AddAuthMachineToMachineConfigRequest

X

  
1.6.6.3. 반환 유형

V1AddAuthMachineToMachineConfigResponse

1.6.6.4. 콘텐츠 유형
  • application/json
1.6.6.5. 응답
표 1.34. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1AddAuthMachineToMachineConfigResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.6.6.6. Samples
1.6.6.7. 공통 오브젝트 참조
1.6.6.7.1. AuthMachineToMachineConfigMapping

매핑은 ID 토큰의 클레임 값을 Central 내의 특정 역할에 매핑합니다.

필드 이름필수 항목Cryostat유형설명형식

key

  

문자열

사용할 ID 토큰의 클레임 값 내의 키입니다.

 

valueExpression

  

문자열

지정된 키로 식별되는 ID 토큰 클레임의 값에 대해 평가할 정규식입니다. 이 정규식은 RE2 형식으로 되어 있습니다. https://github.com/google/re2/wiki/Syntax.

 

role

  

문자열

키와 값이 특정 ID 토큰과 일치할 때 발행해야 하는 역할입니다.

 
1.6.6.7.2. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.6.6.7.3. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.6.6.7.3.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.6.6.7.4. V1AddAuthMachineToMachineConfigRequest
필드 이름필수 항목Cryostat유형설명형식

config

  

V1AuthMachineToMachineConfig

  
1.6.6.7.5. V1AddAuthMachineToMachineConfigResponse
필드 이름필수 항목Cryostat유형설명형식

config

  

V1AuthMachineToMachineConfig

  
1.6.6.7.6. V1AuthMachineToMachineConfig

AuthMachineToMachineConfig는 중앙 액세스 토큰을 사용하여 타사에서 ID 토큰을 교환하는 규칙을 결정합니다. M2M은 구성의 의도된 사용 사례이므로 Machine to machine을 나타냅니다.

필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

구성의 UUID입니다. 머신 구성에 머신을 추가할 때 이 필드를 설정하지 않아야 합니다.

 

type

  

V1AuthMachineToMachineConfigType

 

일반, GITHUB_ACTIONS, KUBE_SERVICE_ACCOUNT,

tokenExpirationDuration

  

문자열

ExchangeAuthMachineToMachineToken API 호출에서 반환된 토큰 만료를 설정합니다. 가능한 유효한 시간 단위는 s, m, h입니다. 허용되는 최대 만료 기간은 24h입니다. 예를 들면 2h45m입니다. 기간 검증에 대한 자세한 내용은 https://pkg.go.dev/time#ParseDuration 을 참조하십시오.

 

매핑

  

List of AuthMachineToMachineConfigMapping

액세스 토큰을 성공적으로 생성하려면 유효한 역할을 확인하려면 하나 이상의 매핑이 필요합니다.

 

issuer

  

문자열

관련 OIDC 공급자의 발행자에서 교환하기 위해 ID 토큰을 발행합니다. type이 GENERIC인 경우 URL을 포함하는 비어 있지 않은 문자열이어야 합니다. GitHub 작업의 경우 비어 있거나 https://token.actions.githubusercontent.com 로 설정해야 합니다. 발행자는 고유한 키이므로 하나의 GITHUB_ACTIONS 구성이 있을 수 있으며 각 GENERIC 구성에 고유한 발행자가 있어야 합니다.

 
1.6.6.7.7. V1AuthMachineToMachineConfigType

머신 구성에 대한 인증 머신 유형입니다. 현재 토큰 확인 및 교환에 사용할 GitHub 작업 또는 기타 일반 OIDC 공급자를 지원합니다.

열거 값

일반

GITHUB_ACTIONS

KUBE_SERVICE_ACCOUNT

1.6.7. GetAuthStatus

GET /v1/auth/status

GetAuthStatus는 현재 클라이언트의 상태를 반환합니다.

1.6.7.1. 설명
1.6.7.2. 매개 변수
1.6.7.3. 반환 유형

V1AuthStatus

1.6.7.4. 콘텐츠 유형
  • application/json
1.6.7.5. 응답
표 1.35. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1AuthStatus

0

예기치 않은 오류 응답

GooglerpcStatus

1.6.7.6. Samples
1.6.7.7. 공통 오브젝트 참조
1.6.7.7.1. AuthProviderRequiredAttribute

RequiredAttribute를 사용하면 인증 공급자가 모두 반환해야 하는 속성 세트를 지정할 수 있습니다. Central에서 발행한 토큰의 외부 클레임 내에 속성이 없는 경우 이 IdP에 대한 인증 요청이 실패한 것으로 간주됩니다.

필드 이름필수 항목Cryostat유형설명형식

attributeKey

  

문자열

  

attributeValue

  

문자열

  
1.6.7.7.2. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.6.7.7.3. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.6.7.7.3.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.6.7.7.4. StorageAccess
열거 값

NO_ACCESS

READ_ACCESS

READ_WRITE_ACCESS

1.6.7.7.5. StorageAuthProvider

다음 태그: 15.

필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

type

  

문자열

  

uiEndpoint

  

문자열

  

enabled

  

부울

  

config

  

문자열

구성에는 인증 공급자 특정 구성이 있습니다. 각 구성 옵션은 지정된 auth 공급자 유형에 따라 다릅니다. OIDC: - \"issuer\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier. - \"client_id\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier에 따른 클라이언트 ID입니다. - \"client_secret\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.3.1 에 따른 클라이언트 시크릿입니다. - \"do_use_client_secret\": \"true\"로 설정합니다. https://www.rfc-editor.org/rfc/rfc6749.html#section-2.2 클라이언트 ID와 클라이언트 시크릿 없이 구성을 생성하려면 다음을 수행합니다. - \"mode\": OIDC 콜백 모드 오프라인 토큰을 발행해서는 안 되는 경우 \"fragment\", \"post\" 또는 \"query\". - \"disable_offline_access_scope\": 오프라인 토큰이 발행되지 않아야 합니다. - \"extra_scopes\": \"openid 프로필 이메일\"에 따라 요청하기 위해 공백으로 구분된 추가 범위 문자열입니다. https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 OpenShift Auth: 추가 구성 옵션 없이 지원합니다. 사용자 PKI: - \"keys\": 신뢰할 수 있는 인증서 PEM 인코딩. SAML: - \"sp_issuer\": https://datatracker.ietf.org/doc/html/rfc7522#section-3. - \"idp_metadata_url\": https://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf 에 따른 메타데이터 URL입니다. - \"idp_issuer\": IdP 발행자. - \"idp_cert_pem\": IdP에 대해 인코딩한 인증서 PEM endpoint. - \"idp_sso_url\": IdP SSO URL. - \"idp_nameid_format\": IdP 이름 ID 형식입니다. IAP: - \"audience\": 사용할 대상입니다.

 

loginUrl

  

문자열

로그인 URL은 백엔드에서 제공하며 요청에 지정할 수 없습니다.

 

검증됨

  

부울

  

extraUiEndpoints

  

문자열목록

ui_endpoint 외에도 허용할 UI 끝점입니다. 즉, 로그인 요청이 이러한 요청 중 하나에서 발생하는 경우 인증 요청은 ui_endpoint가 아닌 콜백 URL에 이러한 요청을 사용합니다.

 

활성 상태

  

부울

  

requiredAttributes

  

AuthProviderRequiredAttribute목록

  

traits

  

StorageTraits

  

claimMappings

  

문자열

Rox 토큰 속성에 복사할 IdP 토큰의 클레임을 지정합니다. 이 맵의 각 키에는 매핑하려는 IdP 토큰의 경로가 포함되어 있습니다. 경로는 \".\" 기호로 구분됩니다. 예를 들어 IdP 토큰 페이로드가 다음과 같은 경우 { \"a\": { \"b\" : \"c\", \"d\": true, \"e\", \"val2\", \"val3\" ], \"val3\" ], \"f\": [ true, false, false ], \"G\": 123.0, \"h\": [ 1, 2, 3] } } then \"a.b\"는 유효한 키가 되고 \"a.z\"는 유효하지 않습니다. 다음과 같은 유형의 클레임을 지원합니다. * string(path \"a.") * bool(path \"a.d\") * string array(path \"a.e\") * bool 배열(path \"a.f.\") 당사는 다음과 같은 유형의 클레임을 지원하지 않습니다. * 복잡한 클레임(path \"a\") * float/integer claims(path \"a.g\") * float/integer array claims(path \"a.h\") 이 맵의 각 값에는 클레임을 추가하려는 Rox 토큰 특성 이름이 포함되어 있습니다. 예를 들어 value가 \"groups\"인 경우 클레임은 토큰의 \"external_user.Attributes.groups\"에 있습니다. 참고: 이 기능은 OIDC 인증 공급자에 대해서만 지원합니다.

 

lastUpdated

  

날짜

마지막 업데이트됨은 인증 공급자가 마지막으로 업데이트된 시간을 나타냅니다. 이 타임스탬프 전에 인증 공급자가 발행한 토큰이 있는 경우 유효하지 않은 것으로 간주됩니다. 결과적으로 모든 클라이언트는 토큰을 다시 발행해야 합니다(새로 고침 또는 추가 로그인 시도를 통해).

날짜-시간

1.6.7.7.6. StorageServiceIdentity
필드 이름필수 항목Cryostat유형설명형식

serialStr

  

문자열

  

직렬

  

문자열

 

int64

id

  

문자열

  

type

  

StorageServiceType

 

UNKNOWN_SERVICE, SENSOR_SERVICE, CENTRAL_SERVICE, CENTRAL_DB_SERVICE, REMOTE_SERVICE, MONITORING_UI_SERVICE, MONITORING_DB_SERVICE, MONITORING_CLIENT_SERVICE, BENCHMARK_SERVICE, SCANNER_SERVICE, SCANNER_DB_SERVICE, ADMISSION_CONTROL_SERVICE, SCANNER_V4_INDEXER_SERVICE, SCANNER_V4_MATCHER_SERVICE, SCANNER_V4_SERVICE, SCANNER_V4_SERVICE, SCANNER_V4_SERVICE, SCANNER_V4_SERVICE, REGISTRANT_SERVICE

initBundleId

  

문자열

  
1.6.7.7.7. StorageServiceType
Copy to Clipboard Toggle word wrap
Next available tag: 18
  • SCANNER_V4_SERVICE: 스캐너 V4가 콤보 모드로 실행될 때 사용됩니다.
열거 값

UNKNOWN_SERVICE

SENSOR_SERVICE

CENTRAL_SERVICE

CENTRAL_DB_SERVICE

REMOTE_SERVICE

COLLECTOR_SERVICE

MONITORING_UI_SERVICE

MONITORING_DB_SERVICE

MONITORING_CLIENT_SERVICE

BENCHMARK_SERVICE

SCANNER_SERVICE

SCANNER_DB_SERVICE

ADMISSION_CONTROL_SERVICE

SCANNER_V4_INDEXER_SERVICE

SCANNER_V4_MATCHER_SERVICE

SCANNER_V4_DB_SERVICE

SCANNER_V4_SERVICE

REGISTRANT_SERVICE

1.6.7.7.8. StorageTraits
필드 이름필수 항목Cryostat유형설명형식

mutabilityMode

  

TraitsMutabilityMode

 

ALLOW_MUTATE, ALLOW_MUTATE_FORCED,

가시성

  

traditionalitsVisibility

 

표시, 숨겨진,

origin

  

traditional presentationsOrigin

 

IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED,

1.6.7.7.9. StorageUserInfo
필드 이름필수 항목Cryostat유형설명형식

사용자 이름

  

문자열

  

FriendlyName

  

문자열

  

권한

  

UserInfoResourceToAccess

  

역할

  

StorageUserInfoRole목록

  
1.6.7.7.10. StorageUserInfoRole

역할은 이전 형식의 storage.Role과 호환되므로 역할 이름 및 관련 권한만 포함됩니다.

필드 이름필수 항목Cryostat유형설명형식

name

  

문자열

  

resourceToAccess

  

StorageAccess

  
1.6.7.7.11. TraitsMutabilityMode

실험적. 참고: 시간이 지남에 따라 MutabilityMode 사용을 참조하십시오. 이는 향후 대체될 예정입니다(ROX-14276). MutabilityMode는 오브젝트를 수정할 수 있는지 여부와 방법을 지정합니다. 기본값은 ALLOW_MUTATE이며 수정 제한이 없음을 의미합니다. 이는 MutabilityMode 사양이 없는 것과 동일합니다. ALLOW_MUTATE_FORCED는 강제로 강제로 제거하는 것을 제외한 모든 수정 작업을 금지합니다.

이 필드의 상태를 변경할 때는 주의하십시오. 예를 들어 ALLOW_MUTATE에서 ALLOW_MUTATE_FORCED로 오브젝트를 수정할 수 있지만 ALLOW_MUTATE로 다시 수정하는 등 추가 변경 사항이 금지됩니다.

열거 값

ALLOW_MUTATE

ALLOW_MUTATE_FORCED

1.6.7.7.12. traditional presentationsOrigin

origin은 개체의 원본을 지정합니다. 오브젝트에는 4개의 서로 다른 원본이 있을 수 있습니다. - IMPERATIVE: 오브젝트는 API를 통해 생성되었습니다. 이는 기본적으로 가정됩니다. - DEFAULT: 오브젝트는 기본 역할, 액세스 범위 등과 같은 기본 오브젝트입니다. - DECLARATIVE: 오브젝트는 선언적 구성을 통해 생성됩니다. - DECLARATIVE_ORPHANED: 오브젝트는 선언적 구성을 통해 생성된 다음(예: 다른 오브젝트에서 참조하기 때문에) 실패로 삭제(예: 대상자 규칙)에 따라 다른 규칙을 적용합니다. DECLARATIVE 원본이 있는 오브젝트는 선언적 구성을 통해서만 API를 통해 수정할 수 없습니다. 또한 IMPERATIVE 원본과 함께 오브젝트를 참조할 수 없습니다. DEFAULT 원본이 있는 오브젝트는 API 또는 선언적 구성을 통해 수정할 수 없습니다. 다른 모든 오브젝트에서 참조할 수 있습니다. IMPERATIVE 원본이 있는 오브젝트는 선언적 구성이 아닌 API를 통해 수정할 수 있습니다. 다른 모든 개체를 참조할 수 있습니다. DECLARATIVE_ORPHANED 원본이 있는 오브젝트는 API 또는 선언적 구성을 통해 수정할 수 없습니다. DECLARATIVE_ORPHANED 리소스는 선언적 구성으로 다시 정의되면 DECLARATIVE 리소스가 될 수 있습니다. 이 원본이 있는 오브젝트는 더 이상 다른 리소스에서 참조하지 않은 직후 시스템에서 정리됩니다. 다른 모든 오브젝트에서 참조할 수 있습니다.

열거 값

IMPERATIVE

DEFAULT

DECLARATIVE

DECLARATIVE_ORPHANED

1.6.7.7.13. traditionalitsVisibility

EXPERIMENTAL. visibility를 사용하면 특정 API에 개체를 볼 수 있는지 여부를 지정할 수 있습니다.

열거 값

VISIBLE

HIDDEN

1.6.7.7.14. UserInfoResourceToAccess

ResourceToAccess는 권한 컬렉션을 나타냅니다. 이전 형식의 storage.Role과 호환되며 집계된 권한만 필요한 위치에서 교체합니다.

필드 이름필수 항목Cryostat유형설명형식

resourceToAccess

  

StorageAccess

  
1.6.7.7.15. V1AuthStatus
필드 이름필수 항목Cryostat유형설명형식

userId

  

문자열

  

serviceId

  

StorageServiceIdentity

  

만료

  

날짜

 

날짜-시간

refreshUrl

  

문자열

  

authProvider

  

StorageAuthProvider

  

userInfo

  

StorageUserInfo

  

userAttributes

  

V1UserAttribute목록

  

idpToken

  

문자열

기본 ID 공급자에 의해 ACS로 반환되는 토큰입니다. 이 필드는 몇 가지 특정 컨텍스트에서만 설정됩니다. 응답에 있는 이 필드에 의존하지 마십시오.

 
1.6.7.7.16. V1UserAttribute
필드 이름필수 항목Cryostat유형설명형식

key

  

문자열

  

  

문자열목록

  

1.7. CentralHealthService

1.7.1. GetUpgradeStatus

GET /v1/centralhealth/upgradestatus

1.7.1.1. 설명
1.7.1.2. 매개 변수
1.7.1.3. 반환 유형

V1GetUpgradeStatusResponse

1.7.1.4. 콘텐츠 유형
  • application/json
1.7.1.5. 응답
표 1.36. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1GetUpgradeStatusResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.7.1.6. Samples
1.7.1.7. 공통 오브젝트 참조
1.7.1.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.7.1.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.7.1.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.7.1.7.3. V1CentralUpgradeStatus
필드 이름필수 항목Cryostat유형설명형식

version

  

문자열

  

forceRollbackTo

  

문자열

Central에서 이전 복제본의 버전입니다. 이는 롤백을 강제 수행할 수 있는 버전입니다.

 

canRollbackAfterUpgrade

  

부울

true인 경우 업그레이드가 실패한 경우 현재 버전으로 롤백할 수 있습니다.

 

spaceRequiredForRollbackAfterUpgrade

  

문자열

 

int64

spaceAvailableForRollbackAfterUpgrade

  

문자열

 

int64

1.7.1.7.4. V1GetUpgradeStatusResponse
필드 이름필수 항목Cryostat유형설명형식

upgradeStatus

  

V1CentralUpgradeStatus

  

1.8. CloudSourcesService

1.8.1. UpdateCloudSource

PUT /v1/cloud-sources/{cloudSource.id}

UpdateCloudSource는 클라우드 소스를 생성하거나 교체합니다.

1.8.1.1. 설명
1.8.1.2. 매개 변수
1.8.1.2.1. 경로 매개변수
이름설명필수 항목기본패턴

cloudSource.id

 

X

null

 
1.8.1.2.2. 본문 매개변수
이름설명필수 항목기본패턴

body

CloudSourcesServiceUpdateCloudSourceBody

X

  
1.8.1.3. 반환 유형

개체

1.8.1.4. 콘텐츠 유형
  • application/json
1.8.1.5. 응답
표 1.37. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

개체

0

예기치 않은 오류 응답

GooglerpcStatus

1.8.1.6. Samples
1.8.1.7. 공통 오브젝트 참조
1.8.1.7.1. CloudSourcesServiceUpdateCloudSourceBody
필드 이름필수 항목Cryostat유형설명형식

cloudSource

  

CloudSourcesServiceUpdateCloudSourceBodyCloudSource

  

updateCredentials

  

부울

true인 경우 cloud_source에 유효한 인증 정보가 포함되어야 합니다. false인 경우 리소스가 이미 존재하고 cloud_source에 인증 정보가 무시됩니다.

 
1.8.1.7.2. CloudSourcesServiceUpdateCloudSourceBodyCloudSource

CloudSource는 검색된 클러스터에 대한 소스를 제공하는 통합입니다.

필드 이름필수 항목Cryostat유형설명형식

name

  

문자열

  

type

  

V1CloudSourceType

 

TYPE_UNSPECIFIED, TYPE_PALADIN_CLOUD, TYPE_OCM,

credentials

  

V1CloudSourceCredentials

  

skipTestIntegration

  

부울

  

paladinCloud

  

V1PaladinCloudConfig

  

OCM

  

V1OCMConfig

  
1.8.1.7.3. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.8.1.7.4. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.8.1.7.4.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.8.1.7.5. V1CloudSourceCredentials
필드 이름필수 항목Cryostat유형설명형식

Secret

  

문자열

장기 토큰을 통한 단일 값 인증에 사용됩니다.

 

clientId

  

문자열

client_secret과 함께 클라이언트 인증에 사용됩니다.

 

clientSecret

  

문자열

client_id와 함께 클라이언트 인증에 사용됩니다.

 
1.8.1.7.6. V1CloudSourceType
열거 값

TYPE_UNSPECIFIED

TYPE_PALADIN_CLOUD

TYPE_OCM

1.8.1.7.7. V1OCMConfig

OCMConfig는 OpenShift 클러스터 관리자에서 검색된 클러스터를 가져오는 데 필요한 정보를 제공합니다.

필드 이름필수 항목Cryostat유형설명형식

endpoint

  

문자열

  
1.8.1.7.8. V1PaladinCloudConfig

CryostatadinCloudConfig는 Cryostatadin Cloud에서 검색된 클러스터를 가져오는 데 필요한 정보를 제공합니다.

필드 이름필수 항목Cryostat유형설명형식

endpoint

  

문자열

  

1.8.2. ListCloudSources

GET /v1/cloud-sources

ListCloudSources는 요청된 필드에서 필터링한 후 클라우드 소스 목록을 반환합니다.

1.8.2.1. 설명
1.8.2.2. 매개 변수
1.8.2.2.1. 쿼리 매개변수
이름설명필수 항목기본패턴

pagination.limit

 

-

null

 

pagination.offset

 

-

null

 

pagination.sortOption.field

 

-

null

 

pagination.sortOption.reversed

 

-

null

 

pagination.sortOption.aggregateBy.aggrFunc

 

-

설정되지 않음

 

pagination.sortOption.aggregateBy.distinct

 

-

null

 

filter.names

이름에 따라 클라우드 소스를 찾습니다. 문자열

-

null

 

filter.types

유형에 따라 클라우드 소스를 일치시킵니다. 문자열

-

null

 
1.8.2.3. 반환 유형

V1ListCloudSourcesResponse

1.8.2.4. 콘텐츠 유형
  • application/json
1.8.2.5. 응답
표 1.38. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1ListCloudSourcesResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.8.2.6. Samples
1.8.2.7. 공통 오브젝트 참조
1.8.2.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.8.2.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.8.2.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.8.2.7.3. V1CloudSource

CloudSource는 검색된 클러스터에 대한 소스를 제공하는 통합입니다.

필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

type

  

V1CloudSourceType

 

TYPE_UNSPECIFIED, TYPE_PALADIN_CLOUD, TYPE_OCM,

credentials

  

V1CloudSourceCredentials

  

skipTestIntegration

  

부울

  

paladinCloud

  

V1PaladinCloudConfig

  

OCM

  

V1OCMConfig

  
1.8.2.7.4. V1CloudSourceCredentials
필드 이름필수 항목Cryostat유형설명형식

Secret

  

문자열

장기 토큰을 통한 단일 값 인증에 사용됩니다.

 

clientId

  

문자열

client_secret과 함께 클라이언트 인증에 사용됩니다.

 

clientSecret

  

문자열

client_id와 함께 클라이언트 인증에 사용됩니다.

 
1.8.2.7.5. V1CloudSourceType
열거 값

TYPE_UNSPECIFIED

TYPE_PALADIN_CLOUD

TYPE_OCM

1.8.2.7.6. V1ListCloudSourcesResponse
필드 이름필수 항목Cryostat유형설명형식

cloudSources

  

V1CloudSource목록

  
1.8.2.7.7. V1OCMConfig

OCMConfig는 OpenShift 클러스터 관리자에서 검색된 클러스터를 가져오는 데 필요한 정보를 제공합니다.

필드 이름필수 항목Cryostat유형설명형식

endpoint

  

문자열

  
1.8.2.7.8. V1PaladinCloudConfig

CryostatadinCloudConfig는 Cryostatadin Cloud에서 검색된 클러스터를 가져오는 데 필요한 정보를 제공합니다.

필드 이름필수 항목Cryostat유형설명형식

endpoint

  

문자열

  

1.8.3. DeleteCloudSource

DELETE /v1/cloud-sources/{id}

DeleteCloudSource는 클라우드 소스를 제거합니다.

1.8.3.1. 설명
1.8.3.2. 매개 변수
1.8.3.2.1. 경로 매개변수
이름설명필수 항목기본패턴

id

 

X

null

 
1.8.3.3. 반환 유형

개체

1.8.3.4. 콘텐츠 유형
  • application/json
1.8.3.5. 응답
표 1.39. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

개체

0

예기치 않은 오류 응답

GooglerpcStatus

1.8.3.6. Samples
1.8.3.7. 공통 오브젝트 참조
1.8.3.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.8.3.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.8.3.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 

1.8.4. GetCloudSource

GET /v1/cloud-sources/{id}

GetCloudSource는 ID로 클라우드 소스를 검색합니다.

1.8.4.1. 설명
1.8.4.2. 매개 변수
1.8.4.2.1. 경로 매개변수
이름설명필수 항목기본패턴

id

 

X

null

 
1.8.4.3. 반환 유형

V1GetCloudSourceResponse

1.8.4.4. 콘텐츠 유형
  • application/json
1.8.4.5. 응답
표 1.40. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1GetCloudSourceResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.8.4.6. Samples
1.8.4.7. 공통 오브젝트 참조
1.8.4.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.8.4.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.8.4.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.8.4.7.3. V1CloudSource

CloudSource는 검색된 클러스터에 대한 소스를 제공하는 통합입니다.

필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

type

  

V1CloudSourceType

 

TYPE_UNSPECIFIED, TYPE_PALADIN_CLOUD, TYPE_OCM,

credentials

  

V1CloudSourceCredentials

  

skipTestIntegration

  

부울

  

paladinCloud

  

V1PaladinCloudConfig

  

OCM

  

V1OCMConfig

  
1.8.4.7.4. V1CloudSourceCredentials
필드 이름필수 항목Cryostat유형설명형식

Secret

  

문자열

장기 토큰을 통한 단일 값 인증에 사용됩니다.

 

clientId

  

문자열

client_secret과 함께 클라이언트 인증에 사용됩니다.

 

clientSecret

  

문자열

client_id와 함께 클라이언트 인증에 사용됩니다.

 
1.8.4.7.5. V1CloudSourceType
열거 값

TYPE_UNSPECIFIED

TYPE_PALADIN_CLOUD

TYPE_OCM

1.8.4.7.6. V1GetCloudSourceResponse
필드 이름필수 항목Cryostat유형설명형식

cloudSource

  

V1CloudSource

  
1.8.4.7.7. V1OCMConfig

OCMConfig는 OpenShift 클러스터 관리자에서 검색된 클러스터를 가져오는 데 필요한 정보를 제공합니다.

필드 이름필수 항목Cryostat유형설명형식

endpoint

  

문자열

  
1.8.4.7.8. V1PaladinCloudConfig

CryostatadinCloudConfig는 Cryostatadin Cloud에서 검색된 클러스터를 가져오는 데 필요한 정보를 제공합니다.

필드 이름필수 항목Cryostat유형설명형식

endpoint

  

문자열

  

1.8.5. CreateCloudSource

POST /v1/cloud-sources

CreateCloudSource는 클라우드 소스를 생성합니다.

1.8.5.1. 설명
1.8.5.2. 매개 변수
1.8.5.2.1. 본문 매개변수
이름설명필수 항목기본패턴

body

V1CreateCloudSourceRequest

X

  
1.8.5.3. 반환 유형

V1CreateCloudSourceResponse

1.8.5.4. 콘텐츠 유형
  • application/json
1.8.5.5. 응답
표 1.41. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1CreateCloudSourceResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.8.5.6. Samples
1.8.5.7. 공통 오브젝트 참조
1.8.5.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.8.5.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.8.5.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.8.5.7.3. V1CloudSource

CloudSource는 검색된 클러스터에 대한 소스를 제공하는 통합입니다.

필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

type

  

V1CloudSourceType

 

TYPE_UNSPECIFIED, TYPE_PALADIN_CLOUD, TYPE_OCM,

credentials

  

V1CloudSourceCredentials

  

skipTestIntegration

  

부울

  

paladinCloud

  

V1PaladinCloudConfig

  

OCM

  

V1OCMConfig

  
1.8.5.7.4. V1CloudSourceCredentials
필드 이름필수 항목Cryostat유형설명형식

Secret

  

문자열

장기 토큰을 통한 단일 값 인증에 사용됩니다.

 

clientId

  

문자열

client_secret과 함께 클라이언트 인증에 사용됩니다.

 

clientSecret

  

문자열

client_id와 함께 클라이언트 인증에 사용됩니다.

 
1.8.5.7.5. V1CloudSourceType
열거 값

TYPE_UNSPECIFIED

TYPE_PALADIN_CLOUD

TYPE_OCM

1.8.5.7.6. V1CreateCloudSourceRequest
필드 이름필수 항목Cryostat유형설명형식

cloudSource

  

V1CloudSource

  
1.8.5.7.7. V1CreateCloudSourceResponse
필드 이름필수 항목Cryostat유형설명형식

cloudSource

  

V1CloudSource

  
1.8.5.7.8. V1OCMConfig

OCMConfig는 OpenShift 클러스터 관리자에서 검색된 클러스터를 가져오는 데 필요한 정보를 제공합니다.

필드 이름필수 항목Cryostat유형설명형식

endpoint

  

문자열

  
1.8.5.7.9. V1PaladinCloudConfig

CryostatadinCloudConfig는 Cryostatadin Cloud에서 검색된 클러스터를 가져오는 데 필요한 정보를 제공합니다.

필드 이름필수 항목Cryostat유형설명형식

endpoint

  

문자열

  

1.8.6. TestCloudSource

POST /v1/cloud-sources/test

TestCloudSource는 클라우드 소스를 테스트합니다.

1.8.6.1. 설명
1.8.6.2. 매개 변수
1.8.6.2.1. 본문 매개변수
이름설명필수 항목기본패턴

body

V1TestCloudSourceRequest

X

  
1.8.6.3. 반환 유형

개체

1.8.6.4. 콘텐츠 유형
  • application/json
1.8.6.5. 응답
표 1.42. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

개체

0

예기치 않은 오류 응답

GooglerpcStatus

1.8.6.6. Samples
1.8.6.7. 공통 오브젝트 참조
1.8.6.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.8.6.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.8.6.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.8.6.7.3. V1CloudSource

CloudSource는 검색된 클러스터에 대한 소스를 제공하는 통합입니다.

필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

type

  

V1CloudSourceType

 

TYPE_UNSPECIFIED, TYPE_PALADIN_CLOUD, TYPE_OCM,

credentials

  

V1CloudSourceCredentials

  

skipTestIntegration

  

부울

  

paladinCloud

  

V1PaladinCloudConfig

  

OCM

  

V1OCMConfig

  
1.8.6.7.4. V1CloudSourceCredentials
필드 이름필수 항목Cryostat유형설명형식

Secret

  

문자열

장기 토큰을 통한 단일 값 인증에 사용됩니다.

 

clientId

  

문자열

client_secret과 함께 클라이언트 인증에 사용됩니다.

 

clientSecret

  

문자열

client_id와 함께 클라이언트 인증에 사용됩니다.

 
1.8.6.7.5. V1CloudSourceType
열거 값

TYPE_UNSPECIFIED

TYPE_PALADIN_CLOUD

TYPE_OCM

1.8.6.7.6. V1OCMConfig

OCMConfig는 OpenShift 클러스터 관리자에서 검색된 클러스터를 가져오는 데 필요한 정보를 제공합니다.

필드 이름필수 항목Cryostat유형설명형식

endpoint

  

문자열

  
1.8.6.7.7. V1PaladinCloudConfig

CryostatadinCloudConfig는 Cryostatadin Cloud에서 검색된 클러스터를 가져오는 데 필요한 정보를 제공합니다.

필드 이름필수 항목Cryostat유형설명형식

endpoint

  

문자열

  
1.8.6.7.8. V1TestCloudSourceRequest
필드 이름필수 항목Cryostat유형설명형식

cloudSource

  

V1CloudSource

  

updateCredentials

  

부울

true인 경우 cloud_source에 유효한 인증 정보가 포함되어야 합니다. false인 경우 리소스가 이미 존재하고 cloud_source에 인증 정보가 무시됩니다.

 

1.8.7. CountCloudSources

GET /v1/count/cloud-sources

CountCloudSources는 요청된 필드로 필터링한 후 클라우드 소스 수를 반환합니다.

1.8.7.1. 설명
1.8.7.2. 매개 변수
1.8.7.2.1. 쿼리 매개변수
이름설명필수 항목기본패턴

filter.names

이름에 따라 클라우드 소스를 찾습니다. 문자열

-

null

 

filter.types

유형에 따라 클라우드 소스를 일치시킵니다. 문자열

-

null

 
1.8.7.3. 반환 유형

V1CountCloudSourcesResponse

1.8.7.4. 콘텐츠 유형
  • application/json
1.8.7.5. 응답
표 1.43. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1CountCloudSourcesResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.8.7.6. Samples
1.8.7.7. 공통 오브젝트 참조
1.8.7.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.8.7.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.8.7.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.8.7.7.3. V1CountCloudSourcesResponse
필드 이름필수 항목Cryostat유형설명형식

count

  

정수

 

int32

1.9. ClusterCVEService

1.9.1. SuppressCVEs

PATCH /v1/clustercves/suppress

SuppressCVE는 클러스터 cves를 비활성화합니다.

1.9.1.1. 설명
1.9.1.2. 매개 변수
1.9.1.2.1. 본문 매개변수
이름설명필수 항목기본패턴

body

V1SuppressCVERequest

X

  
1.9.1.3. 반환 유형

개체

1.9.1.4. 콘텐츠 유형
  • application/json
1.9.1.5. 응답
표 1.44. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

개체

0

예기치 않은 오류 응답

GooglerpcStatus

1.9.1.6. Samples
1.9.1.7. 공통 오브젝트 참조
1.9.1.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.9.1.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.9.1.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.9.1.7.3. V1SuppressCVERequest
필드 이름필수 항목Cryostat유형설명형식

cves

  

문자열목록

이는 (NVD) 취약점 식별자, storage cve 필드입니다.CVEid 필드가 아닙니다. 예를 들면 CVE-2021-44832입니다.

 

duration

  

문자열

JSON 형식에서 Duration 유형은 개체가 아닌 문자열로 인코딩됩니다. 여기서 문자열은 접미사 \"s\"(초 표시)로 끝나고 나노초가 소수로 표시됩니다. 예를 들어 0 나노초가 있는 3초는 \"3s\"로 JSON 형식으로 인코딩되어야 하며 3초와 1 나노초는 JSON 형식으로 \"3.000000001s\", 3초와 1 마이크로초는 JSON 형식으로 \"3.000001s\"로 표시되어야 합니다.

 

1.9.2. UnsuppressCVEs

PATCH /v1/clustercves/unsuppress

UnsuppressCVE는 클러스터 cve를 압축 해제합니다.

1.9.2.1. 설명
1.9.2.2. 매개 변수
1.9.2.2.1. 본문 매개변수
이름설명필수 항목기본패턴

body

V1UnsuppressCVERequest

X

  
1.9.2.3. 반환 유형

개체

1.9.2.4. 콘텐츠 유형
  • application/json
1.9.2.5. 응답
표 1.45. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

개체

0

예기치 않은 오류 응답

GooglerpcStatus

1.9.2.6. Samples
1.9.2.7. 공통 오브젝트 참조
1.9.2.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.9.2.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.9.2.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.9.2.7.3. V1UnsuppressCVERequest
필드 이름필수 항목Cryostat유형설명형식

cves

  

문자열목록

이는 (NVD) 취약점 식별자, storage cve 필드입니다.CVEid 필드가 아닙니다. 예를 들면 CVE-2021-44832입니다.

 

1.10. ClusterInitService

1.10.1. GetCAConfig

GET /v1/cluster-init/ca-config

1.10.1.1. 설명
1.10.1.2. 매개 변수
1.10.1.3. 반환 유형

V1GetCAConfigResponse

1.10.1.4. 콘텐츠 유형
  • application/json
1.10.1.5. 응답
표 1.46. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1GetCAConfigResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.10.1.6. Samples
1.10.1.7. 공통 오브젝트 참조
1.10.1.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.10.1.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.10.1.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.10.1.7.3. V1GetCAConfigResponse
필드 이름필수 항목Cryostat유형설명형식

helmValuesBundle

  

byte[]

 

byte

1.10.2. GetCRSs

GET /v1/cluster-init/crs

1.10.2.1. 설명
1.10.2.2. 매개 변수
1.10.2.3. 반환 유형

V1CRSMetasResponse

1.10.2.4. 콘텐츠 유형
  • application/json
1.10.2.5. 응답
표 1.47. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1CRSMetasResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.10.2.6. Samples
1.10.2.7. 공통 오브젝트 참조
1.10.2.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.10.2.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.10.2.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.10.2.7.3. StorageUser

사용자는 사용자가 연결된 역할과 로그인 방법을 추적할 수 있는 오브젝트입니다.

필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

authProviderId

  

문자열

  

속성

  

StorageUserAttribute목록

  

idpToken

  

문자열

  
1.10.2.7.4. StorageUserAttribute
필드 이름필수 항목Cryostat유형설명형식

key

  

문자열

  

value

  

문자열

  
1.10.2.7.5. V1CRSMeta
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

createdAt

  

날짜

 

날짜-시간

createdBy

  

StorageUser

  

expiresAt

  

날짜

 

날짜-시간

1.10.2.7.6. V1CRSMetasResponse
필드 이름필수 항목Cryostat유형설명형식

items

  

V1CRSMeta목록

  

1.10.3. GenerateCRS

POST /v1/cluster-init/crs

1.10.3.1. 설명
1.10.3.2. 매개 변수
1.10.3.2.1. 본문 매개변수
이름설명필수 항목기본패턴

body

V1CRSGenRequest

X

  
1.10.3.3. 반환 유형

V1CRSGenResponse

1.10.3.4. 콘텐츠 유형
  • application/json
1.10.3.5. 응답
표 1.48. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1CRSGenResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.10.3.6. Samples
1.10.3.7. 공통 오브젝트 참조
1.10.3.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.10.3.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.10.3.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.10.3.7.3. StorageUser

사용자는 사용자가 연결된 역할과 로그인 방법을 추적할 수 있는 오브젝트입니다.

필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

authProviderId

  

문자열

  

속성

  

StorageUserAttribute목록

  

idpToken

  

문자열

  
1.10.3.7.4. StorageUserAttribute
필드 이름필수 항목Cryostat유형설명형식

key

  

문자열

  

value

  

문자열

  
1.10.3.7.5. V1CRSGenRequest
필드 이름필수 항목Cryostat유형설명형식

name

  

문자열

  
1.10.3.7.6. V1CRSGenResponse
필드 이름필수 항목Cryostat유형설명형식

meta

  

V1CRSMeta

  

CR

  

byte[]

 

byte

1.10.3.7.7. V1CRSMeta
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

createdAt

  

날짜

 

날짜-시간

createdBy

  

StorageUser

  

expiresAt

  

날짜

 

날짜-시간

1.10.4. RevokeCRS

PATCH /v1/cluster-init/crs/revoke

RevokeCRSBundle은 클러스터 등록 시크릿을 삭제합니다.

1.10.4.1. 설명
1.10.4.2. 매개 변수
1.10.4.2.1. 본문 매개변수
이름설명필수 항목기본패턴

body

V1CRSRevokeRequest

X

  
1.10.4.3. 반환 유형

V1CRSRevokeResponse

1.10.4.4. 콘텐츠 유형
  • application/json
1.10.4.5. 응답
표 1.49. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1CRSRevokeResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.10.4.6. Samples
1.10.4.7. 공통 오브젝트 참조
1.10.4.7.1. CRSRevokeResponseCRSRevocationError
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

error

  

문자열

  
1.10.4.7.2. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.10.4.7.3. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.10.4.7.3.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.10.4.7.4. V1CRSRevokeRequest
필드 이름필수 항목Cryostat유형설명형식

ID

  

문자열목록

  
1.10.4.7.5. V1CRSRevokeResponse
필드 이름필수 항목Cryostat유형설명형식

crsRevocationErrors

  

CRSRevokeResponseCRSRevocationError목록

  

revokedIds

  

문자열목록

  

1.10.5. GetInitBundles

GET /v1/cluster-init/init-bundles

1.10.5.1. 설명
1.10.5.2. 매개 변수
1.10.5.3. 반환 유형

V1InitBundleMetasResponse

1.10.5.4. 콘텐츠 유형
  • application/json
1.10.5.5. 응답
표 1.50. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1InitBundleMetasResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.10.5.6. Samples
1.10.5.7. 공통 오브젝트 참조
1.10.5.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.10.5.7.2. InitBundleMetaImpactedCluster
필드 이름필수 항목Cryostat유형설명형식

name

  

문자열

  

id

  

문자열

  
1.10.5.7.3. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.10.5.7.3.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.10.5.7.4. StorageUser

사용자는 사용자가 연결된 역할과 로그인 방법을 추적할 수 있는 오브젝트입니다.

필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

authProviderId

  

문자열

  

속성

  

StorageUserAttribute목록

  

idpToken

  

문자열

  
1.10.5.7.5. StorageUserAttribute
필드 이름필수 항목Cryostat유형설명형식

key

  

문자열

  

value

  

문자열

  
1.10.5.7.6. V1InitBundleMeta
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

impactedClusters

  

InitBundleMetaImpactedCluster목록

  

createdAt

  

날짜

 

날짜-시간

createdBy

  

StorageUser

  

expiresAt

  

날짜

 

날짜-시간

1.10.5.7.7. V1InitBundleMetasResponse
필드 이름필수 항목Cryostat유형설명형식

items

  

V1InitBundleMeta목록

  

1.10.6. GenerateInitBundle

POST /v1/cluster-init/init-bundles

1.10.6.1. 설명
1.10.6.2. 매개 변수
1.10.6.2.1. 본문 매개변수
이름설명필수 항목기본패턴

body

V1InitBundleGenRequest

X

  
1.10.6.3. 반환 유형

V1InitBundleGenResponse

1.10.6.4. 콘텐츠 유형
  • application/json
1.10.6.5. 응답
표 1.51. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1InitBundleGenResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.10.6.6. Samples
1.10.6.7. 공통 오브젝트 참조
1.10.6.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.10.6.7.2. InitBundleMetaImpactedCluster
필드 이름필수 항목Cryostat유형설명형식

name

  

문자열

  

id

  

문자열

  
1.10.6.7.3. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.10.6.7.3.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.10.6.7.4. StorageUser

사용자는 사용자가 연결된 역할과 로그인 방법을 추적할 수 있는 오브젝트입니다.

필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

authProviderId

  

문자열

  

속성

  

StorageUserAttribute목록

  

idpToken

  

문자열

  
1.10.6.7.5. StorageUserAttribute
필드 이름필수 항목Cryostat유형설명형식

key

  

문자열

  

value

  

문자열

  
1.10.6.7.6. V1InitBundleGenRequest
필드 이름필수 항목Cryostat유형설명형식

name

  

문자열

  
1.10.6.7.7. V1InitBundleGenResponse
필드 이름필수 항목Cryostat유형설명형식

meta

  

V1InitBundleMeta

  

helmValuesBundle

  

byte[]

 

byte

kubectlBundle

  

byte[]

 

byte

1.10.6.7.8. V1InitBundleMeta
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

impactedClusters

  

InitBundleMetaImpactedCluster목록

  

createdAt

  

날짜

 

날짜-시간

createdBy

  

StorageUser

  

expiresAt

  

날짜

 

날짜-시간

1.10.7. RevokeInitBundle

PATCH /v1/cluster-init/init-bundles/revoke

RevokeInitBundle은 클러스터 init 번들을 삭제합니다. 이 작업이 클러스터에 영향을 미치는 경우 요청에 해당 ID를 포함해야 합니다. confirm_impacted_clusters_ids가 현재 영향을 받는 클러스터와 일치하지 않으면 영향을 받는 모든 클러스터가 포함된 오류로 인해 요청이 실패합니다.

1.10.7.1. 설명
1.10.7.2. 매개 변수
1.10.7.2.1. 본문 매개변수
이름설명필수 항목기본패턴

body

V1InitBundleRevokeRequest

X

  
1.10.7.3. 반환 유형

V1InitBundleRevokeResponse

1.10.7.4. 콘텐츠 유형
  • application/json
1.10.7.5. 응답
표 1.52. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1InitBundleRevokeResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.10.7.6. Samples
1.10.7.7. 공통 오브젝트 참조
1.10.7.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.10.7.7.2. InitBundleMetaImpactedCluster
필드 이름필수 항목Cryostat유형설명형식

name

  

문자열

  

id

  

문자열

  
1.10.7.7.3. InitBundleRevokeResponseInitBundleRevocationError
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

error

  

문자열

  

impactedClusters

  

InitBundleMetaImpactedCluster목록

  
1.10.7.7.4. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.10.7.7.4.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.10.7.7.5. V1InitBundleRevokeRequest
필드 이름필수 항목Cryostat유형설명형식

ID

  

문자열목록

  

confirmImpactedClustersIds

  

문자열목록

  
1.10.7.7.6. V1InitBundleRevokeResponse
필드 이름필수 항목Cryostat유형설명형식

initBundleRevocationErrors

  

List of InitBundleRevokeResponseInitBundleRevocationError

  

initBundleRevokedIds

  

문자열목록

  

1.11. ClustersService

1.11.1. GetClusterDefaultValues

GET /v1/cluster-defaults

1.11.1.1. 설명
1.11.1.2. 매개 변수
1.11.1.3. 반환 유형

V1ClusterDefaultsResponse

1.11.1.4. 콘텐츠 유형
  • application/json
1.11.1.5. 응답
표 1.53. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1ClusterDefaultsResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.11.1.6. Samples
1.11.1.7. 공통 오브젝트 참조
1.11.1.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.11.1.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.11.1.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.11.1.7.3. V1ClusterDefaultsResponse
필드 이름필수 항목Cryostat유형설명형식

mainImageRepository

  

문자열

  

collectorImageRepository

  

문자열

  

kernelSupportAvailable

  

부울

  

1.11.2. GetKernelSupportAvailable

GET /v1/clusters-env/kernel-support-available

GetKernelSupportAvailable은 GetClusterDefaultValues 대신 더 이상 사용되지 않습니다.

1.11.2.1. 설명
1.11.2.2. 매개 변수
1.11.2.3. 반환 유형

V1KernelSupportAvailableResponse

1.11.2.4. 콘텐츠 유형
  • application/json
1.11.2.5. 응답
표 1.54. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1KernelSupportAvailableResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.11.2.6. Samples
1.11.2.7. 공통 오브젝트 참조
1.11.2.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.11.2.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.11.2.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.11.2.7.3. V1KernelSupportAvailableResponse
필드 이름필수 항목Cryostat유형설명형식

kernelSupportAvailable

  

부울

  

1.11.3. GetClusters

GET /v1/clusters

1.11.3.1. 설명
1.11.3.2. 매개 변수
1.11.3.2.1. 쿼리 매개변수
이름설명필수 항목기본패턴

query

 

-

null

 
1.11.3.3. 반환 유형

V1ClustersList

1.11.3.4. 콘텐츠 유형
  • application/json
1.11.3.5. 응답
표 1.55. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1ClustersList

0

예기치 않은 오류 응답

GooglerpcStatus

1.11.3.6. Samples
1.11.3.7. 공통 오브젝트 참조
1.11.3.7.1. ClusterHealthStatusHealthStatusLabel
  • UNAVAILABLE: 수집기만 사용할 수 없음
열거 값

초기화되지 않음

사용할 수 없음

비정상

DEGRADED

상태

1.11.3.7.2. ClusterUpgradeStatusUpgradability
  • SENSOR_VERSION_HIGHER: SENSOR_VERSION_HIGHER는 센서가 이 Central보다 최신 버전을 실행하고 있음을 감지하면 발생합니다. 이는 예기치 않은 상황이지만 고객이 수행하는 패치에 따라 발생할 수 있습니다. 이 경우 autoupgrade 설정이 켜져 있어도 다운그레이드가 되기 때문에 센서를 자동으로 "업그레이드"하지 않습니다. 사용자는 업그레이드를 수동으로 트리거할 수 있지만 지원되지 않는 구성이므로 먼저 Central을 업그레이드하지 않고 사용하지 않는 것이 좋습니다.
열거 값

설정되지 않음

UP_TO_DATE

MANUAL_UPGRADE_REQUIRED

AUTO_UPGRADE_POSSIBLE

SENSOR_VERSION_HIGHER

1.11.3.7.3. ClusterUpgradeStatusUpgradeProcessStatus
필드 이름필수 항목Cryostat유형설명형식

활성 상태

  

부울

  

id

  

문자열

  

targetVersion

  

문자열

  

upgraderImage

  

문자열

  

initiatedAt

  

날짜

 

날짜-시간

진행 상황

  

StorageUpgradeProgress

  

type

  

UpgradeProcessStatusUpgradeProcessType

 

업그레이드, CERT_ROTATION

1.11.3.7.4. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.11.3.7.5. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.11.3.7.5.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.11.3.7.6. StorageAWSProviderMetadata
1.11.3.7.7. StorageAdmissionControlHealthInfo

AdmissionControlHealthInfo는 승인 제어 배포에 대한 데이터를 전달하지만 이 데이터에서 파생된 승인 제어 상태는 포함하지 않습니다. 집계된 승인 제어 상태는 먼저 AdmissionControlHealthInfo(sensor)를 보고하는 구성 요소가 아닌 중앙에서 파생되므로 포함되지 않습니다.

다음 필드는 오류를 가져올 때 오류가 있을 수 있고 기본값 0이 실제 값 0과 혼동될 수 있기 때문에 선택 사항/nullable이 됩니다. 특정 필드를 가져오려고 할 때 오류가 발생하는 경우 해당 필드가 없습니다(기본값이 아닌 대신).

필드 이름필수 항목Cryostat유형설명형식

totalDesiredPods

  

정수

 

int32

totalReadyPods

  

정수

 

int32

statusErrors

  

문자열목록

승인 제어 상태 정보를 가져오는 동안 발생한 오류 컬렉션입니다.

 
1.11.3.7.8. StorageAdmissionControllerConfig
필드 이름필수 항목Cryostat유형설명형식

enabled

  

부울

  

timeoutSeconds

  

정수

 

int32

scanInline

  

부울

  

disableBypass

  

부울

  

enforceOnUpdates

  

부울

  
1.11.3.7.9. StorageAuditLogFileState
Copy to Clipboard Toggle word wrap
AuditLogFileState tracks the last audit log event timestamp and ID that was collected by Compliance For internal use only
필드 이름필수 항목Cryostat유형설명형식

collectLogsSince

  

날짜

 

날짜-시간

lastAuditId

  

문자열

  
1.11.3.7.10. StorageAzureProviderMetadata
1.11.3.7.11. StorageCluster
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

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

  

Map of StorageAuditLogFileState

내부 용도로만 사용됩니다.

 

initBundleId

  

문자열

  

managedBy

  

StorageManagerType

 

MANAGER_TYPE_UNKNOWN, MANAGER_TYPE_MANUAL, MANAGER_TYPE_HELM_CHART, MANAGER_TYPE_KUBERNETES_OPERATOR,

sensorCapabilities

  

문자열목록

  
1.11.3.7.12. StorageClusterCertExpiryStatus
필드 이름필수 항목Cryostat유형설명형식

sensorCertExpiry

  

날짜

 

날짜-시간

sensorCertNotBefore

  

날짜

 

날짜-시간

1.11.3.7.13. StorageClusterHealthStatus
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

collectorHealthInfo

  

StorageCollectorHealthInfo

  

admissionControlHealthInfo

  

StorageAdmissionControlHealthInfo

  

scannerHealthInfo

  

StorageScannerHealthInfo

  

sensorHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상

collectorHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상

overallHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상

admissionControlHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상

scannerHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상

lastContact

  

날짜

상태 기능이 없는 센서의 경우 gRPC 연결 폴링으로 채워집니다. 그렇지 않으면 메시지가 처리될 때 중앙 파이프라인에 의해 이 타임스탬프가 업데이트됩니다. 참고: 이 설정을 사용하여 CRS 기반 클러스터 등록 중에 특정 공격 벡터를 방지합니다. CRS가 클러스터 A를 등록하고 CRS를 유출했다고 가정하면 공격자는 CRS-flow를 다시 실행할 수 없습니다. 그런 다음 클러스터 A에 발행된 인증서 및 키를 사용하여 공격자를 다시 실행할 수 없습니다. 카운터를 사용하면 last_contact 필드가 비어 있을 때만 CRS-flow를 다시 실행할 수 있으므로 A의 클러스터가 아직 연결되어 있지 않음을 나타냅니다.

날짜-시간

healthInfoComplete

  

부울

  
1.11.3.7.14. StorageClusterMetadata

ClusterMetadata에는 클러스터 인프라에 대한 메타데이터 정보가 포함되어 있습니다.

1.11.3.7.15. StorageClusterMetadataType
열거 값

지정되지 않음

AKS

ARO

EKS

GKE

OCP

OSD

ROSA

1.11.3.7.16. StorageClusterStatus
필드 이름필수 항목Cryostat유형설명형식

sensorVersion

  

문자열

  

DEPRECATEDLastContact

  

날짜

이 필드는 더 이상 사용되지 않는 릴리스 49.0부터 시작되었습니다. 대신 healthStatus.lastContact를 사용합니다.

날짜-시간

providerMetadata

  

StorageProviderMetadata

  

orchestratorMetadata

  

StorageOrchestratorMetadata

  

upgradeStatus

  

StorageClusterUpgradeStatus

  

certExpiryStatus

  

StorageClusterCertExpiryStatus

  
1.11.3.7.17. StorageClusterType
열거 값

GENERIC_CLUSTER

KUBERNETES_CLUSTER

OPENSHIFT_CLUSTER

OPENSHIFT4_CLUSTER

1.11.3.7.18. StorageClusterUpgradeStatus
필드 이름필수 항목Cryostat유형설명형식

upgradability

  

ClusterUpgradeStatusUpgradability

 

UNSET, UP_TO_DATE, MANUAL_UPGRADE_REQUIRED, AUTO_UPGRADE_POSSIBLE, SENSOR_VERSION_HIGHER,

upgradabilityStatusReason

  

문자열

  

mostRecentProcess

  

ClusterUpgradeStatusUpgradeProcessStatus

  
1.11.3.7.19. StorageCollectionMethod
열거 값

UNSET_COLLECTION

NO_COLLECTION

KERNEL_MODULE

EBPF

CORE_BPF

1.11.3.7.20. StorageCollectorHealthInfo

CollectorHealthInfo는 수집기 배포에 대한 데이터를 전달하지만 이 데이터에서 파생된 수집기 상태 상태는 포함하지 않습니다. 집계된 수집기 상태는 중앙에서 파생되고 먼저 CollectorHealthInfo(sensor)를 보고하는 구성 요소에서 파생되므로 포함되지 않습니다.

필드 이름필수 항목Cryostat유형설명형식

version

  

문자열

  

totalDesiredPods

  

정수

 

int32

totalReadyPods

  

정수

 

int32

totalRegisteredNodes

  

정수

 

int32

statusErrors

  

문자열목록

수집기 상태 정보를 가져오는 동안 발생한 오류 컬렉션입니다.

 
1.11.3.7.21. StorageCompleteClusterConfig

정적 및 동적 설정을 포함하여 전체 클러스터 구성을 ID/이름 식별자로 인코딩합니다.

필드 이름필수 항목Cryostat유형설명형식

dynamicConfig

  

StorageDynamicClusterConfig

  

staticConfig

  

StorageStaticClusterConfig

  

configFingerprint

  

문자열

  

clusterLabels

  

문자열

  
1.11.3.7.22. StorageDynamicClusterConfig

정적 클러스터 구성과 동적 클러스터 구성의 차이점은 Dynamic 값이 Central을 통해 Sensor gRPC 연결로 전송된다는 것입니다. 이로 인해 보안 클러스터 구성 요소를 다시 시작하지 않고 값의 "가져오기"를 허용할 수 있습니다.

필드 이름필수 항목Cryostat유형설명형식

admissionControllerConfig

  

StorageAdmissionControllerConfig

  

registryOverride

  

문자열

  

disableAuditLogs

  

부울

  
1.11.3.7.23. StorageGoogleProviderMetadata
1.11.3.7.24. StorageManagerType
열거 값

MANAGER_TYPE_UNKNOWN

MANAGER_TYPE_MANUAL

MANAGER_TYPE_HELM_CHART

MANAGER_TYPE_KUBERNETES_OPERATOR

1.11.3.7.25. StorageOrchestratorMetadata
1.11.3.7.26. StorageProviderMetadata
1.11.3.7.27. StorageScannerHealthInfo

scannerHealthInfo는 보안 클러스터("로컬 스캐너")에 배포된 스캐너 인스턴스의 상태 정보를 나타냅니다. 스캐너가 중앙 클러스터에 배포되면 다음 메시지가 사용되지 않습니다. scannerHealthInfo는 스캐너 배포에 대한 데이터를 전달하지만 이 데이터에서 파생된 스캐너 상태 상태는 포함하지 않습니다. 집계된 스캐너 상태는 중앙에서 파생되고 먼저 ScannerHealthInfo(sensor)를 보고하는 구성 요소에서 파생되므로 포함되지 않습니다.

다음 필드는 오류를 가져올 때 오류가 있을 수 있고 기본값 0이 실제 값 0과 혼동될 수 있기 때문에 선택 사항/nullable이 됩니다. 특정 필드를 가져오려고 할 때 오류가 발생하는 경우 해당 필드가 없습니다(기본값이 아닌 대신).

필드 이름필수 항목Cryostat유형설명형식

totalDesiredAnalyzerPods

  

정수

 

int32

totalReadyAnalyzerPods

  

정수

 

int32

totalDesiredDbPods

  

정수

 

int32

totalReadyDbPods

  

정수

 

int32

statusErrors

  

문자열목록

스캐너 상태 정보를 가져오는 동안 발생한 오류 컬렉션입니다.

 
1.11.3.7.28. StorageSensorDeploymentIdentification

StackRoxDeploymentIdentification은 StackRox Sensor 배포를 고유하게 식별하는 것을 목표로 합니다. 센서 연결이 다시 시작되거나 다시 생성된 센서 Pod에서 제공되는지(네트워크 파티션 후에 발생할 수 있음) 또는 다른 네임스페이스 또는 클러스터의 배포에서 제공하는 데 사용됩니다.

필드 이름필수 항목Cryostat유형설명형식

systemNamespaceId

  

문자열

  

defaultNamespaceId

  

문자열

  

appNamespace

  

문자열

  

appNamespaceId

  

문자열

  

appServiceaccountId

  

문자열

  

k8sNodeName

  

문자열

  
1.11.3.7.29. StorageStaticClusterConfig

정적 클러스터 구성과 동적 클러스터 구성의 차이점은 정적 값이 Central을 통해 Sensor gRPC 연결로 전송되지 않는다는 것입니다. 예를 들어 Secured Cluster의 k8s 구성 요소를 설정하는 데 사용할 수 있는 매니페스트를 생성하는 데 사용됩니다. 동적으로 다시 로드 되지 않습니다.

필드 이름필수 항목Cryostat유형설명형식

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

  

부울

  
1.11.3.7.30. StorageTolerationsConfig
필드 이름필수 항목Cryostat유형설명형식

비활성화됨

  

부울

  
1.11.3.7.31. StorageUpgradeProgress
필드 이름필수 항목Cryostat유형설명형식

upgradeState

  

UpgradeProgressUpgradeState

 

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

  

문자열

  

이후

  

날짜

 

날짜-시간

1.11.3.7.32. UpgradeProcessStatusUpgradeProcessType
  • UPGRADE: UPGRADE는 센서 버전 업그레이드를 나타냅니다.
  • CERT_ROTATION: CERT_ROTATION은 다른 항목을 변경하지 않고 클러스터에서 사용하는 TLS 인증서만 회전하는 업그레이드 프로세스를 나타냅니다.
열거 값

업그레이드

CERT_ROTATION

1.11.3.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

1.11.3.7.34. V1ClustersList
필드 이름필수 항목Cryostat유형설명형식

클러스터

  

스토리지 클러스터목록

  

clusterIdToRetentionInfo

  

Map of V1DecommissionedClusterRetentionInfo

  
1.11.3.7.35. V1DecommissionedClusterRetentionInfo
Copy to Clipboard Toggle word wrap
next available tag: 3
필드 이름필수 항목Cryostat유형설명형식

isExcluded

  

부울

  

daysUntilDeletion

  

정수

 

int32

1.11.4. DeleteCluster

DELETE /v1/clusters/{id}

1.11.4.1. 설명
1.11.4.2. 매개 변수
1.11.4.2.1. 경로 매개변수
이름설명필수 항목기본패턴

id

 

X

null

 
1.11.4.3. 반환 유형

개체

1.11.4.4. 콘텐츠 유형
  • application/json
1.11.4.5. 응답
표 1.56. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

개체

0

예기치 않은 오류 응답

GooglerpcStatus

1.11.4.6. Samples
1.11.4.7. 공통 오브젝트 참조
1.11.4.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.11.4.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.11.4.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 

1.11.5. GetCluster

GET /v1/clusters/{id}

1.11.5.1. 설명
1.11.5.2. 매개 변수
1.11.5.2.1. 경로 매개변수
이름설명필수 항목기본패턴

id

 

X

null

 
1.11.5.3. 반환 유형

V1ClusterResponse

1.11.5.4. 콘텐츠 유형
  • application/json
1.11.5.5. 응답
표 1.57. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1ClusterResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.11.5.6. Samples
1.11.5.7. 공통 오브젝트 참조
1.11.5.7.1. ClusterHealthStatusHealthStatusLabel
  • UNAVAILABLE: 수집기만 사용할 수 없음
열거 값

초기화되지 않음

사용할 수 없음

비정상

DEGRADED

상태

1.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

1.11.5.7.3. ClusterUpgradeStatusUpgradeProcessStatus
필드 이름필수 항목Cryostat유형설명형식

활성 상태

  

부울

  

id

  

문자열

  

targetVersion

  

문자열

  

upgraderImage

  

문자열

  

initiatedAt

  

날짜

 

날짜-시간

진행 상황

  

StorageUpgradeProgress

  

type

  

UpgradeProcessStatusUpgradeProcessType

 

업그레이드, CERT_ROTATION

1.11.5.7.4. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.11.5.7.5. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.11.5.7.5.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.11.5.7.6. StorageAWSProviderMetadata
1.11.5.7.7. StorageAdmissionControlHealthInfo

AdmissionControlHealthInfo는 승인 제어 배포에 대한 데이터를 전달하지만 이 데이터에서 파생된 승인 제어 상태는 포함하지 않습니다. 집계된 승인 제어 상태는 먼저 AdmissionControlHealthInfo(sensor)를 보고하는 구성 요소가 아닌 중앙에서 파생되므로 포함되지 않습니다.

다음 필드는 오류를 가져올 때 오류가 있을 수 있고 기본값 0이 실제 값 0과 혼동될 수 있기 때문에 선택 사항/nullable이 됩니다. 특정 필드를 가져오려고 할 때 오류가 발생하는 경우 해당 필드가 없습니다(기본값이 아닌 대신).

필드 이름필수 항목Cryostat유형설명형식

totalDesiredPods

  

정수

 

int32

totalReadyPods

  

정수

 

int32

statusErrors

  

문자열목록

승인 제어 상태 정보를 가져오는 동안 발생한 오류 컬렉션입니다.

 
1.11.5.7.8. StorageAdmissionControllerConfig
필드 이름필수 항목Cryostat유형설명형식

enabled

  

부울

  

timeoutSeconds

  

정수

 

int32

scanInline

  

부울

  

disableBypass

  

부울

  

enforceOnUpdates

  

부울

  
1.11.5.7.9. StorageAuditLogFileState
Copy to Clipboard Toggle word wrap
AuditLogFileState tracks the last audit log event timestamp and ID that was collected by Compliance For internal use only
필드 이름필수 항목Cryostat유형설명형식

collectLogsSince

  

날짜

 

날짜-시간

lastAuditId

  

문자열

  
1.11.5.7.10. StorageAzureProviderMetadata
1.11.5.7.11. StorageCluster
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

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

  

Map of StorageAuditLogFileState

내부 용도로만 사용됩니다.

 

initBundleId

  

문자열

  

managedBy

  

StorageManagerType

 

MANAGER_TYPE_UNKNOWN, MANAGER_TYPE_MANUAL, MANAGER_TYPE_HELM_CHART, MANAGER_TYPE_KUBERNETES_OPERATOR,

sensorCapabilities

  

문자열목록

  
1.11.5.7.12. StorageClusterCertExpiryStatus
필드 이름필수 항목Cryostat유형설명형식

sensorCertExpiry

  

날짜

 

날짜-시간

sensorCertNotBefore

  

날짜

 

날짜-시간

1.11.5.7.13. StorageClusterHealthStatus
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

collectorHealthInfo

  

StorageCollectorHealthInfo

  

admissionControlHealthInfo

  

StorageAdmissionControlHealthInfo

  

scannerHealthInfo

  

StorageScannerHealthInfo

  

sensorHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상

collectorHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상

overallHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상

admissionControlHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상

scannerHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상

lastContact

  

날짜

상태 기능이 없는 센서의 경우 gRPC 연결 폴링으로 채워집니다. 그렇지 않으면 메시지가 처리될 때 중앙 파이프라인에 의해 이 타임스탬프가 업데이트됩니다. 참고: 이 설정을 사용하여 CRS 기반 클러스터 등록 중에 특정 공격 벡터를 방지합니다. CRS가 클러스터 A를 등록하고 CRS를 유출했다고 가정하면 공격자는 CRS-flow를 다시 실행할 수 없습니다. 그런 다음 클러스터 A에 발행된 인증서 및 키를 사용하여 공격자를 다시 실행할 수 없습니다. 카운터를 사용하면 last_contact 필드가 비어 있을 때만 CRS-flow를 다시 실행할 수 있으므로 A의 클러스터가 아직 연결되어 있지 않음을 나타냅니다.

날짜-시간

healthInfoComplete

  

부울

  
1.11.5.7.14. StorageClusterMetadata

ClusterMetadata에는 클러스터 인프라에 대한 메타데이터 정보가 포함되어 있습니다.

1.11.5.7.15. StorageClusterMetadataType
열거 값

지정되지 않음

AKS

ARO

EKS

GKE

OCP

OSD

ROSA

1.11.5.7.16. StorageClusterStatus
필드 이름필수 항목Cryostat유형설명형식

sensorVersion

  

문자열

  

DEPRECATEDLastContact

  

날짜

이 필드는 더 이상 사용되지 않는 릴리스 49.0부터 시작되었습니다. 대신 healthStatus.lastContact를 사용합니다.

날짜-시간

providerMetadata

  

StorageProviderMetadata

  

orchestratorMetadata

  

StorageOrchestratorMetadata

  

upgradeStatus

  

StorageClusterUpgradeStatus

  

certExpiryStatus

  

StorageClusterCertExpiryStatus

  
1.11.5.7.17. StorageClusterType
열거 값

GENERIC_CLUSTER

KUBERNETES_CLUSTER

OPENSHIFT_CLUSTER

OPENSHIFT4_CLUSTER

1.11.5.7.18. StorageClusterUpgradeStatus
필드 이름필수 항목Cryostat유형설명형식

upgradability

  

ClusterUpgradeStatusUpgradability

 

UNSET, UP_TO_DATE, MANUAL_UPGRADE_REQUIRED, AUTO_UPGRADE_POSSIBLE, SENSOR_VERSION_HIGHER,

upgradabilityStatusReason

  

문자열

  

mostRecentProcess

  

ClusterUpgradeStatusUpgradeProcessStatus

  
1.11.5.7.19. StorageCollectionMethod
열거 값

UNSET_COLLECTION

NO_COLLECTION

KERNEL_MODULE

EBPF

CORE_BPF

1.11.5.7.20. StorageCollectorHealthInfo

CollectorHealthInfo는 수집기 배포에 대한 데이터를 전달하지만 이 데이터에서 파생된 수집기 상태 상태는 포함하지 않습니다. 집계된 수집기 상태는 중앙에서 파생되고 먼저 CollectorHealthInfo(sensor)를 보고하는 구성 요소에서 파생되므로 포함되지 않습니다.

필드 이름필수 항목Cryostat유형설명형식

version

  

문자열

  

totalDesiredPods

  

정수

 

int32

totalReadyPods

  

정수

 

int32

totalRegisteredNodes

  

정수

 

int32

statusErrors

  

문자열목록

수집기 상태 정보를 가져오는 동안 발생한 오류 컬렉션입니다.

 
1.11.5.7.21. StorageCompleteClusterConfig

정적 및 동적 설정을 포함하여 전체 클러스터 구성을 ID/이름 식별자로 인코딩합니다.

필드 이름필수 항목Cryostat유형설명형식

dynamicConfig

  

StorageDynamicClusterConfig

  

staticConfig

  

StorageStaticClusterConfig

  

configFingerprint

  

문자열

  

clusterLabels

  

문자열

  
1.11.5.7.22. StorageDynamicClusterConfig

정적 클러스터 구성과 동적 클러스터 구성의 차이점은 Dynamic 값이 Central을 통해 Sensor gRPC 연결로 전송된다는 것입니다. 이로 인해 보안 클러스터 구성 요소를 다시 시작하지 않고 값의 "가져오기"를 허용할 수 있습니다.

필드 이름필수 항목Cryostat유형설명형식

admissionControllerConfig

  

StorageAdmissionControllerConfig

  

registryOverride

  

문자열

  

disableAuditLogs

  

부울

  
1.11.5.7.23. StorageGoogleProviderMetadata
1.11.5.7.24. StorageManagerType
열거 값

MANAGER_TYPE_UNKNOWN

MANAGER_TYPE_MANUAL

MANAGER_TYPE_HELM_CHART

MANAGER_TYPE_KUBERNETES_OPERATOR

1.11.5.7.25. StorageOrchestratorMetadata
1.11.5.7.26. StorageProviderMetadata
1.11.5.7.27. StorageScannerHealthInfo

scannerHealthInfo는 보안 클러스터("로컬 스캐너")에 배포된 스캐너 인스턴스의 상태 정보를 나타냅니다. 스캐너가 중앙 클러스터에 배포되면 다음 메시지가 사용되지 않습니다. scannerHealthInfo는 스캐너 배포에 대한 데이터를 전달하지만 이 데이터에서 파생된 스캐너 상태 상태는 포함하지 않습니다. 집계된 스캐너 상태는 중앙에서 파생되고 먼저 ScannerHealthInfo(sensor)를 보고하는 구성 요소에서 파생되므로 포함되지 않습니다.

다음 필드는 오류를 가져올 때 오류가 있을 수 있고 기본값 0이 실제 값 0과 혼동될 수 있기 때문에 선택 사항/nullable이 됩니다. 특정 필드를 가져오려고 할 때 오류가 발생하는 경우 해당 필드가 없습니다(기본값이 아닌 대신).

필드 이름필수 항목Cryostat유형설명형식

totalDesiredAnalyzerPods

  

정수

 

int32

totalReadyAnalyzerPods

  

정수

 

int32

totalDesiredDbPods

  

정수

 

int32

totalReadyDbPods

  

정수

 

int32

statusErrors

  

문자열목록

스캐너 상태 정보를 가져오는 동안 발생한 오류 컬렉션입니다.

 
1.11.5.7.28. StorageSensorDeploymentIdentification

StackRoxDeploymentIdentification은 StackRox Sensor 배포를 고유하게 식별하는 것을 목표로 합니다. 센서 연결이 다시 시작되거나 다시 생성된 센서 Pod에서 제공되는지(네트워크 파티션 후에 발생할 수 있음) 또는 다른 네임스페이스 또는 클러스터의 배포에서 제공하는 데 사용됩니다.

필드 이름필수 항목Cryostat유형설명형식

systemNamespaceId

  

문자열

  

defaultNamespaceId

  

문자열

  

appNamespace

  

문자열

  

appNamespaceId

  

문자열

  

appServiceaccountId

  

문자열

  

k8sNodeName

  

문자열

  
1.11.5.7.29. StorageStaticClusterConfig

정적 클러스터 구성과 동적 클러스터 구성의 차이점은 정적 값이 Central을 통해 Sensor gRPC 연결로 전송되지 않는다는 것입니다. 예를 들어 Secured Cluster의 k8s 구성 요소를 설정하는 데 사용할 수 있는 매니페스트를 생성하는 데 사용됩니다. 동적으로 다시 로드 되지 않습니다.

필드 이름필수 항목Cryostat유형설명형식

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

  

부울

  
1.11.5.7.30. StorageTolerationsConfig
필드 이름필수 항목Cryostat유형설명형식

비활성화됨

  

부울

  
1.11.5.7.31. StorageUpgradeProgress
필드 이름필수 항목Cryostat유형설명형식

upgradeState

  

UpgradeProgressUpgradeState

 

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

  

문자열

  

이후

  

날짜

 

날짜-시간

1.11.5.7.32. UpgradeProcessStatusUpgradeProcessType
  • UPGRADE: UPGRADE는 센서 버전 업그레이드를 나타냅니다.
  • CERT_ROTATION: CERT_ROTATION은 다른 항목을 변경하지 않고 클러스터에서 사용하는 TLS 인증서만 회전하는 업그레이드 프로세스를 나타냅니다.
열거 값

업그레이드

CERT_ROTATION

1.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

1.11.5.7.34. V1ClusterResponse
필드 이름필수 항목Cryostat유형설명형식

cluster

  

StorageCluster

  

clusterRetentionInfo

  

V1DecommissionedClusterRetentionInfo

  
1.11.5.7.35. V1DecommissionedClusterRetentionInfo
Copy to Clipboard Toggle word wrap
next available tag: 3
필드 이름필수 항목Cryostat유형설명형식

isExcluded

  

부울

  

daysUntilDeletion

  

정수

 

int32

1.11.6. PutCluster

PUT /v1/clusters/{id}

1.11.6.1. 설명
1.11.6.2. 매개 변수
1.11.6.2.1. 경로 매개변수
이름설명필수 항목기본패턴

id

 

X

null

 
1.11.6.2.2. 본문 매개변수
이름설명필수 항목기본패턴

body

ClustersServicePutClusterBody

X

  
1.11.6.3. 반환 유형

V1ClusterResponse

1.11.6.4. 콘텐츠 유형
  • application/json
1.11.6.5. 응답
표 1.58. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1ClusterResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.11.6.6. Samples
1.11.6.7. 공통 오브젝트 참조
1.11.6.7.1. ClusterHealthStatusHealthStatusLabel
  • UNAVAILABLE: 수집기만 사용할 수 없음
열거 값

초기화되지 않음

사용할 수 없음

비정상

DEGRADED

상태

1.11.6.7.2. ClusterUpgradeStatusUpgradability
  • SENSOR_VERSION_HIGHER: SENSOR_VERSION_HIGHER는 센서가 이 Central보다 최신 버전을 실행하고 있음을 감지하면 발생합니다. 이는 예기치 않은 상황이지만 고객이 수행하는 패치에 따라 발생할 수 있습니다. 이 경우 autoupgrade 설정이 켜져 있어도 다운그레이드가 되기 때문에 센서를 자동으로 "업그레이드"하지 않습니다. 사용자는 업그레이드를 수동으로 트리거할 수 있지만 지원되지 않는 구성이므로 먼저 Central을 업그레이드하지 않고 사용하지 않는 것이 좋습니다.
열거 값

설정되지 않음

UP_TO_DATE

MANUAL_UPGRADE_REQUIRED

AUTO_UPGRADE_POSSIBLE

SENSOR_VERSION_HIGHER

1.11.6.7.3. ClusterUpgradeStatusUpgradeProcessStatus
필드 이름필수 항목Cryostat유형설명형식

활성 상태

  

부울

  

id

  

문자열

  

targetVersion

  

문자열

  

upgraderImage

  

문자열

  

initiatedAt

  

날짜

 

날짜-시간

진행 상황

  

StorageUpgradeProgress

  

type

  

UpgradeProcessStatusUpgradeProcessType

 

업그레이드, CERT_ROTATION

1.11.6.7.4. ClustersServicePutClusterBody
필드 이름필수 항목Cryostat유형설명형식

name

  

문자열

  

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

  

Map of StorageAuditLogFileState

내부 용도로만 사용됩니다.

 

initBundleId

  

문자열

  

managedBy

  

StorageManagerType

 

MANAGER_TYPE_UNKNOWN, MANAGER_TYPE_MANUAL, MANAGER_TYPE_HELM_CHART, MANAGER_TYPE_KUBERNETES_OPERATOR,

sensorCapabilities

  

문자열목록

  
1.11.6.7.5. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.11.6.7.6. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.11.6.7.6.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.11.6.7.7. StorageAWSProviderMetadata
1.11.6.7.8. StorageAdmissionControlHealthInfo

AdmissionControlHealthInfo는 승인 제어 배포에 대한 데이터를 전달하지만 이 데이터에서 파생된 승인 제어 상태는 포함하지 않습니다. 집계된 승인 제어 상태는 먼저 AdmissionControlHealthInfo(sensor)를 보고하는 구성 요소가 아닌 중앙에서 파생되므로 포함되지 않습니다.

다음 필드는 오류를 가져올 때 오류가 있을 수 있고 기본값 0이 실제 값 0과 혼동될 수 있기 때문에 선택 사항/nullable이 됩니다. 특정 필드를 가져오려고 할 때 오류가 발생하는 경우 해당 필드가 없습니다(기본값이 아닌 대신).

필드 이름필수 항목Cryostat유형설명형식

totalDesiredPods

  

정수

 

int32

totalReadyPods

  

정수

 

int32

statusErrors

  

문자열목록

승인 제어 상태 정보를 가져오는 동안 발생한 오류 컬렉션입니다.

 
1.11.6.7.9. StorageAdmissionControllerConfig
필드 이름필수 항목Cryostat유형설명형식

enabled

  

부울

  

timeoutSeconds

  

정수

 

int32

scanInline

  

부울

  

disableBypass

  

부울

  

enforceOnUpdates

  

부울

  
1.11.6.7.10. StorageAuditLogFileState
Copy to Clipboard Toggle word wrap
AuditLogFileState tracks the last audit log event timestamp and ID that was collected by Compliance For internal use only
필드 이름필수 항목Cryostat유형설명형식

collectLogsSince

  

날짜

 

날짜-시간

lastAuditId

  

문자열

  
1.11.6.7.11. StorageAzureProviderMetadata
1.11.6.7.12. StorageCluster
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

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

  

Map of StorageAuditLogFileState

내부 용도로만 사용됩니다.

 

initBundleId

  

문자열

  

managedBy

  

StorageManagerType

 

MANAGER_TYPE_UNKNOWN, MANAGER_TYPE_MANUAL, MANAGER_TYPE_HELM_CHART, MANAGER_TYPE_KUBERNETES_OPERATOR,

sensorCapabilities

  

문자열목록

  
1.11.6.7.13. StorageClusterCertExpiryStatus
필드 이름필수 항목Cryostat유형설명형식

sensorCertExpiry

  

날짜

 

날짜-시간

sensorCertNotBefore

  

날짜

 

날짜-시간

1.11.6.7.14. StorageClusterHealthStatus
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

collectorHealthInfo

  

StorageCollectorHealthInfo

  

admissionControlHealthInfo

  

StorageAdmissionControlHealthInfo

  

scannerHealthInfo

  

StorageScannerHealthInfo

  

sensorHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상

collectorHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상

overallHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상

admissionControlHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상

scannerHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상

lastContact

  

날짜

상태 기능이 없는 센서의 경우 gRPC 연결 폴링으로 채워집니다. 그렇지 않으면 메시지가 처리될 때 중앙 파이프라인에 의해 이 타임스탬프가 업데이트됩니다. 참고: 이 설정을 사용하여 CRS 기반 클러스터 등록 중에 특정 공격 벡터를 방지합니다. CRS가 클러스터 A를 등록하고 CRS를 유출했다고 가정하면 공격자는 CRS-flow를 다시 실행할 수 없습니다. 그런 다음 클러스터 A에 발행된 인증서 및 키를 사용하여 공격자를 다시 실행할 수 없습니다. 카운터를 사용하면 last_contact 필드가 비어 있을 때만 CRS-flow를 다시 실행할 수 있으므로 A의 클러스터가 아직 연결되어 있지 않음을 나타냅니다.

날짜-시간

healthInfoComplete

  

부울

  
1.11.6.7.15. StorageClusterMetadata

ClusterMetadata에는 클러스터 인프라에 대한 메타데이터 정보가 포함되어 있습니다.

1.11.6.7.16. StorageClusterMetadataType
열거 값

지정되지 않음

AKS

ARO

EKS

GKE

OCP

OSD

ROSA

1.11.6.7.17. StorageClusterStatus
필드 이름필수 항목Cryostat유형설명형식

sensorVersion

  

문자열

  

DEPRECATEDLastContact

  

날짜

이 필드는 더 이상 사용되지 않는 릴리스 49.0부터 시작되었습니다. 대신 healthStatus.lastContact를 사용합니다.

날짜-시간

providerMetadata

  

StorageProviderMetadata

  

orchestratorMetadata

  

StorageOrchestratorMetadata

  

upgradeStatus

  

StorageClusterUpgradeStatus

  

certExpiryStatus

  

StorageClusterCertExpiryStatus

  
1.11.6.7.18. StorageClusterType
열거 값

GENERIC_CLUSTER

KUBERNETES_CLUSTER

OPENSHIFT_CLUSTER

OPENSHIFT4_CLUSTER

1.11.6.7.19. StorageClusterUpgradeStatus
필드 이름필수 항목Cryostat유형설명형식

upgradability

  

ClusterUpgradeStatusUpgradability

 

UNSET, UP_TO_DATE, MANUAL_UPGRADE_REQUIRED, AUTO_UPGRADE_POSSIBLE, SENSOR_VERSION_HIGHER,

upgradabilityStatusReason

  

문자열

  

mostRecentProcess

  

ClusterUpgradeStatusUpgradeProcessStatus

  
1.11.6.7.20. StorageCollectionMethod
열거 값

UNSET_COLLECTION

NO_COLLECTION

KERNEL_MODULE

EBPF

CORE_BPF

1.11.6.7.21. StorageCollectorHealthInfo

CollectorHealthInfo는 수집기 배포에 대한 데이터를 전달하지만 이 데이터에서 파생된 수집기 상태 상태는 포함하지 않습니다. 집계된 수집기 상태는 중앙에서 파생되고 먼저 CollectorHealthInfo(sensor)를 보고하는 구성 요소에서 파생되므로 포함되지 않습니다.

필드 이름필수 항목Cryostat유형설명형식

version

  

문자열

  

totalDesiredPods

  

정수

 

int32

totalReadyPods

  

정수

 

int32

totalRegisteredNodes

  

정수

 

int32

statusErrors

  

문자열목록

수집기 상태 정보를 가져오는 동안 발생한 오류 컬렉션입니다.

 
1.11.6.7.22. StorageCompleteClusterConfig

정적 및 동적 설정을 포함하여 전체 클러스터 구성을 ID/이름 식별자로 인코딩합니다.

필드 이름필수 항목Cryostat유형설명형식

dynamicConfig

  

StorageDynamicClusterConfig

  

staticConfig

  

StorageStaticClusterConfig

  

configFingerprint

  

문자열

  

clusterLabels

  

문자열

  
1.11.6.7.23. StorageDynamicClusterConfig

정적 클러스터 구성과 동적 클러스터 구성의 차이점은 Dynamic 값이 Central을 통해 Sensor gRPC 연결로 전송된다는 것입니다. 이로 인해 보안 클러스터 구성 요소를 다시 시작하지 않고 값의 "가져오기"를 허용할 수 있습니다.

필드 이름필수 항목Cryostat유형설명형식

admissionControllerConfig

  

StorageAdmissionControllerConfig

  

registryOverride

  

문자열

  

disableAuditLogs

  

부울

  
1.11.6.7.24. StorageGoogleProviderMetadata
1.11.6.7.25. StorageManagerType
열거 값

MANAGER_TYPE_UNKNOWN

MANAGER_TYPE_MANUAL

MANAGER_TYPE_HELM_CHART

MANAGER_TYPE_KUBERNETES_OPERATOR

1.11.6.7.26. StorageOrchestratorMetadata
1.11.6.7.27. StorageProviderMetadata
1.11.6.7.28. StorageScannerHealthInfo

scannerHealthInfo는 보안 클러스터("로컬 스캐너")에 배포된 스캐너 인스턴스의 상태 정보를 나타냅니다. 스캐너가 중앙 클러스터에 배포되면 다음 메시지가 사용되지 않습니다. scannerHealthInfo는 스캐너 배포에 대한 데이터를 전달하지만 이 데이터에서 파생된 스캐너 상태 상태는 포함하지 않습니다. 집계된 스캐너 상태는 중앙에서 파생되고 먼저 ScannerHealthInfo(sensor)를 보고하는 구성 요소에서 파생되므로 포함되지 않습니다.

다음 필드는 오류를 가져올 때 오류가 있을 수 있고 기본값 0이 실제 값 0과 혼동될 수 있기 때문에 선택 사항/nullable이 됩니다. 특정 필드를 가져오려고 할 때 오류가 발생하는 경우 해당 필드가 없습니다(기본값이 아닌 대신).

필드 이름필수 항목Cryostat유형설명형식

totalDesiredAnalyzerPods

  

정수

 

int32

totalReadyAnalyzerPods

  

정수

 

int32

totalDesiredDbPods

  

정수

 

int32

totalReadyDbPods

  

정수

 

int32

statusErrors

  

문자열목록

스캐너 상태 정보를 가져오는 동안 발생한 오류 컬렉션입니다.

 
1.11.6.7.29. StorageSensorDeploymentIdentification

StackRoxDeploymentIdentification은 StackRox Sensor 배포를 고유하게 식별하는 것을 목표로 합니다. 센서 연결이 다시 시작되거나 다시 생성된 센서 Pod에서 제공되는지(네트워크 파티션 후에 발생할 수 있음) 또는 다른 네임스페이스 또는 클러스터의 배포에서 제공하는 데 사용됩니다.

필드 이름필수 항목Cryostat유형설명형식

systemNamespaceId

  

문자열

  

defaultNamespaceId

  

문자열

  

appNamespace

  

문자열

  

appNamespaceId

  

문자열

  

appServiceaccountId

  

문자열

  

k8sNodeName

  

문자열

  
1.11.6.7.30. StorageStaticClusterConfig

정적 클러스터 구성과 동적 클러스터 구성의 차이점은 정적 값이 Central을 통해 Sensor gRPC 연결로 전송되지 않는다는 것입니다. 예를 들어 Secured Cluster의 k8s 구성 요소를 설정하는 데 사용할 수 있는 매니페스트를 생성하는 데 사용됩니다. 동적으로 다시 로드 되지 않습니다.

필드 이름필수 항목Cryostat유형설명형식

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

  

부울

  
1.11.6.7.31. StorageTolerationsConfig
필드 이름필수 항목Cryostat유형설명형식

비활성화됨

  

부울

  
1.11.6.7.32. StorageUpgradeProgress
필드 이름필수 항목Cryostat유형설명형식

upgradeState

  

UpgradeProgressUpgradeState

 

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

  

문자열

  

이후

  

날짜

 

날짜-시간

1.11.6.7.33. UpgradeProcessStatusUpgradeProcessType
  • UPGRADE: UPGRADE는 센서 버전 업그레이드를 나타냅니다.
  • CERT_ROTATION: CERT_ROTATION은 다른 항목을 변경하지 않고 클러스터에서 사용하는 TLS 인증서만 회전하는 업그레이드 프로세스를 나타냅니다.
열거 값

업그레이드

CERT_ROTATION

1.11.6.7.34. 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

1.11.6.7.35. V1ClusterResponse
필드 이름필수 항목Cryostat유형설명형식

cluster

  

StorageCluster

  

clusterRetentionInfo

  

V1DecommissionedClusterRetentionInfo

  
1.11.6.7.36. V1DecommissionedClusterRetentionInfo
Copy to Clipboard Toggle word wrap
next available tag: 3
필드 이름필수 항목Cryostat유형설명형식

isExcluded

  

부울

  

daysUntilDeletion

  

정수

 

int32

1.11.7. PostCluster

POST /v1/clusters

1.11.7.1. 설명
1.11.7.2. 매개 변수
1.11.7.2.1. 본문 매개변수
이름설명필수 항목기본패턴

body

StorageCluster

X

  
1.11.7.3. 반환 유형

V1ClusterResponse

1.11.7.4. 콘텐츠 유형
  • application/json
1.11.7.5. 응답
표 1.59. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1ClusterResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.11.7.6. Samples
1.11.7.7. 공통 오브젝트 참조
1.11.7.7.1. ClusterHealthStatusHealthStatusLabel
  • UNAVAILABLE: 수집기만 사용할 수 없음
열거 값

초기화되지 않음

사용할 수 없음

비정상

DEGRADED

상태

1.11.7.7.2. ClusterUpgradeStatusUpgradability
  • SENSOR_VERSION_HIGHER: SENSOR_VERSION_HIGHER는 센서가 이 Central보다 최신 버전을 실행하고 있음을 감지하면 발생합니다. 이는 예기치 않은 상황이지만 고객이 수행하는 패치에 따라 발생할 수 있습니다. 이 경우 autoupgrade 설정이 켜져 있어도 다운그레이드가 되기 때문에 센서를 자동으로 "업그레이드"하지 않습니다. 사용자는 업그레이드를 수동으로 트리거할 수 있지만 지원되지 않는 구성이므로 먼저 Central을 업그레이드하지 않고 사용하지 않는 것이 좋습니다.
열거 값

설정되지 않음

UP_TO_DATE

MANUAL_UPGRADE_REQUIRED

AUTO_UPGRADE_POSSIBLE

SENSOR_VERSION_HIGHER

1.11.7.7.3. ClusterUpgradeStatusUpgradeProcessStatus
필드 이름필수 항목Cryostat유형설명형식

활성 상태

  

부울

  

id

  

문자열

  

targetVersion

  

문자열

  

upgraderImage

  

문자열

  

initiatedAt

  

날짜

 

날짜-시간

진행 상황

  

StorageUpgradeProgress

  

type

  

UpgradeProcessStatusUpgradeProcessType

 

업그레이드, CERT_ROTATION

1.11.7.7.4. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.11.7.7.5. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.11.7.7.5.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.11.7.7.6. StorageAWSProviderMetadata
1.11.7.7.7. StorageAdmissionControlHealthInfo

AdmissionControlHealthInfo는 승인 제어 배포에 대한 데이터를 전달하지만 이 데이터에서 파생된 승인 제어 상태는 포함하지 않습니다. 집계된 승인 제어 상태는 먼저 AdmissionControlHealthInfo(sensor)를 보고하는 구성 요소가 아닌 중앙에서 파생되므로 포함되지 않습니다.

다음 필드는 오류를 가져올 때 오류가 있을 수 있고 기본값 0이 실제 값 0과 혼동될 수 있기 때문에 선택 사항/nullable이 됩니다. 특정 필드를 가져오려고 할 때 오류가 발생하는 경우 해당 필드가 없습니다(기본값이 아닌 대신).

필드 이름필수 항목Cryostat유형설명형식

totalDesiredPods

  

정수

 

int32

totalReadyPods

  

정수

 

int32

statusErrors

  

문자열목록

승인 제어 상태 정보를 가져오는 동안 발생한 오류 컬렉션입니다.

 
1.11.7.7.8. StorageAdmissionControllerConfig
필드 이름필수 항목Cryostat유형설명형식

enabled

  

부울

  

timeoutSeconds

  

정수

 

int32

scanInline

  

부울

  

disableBypass

  

부울

  

enforceOnUpdates

  

부울

  
1.11.7.7.9. StorageAuditLogFileState
Copy to Clipboard Toggle word wrap
AuditLogFileState tracks the last audit log event timestamp and ID that was collected by Compliance For internal use only
필드 이름필수 항목Cryostat유형설명형식

collectLogsSince

  

날짜

 

날짜-시간

lastAuditId

  

문자열

  
1.11.7.7.10. StorageAzureProviderMetadata
1.11.7.7.11. StorageCluster
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

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

  

Map of StorageAuditLogFileState

내부 용도로만 사용됩니다.

 

initBundleId

  

문자열

  

managedBy

  

StorageManagerType

 

MANAGER_TYPE_UNKNOWN, MANAGER_TYPE_MANUAL, MANAGER_TYPE_HELM_CHART, MANAGER_TYPE_KUBERNETES_OPERATOR,

sensorCapabilities

  

문자열목록

  
1.11.7.7.12. StorageClusterCertExpiryStatus
필드 이름필수 항목Cryostat유형설명형식

sensorCertExpiry

  

날짜

 

날짜-시간

sensorCertNotBefore

  

날짜

 

날짜-시간

1.11.7.7.13. StorageClusterHealthStatus
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

collectorHealthInfo

  

StorageCollectorHealthInfo

  

admissionControlHealthInfo

  

StorageAdmissionControlHealthInfo

  

scannerHealthInfo

  

StorageScannerHealthInfo

  

sensorHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상

collectorHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상

overallHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상

admissionControlHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상

scannerHealthStatus

  

ClusterHealthStatusHealthStatusLabel

 

초기화되지 않음, 사용할 수 없음, 비정상, 성능이 저하됨, 정상

lastContact

  

날짜

상태 기능이 없는 센서의 경우 gRPC 연결 폴링으로 채워집니다. 그렇지 않으면 메시지가 처리될 때 중앙 파이프라인에 의해 이 타임스탬프가 업데이트됩니다. 참고: 이 설정을 사용하여 CRS 기반 클러스터 등록 중에 특정 공격 벡터를 방지합니다. CRS가 클러스터 A를 등록하고 CRS를 유출했다고 가정하면 공격자는 CRS-flow를 다시 실행할 수 없습니다. 그런 다음 클러스터 A에 발행된 인증서 및 키를 사용하여 공격자를 다시 실행할 수 없습니다. 카운터를 사용하면 last_contact 필드가 비어 있을 때만 CRS-flow를 다시 실행할 수 있으므로 A의 클러스터가 아직 연결되어 있지 않음을 나타냅니다.

날짜-시간

healthInfoComplete

  

부울

  
1.11.7.7.14. StorageClusterMetadata

ClusterMetadata에는 클러스터 인프라에 대한 메타데이터 정보가 포함되어 있습니다.

1.11.7.7.15. StorageClusterMetadataType
열거 값

지정되지 않음

AKS

ARO

EKS

GKE

OCP

OSD

ROSA

1.11.7.7.16. StorageClusterStatus
필드 이름필수 항목Cryostat유형설명형식

sensorVersion

  

문자열

  

DEPRECATEDLastContact

  

날짜

이 필드는 더 이상 사용되지 않는 릴리스 49.0부터 시작되었습니다. 대신 healthStatus.lastContact를 사용합니다.

날짜-시간

providerMetadata

  

StorageProviderMetadata

  

orchestratorMetadata

  

StorageOrchestratorMetadata

  

upgradeStatus

  

StorageClusterUpgradeStatus

  

certExpiryStatus

  

StorageClusterCertExpiryStatus

  
1.11.7.7.17. StorageClusterType
열거 값

GENERIC_CLUSTER

KUBERNETES_CLUSTER

OPENSHIFT_CLUSTER

OPENSHIFT4_CLUSTER

1.11.7.7.18. StorageClusterUpgradeStatus
필드 이름필수 항목Cryostat유형설명형식

upgradability

  

ClusterUpgradeStatusUpgradability

 

UNSET, UP_TO_DATE, MANUAL_UPGRADE_REQUIRED, AUTO_UPGRADE_POSSIBLE, SENSOR_VERSION_HIGHER,

upgradabilityStatusReason

  

문자열

  

mostRecentProcess

  

ClusterUpgradeStatusUpgradeProcessStatus

  
1.11.7.7.19. StorageCollectionMethod
열거 값

UNSET_COLLECTION

NO_COLLECTION

KERNEL_MODULE

EBPF

CORE_BPF

1.11.7.7.20. StorageCollectorHealthInfo

CollectorHealthInfo는 수집기 배포에 대한 데이터를 전달하지만 이 데이터에서 파생된 수집기 상태 상태는 포함하지 않습니다. 집계된 수집기 상태는 중앙에서 파생되고 먼저 CollectorHealthInfo(sensor)를 보고하는 구성 요소에서 파생되므로 포함되지 않습니다.

필드 이름필수 항목Cryostat유형설명형식

version

  

문자열

  

totalDesiredPods

  

정수

 

int32

totalReadyPods

  

정수

 

int32

totalRegisteredNodes

  

정수

 

int32

statusErrors

  

문자열목록

수집기 상태 정보를 가져오는 동안 발생한 오류 컬렉션입니다.

 
1.11.7.7.21. StorageCompleteClusterConfig

정적 및 동적 설정을 포함하여 전체 클러스터 구성을 ID/이름 식별자로 인코딩합니다.

필드 이름필수 항목Cryostat유형설명형식

dynamicConfig

  

StorageDynamicClusterConfig

  

staticConfig

  

StorageStaticClusterConfig

  

configFingerprint

  

문자열

  

clusterLabels

  

문자열

  
1.11.7.7.22. StorageDynamicClusterConfig

정적 클러스터 구성과 동적 클러스터 구성의 차이점은 Dynamic 값이 Central을 통해 Sensor gRPC 연결로 전송된다는 것입니다. 이로 인해 보안 클러스터 구성 요소를 다시 시작하지 않고 값의 "가져오기"를 허용할 수 있습니다.

필드 이름필수 항목Cryostat유형설명형식

admissionControllerConfig

  

StorageAdmissionControllerConfig

  

registryOverride

  

문자열

  

disableAuditLogs

  

부울

  
1.11.7.7.23. StorageGoogleProviderMetadata
1.11.7.7.24. StorageManagerType
열거 값

MANAGER_TYPE_UNKNOWN

MANAGER_TYPE_MANUAL

MANAGER_TYPE_HELM_CHART

MANAGER_TYPE_KUBERNETES_OPERATOR

1.11.7.7.25. StorageOrchestratorMetadata
1.11.7.7.26. StorageProviderMetadata
1.11.7.7.27. StorageScannerHealthInfo

scannerHealthInfo는 보안 클러스터("로컬 스캐너")에 배포된 스캐너 인스턴스의 상태 정보를 나타냅니다. 스캐너가 중앙 클러스터에 배포되면 다음 메시지가 사용되지 않습니다. scannerHealthInfo는 스캐너 배포에 대한 데이터를 전달하지만 이 데이터에서 파생된 스캐너 상태 상태는 포함하지 않습니다. 집계된 스캐너 상태는 중앙에서 파생되고 먼저 ScannerHealthInfo(sensor)를 보고하는 구성 요소에서 파생되므로 포함되지 않습니다.

다음 필드는 오류를 가져올 때 오류가 있을 수 있고 기본값 0이 실제 값 0과 혼동될 수 있기 때문에 선택 사항/nullable이 됩니다. 특정 필드를 가져오려고 할 때 오류가 발생하는 경우 해당 필드가 없습니다(기본값이 아닌 대신).

필드 이름필수 항목Cryostat유형설명형식

totalDesiredAnalyzerPods

  

정수

 

int32

totalReadyAnalyzerPods

  

정수

 

int32

totalDesiredDbPods

  

정수

 

int32

totalReadyDbPods

  

정수

 

int32

statusErrors

  

문자열목록

스캐너 상태 정보를 가져오는 동안 발생한 오류 컬렉션입니다.

 
1.11.7.7.28. StorageSensorDeploymentIdentification

StackRoxDeploymentIdentification은 StackRox Sensor 배포를 고유하게 식별하는 것을 목표로 합니다. 센서 연결이 다시 시작되거나 다시 생성된 센서 Pod에서 제공되는지(네트워크 파티션 후에 발생할 수 있음) 또는 다른 네임스페이스 또는 클러스터의 배포에서 제공하는 데 사용됩니다.

필드 이름필수 항목Cryostat유형설명형식

systemNamespaceId

  

문자열

  

defaultNamespaceId

  

문자열

  

appNamespace

  

문자열

  

appNamespaceId

  

문자열

  

appServiceaccountId

  

문자열

  

k8sNodeName

  

문자열

  
1.11.7.7.29. StorageStaticClusterConfig

정적 클러스터 구성과 동적 클러스터 구성의 차이점은 정적 값이 Central을 통해 Sensor gRPC 연결로 전송되지 않는다는 것입니다. 예를 들어 Secured Cluster의 k8s 구성 요소를 설정하는 데 사용할 수 있는 매니페스트를 생성하는 데 사용됩니다. 동적으로 다시 로드 되지 않습니다.

필드 이름필수 항목Cryostat유형설명형식

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

  

부울

  
1.11.7.7.30. StorageTolerationsConfig
필드 이름필수 항목Cryostat유형설명형식

비활성화됨

  

부울

  
1.11.7.7.31. StorageUpgradeProgress
필드 이름필수 항목Cryostat유형설명형식

upgradeState

  

UpgradeProgressUpgradeState

 

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

  

문자열

  

이후

  

날짜

 

날짜-시간

1.11.7.7.32. UpgradeProcessStatusUpgradeProcessType
  • UPGRADE: UPGRADE는 센서 버전 업그레이드를 나타냅니다.
  • CERT_ROTATION: CERT_ROTATION은 다른 항목을 변경하지 않고 클러스터에서 사용하는 TLS 인증서만 회전하는 업그레이드 프로세스를 나타냅니다.
열거 값

업그레이드

CERT_ROTATION

1.11.7.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

1.11.7.7.34. V1ClusterResponse
필드 이름필수 항목Cryostat유형설명형식

cluster

  

StorageCluster

  

clusterRetentionInfo

  

V1DecommissionedClusterRetentionInfo

  
1.11.7.7.35. V1DecommissionedClusterRetentionInfo
Copy to Clipboard Toggle word wrap
next available tag: 3
필드 이름필수 항목Cryostat유형설명형식

isExcluded

  

부울

  

daysUntilDeletion

  

정수

 

int32

1.12. CollectionService

1.12.1. GetCollectionCount

GET /v1/collectionscount

1.12.1.1. 설명
1.12.1.2. 매개 변수
1.12.1.2.1. 쿼리 매개변수
이름설명필수 항목기본패턴

query.query

 

-

null

 

query.pagination.limit

 

-

null

 

query.pagination.offset

 

-

null

 

query.pagination.sortOption.field

 

-

null

 

query.pagination.sortOption.reversed

 

-

null

 

query.pagination.sortOption.aggregateBy.aggrFunc

 

-

설정되지 않음

 

query.pagination.sortOption.aggregateBy.distinct

 

-

null

 
1.12.1.3. 반환 유형

V1GetCollectionCountResponse

1.12.1.4. 콘텐츠 유형
  • application/json
1.12.1.5. 응답
표 1.60. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1GetCollectionCountResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.12.1.6. Samples
1.12.1.7. 공통 오브젝트 참조
1.12.1.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.12.1.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.12.1.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.12.1.7.3. V1GetCollectionCountResponse
필드 이름필수 항목Cryostat유형설명형식

count

  

정수

 

int32

1.12.2. DryRunCollection

POST /v1/collections/dryrun

1.12.2.1. 설명
1.12.2.2. 매개 변수
1.12.2.2.1. 본문 매개변수
이름설명필수 항목기본패턴

body

V1DryRunCollectionRequest

X

  
1.12.2.3. 반환 유형

V1DryRunCollectionResponse

1.12.2.4. 콘텐츠 유형
  • application/json
1.12.2.5. 응답
표 1.61. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1DryRunCollectionResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.12.2.6. Samples
1.12.2.7. 공통 오브젝트 참조
1.12.2.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.12.2.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.12.2.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.12.2.7.3. StorageBooleanOperator
열거 값

또는

1.12.2.7.4. StorageListDeployment
Copy to Clipboard Toggle word wrap
Next available tag: 9
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

hash

  

문자열

 

uint64

name

  

문자열

  

cluster

  

문자열

  

clusterId

  

문자열

  

네임스페이스

  

문자열

  

created

  

날짜

 

날짜-시간

priority

  

문자열

 

int64

1.12.2.7.5. StorageMatchType
열거 값

정확한

REGEX

1.12.2.7.6. StorageResourceSelector
필드 이름필수 항목Cryostat유형설명형식

규칙

  

StorageSelectorRule목록

규칙은 함께(AND)로 확인됩니다.

 
1.12.2.7.7. StorageRuleValue
필드 이름필수 항목Cryostat유형설명형식

value

  

문자열

  

matchType

  

StorageMatchType

 

정확한, 정규 표현식,

1.12.2.7.8. StorageSelectorRule
필드 이름필수 항목Cryostat유형설명형식

fieldName

  

문자열

  

operator

  

StorageBooleanOperator

 

또는,

  

StorageRuleValue목록

값은 operator에 따라 함께(AND) 또는 disjunction(OR)으로 확인됩니다. Cryostat의 경우 UX 관점에서 또는만 지원됩니다.

 
1.12.2.7.9. V1AggregateBy
필드 이름필수 항목Cryostat유형설명형식

aggrFunc

  

V1Aggregation

 

설정되지 않음, 개수, 최소, 최대

구별됨

  

부울

  
1.12.2.7.10. V1Aggregation
열거 값

설정되지 않음

COUNT

MAX

1.12.2.7.11. V1CollectionDeploymentMatchOptions
필드 이름필수 항목Cryostat유형설명형식

withMatches

  

부울

  

filterQuery

  

V1RawQuery

  
1.12.2.7.12. V1DryRunCollectionRequest
필드 이름필수 항목Cryostat유형설명형식

name

  

문자열

  

id

  

문자열

  

description

  

문자열

  

resourceSelectors

  

StorageResourceSelector목록

  

embeddedCollectionIds

  

문자열목록

  

options

  

V1CollectionDeploymentMatchOptions

  
1.12.2.7.13. V1DryRunCollectionResponse
필드 이름필수 항목Cryostat유형설명형식

배포

  

StorageListDeployment목록

  
1.12.2.7.14. V1Pagination
필드 이름필수 항목Cryostat유형설명형식

제한

  

정수

 

int32

offset

  

정수

 

int32

sortOption

  

V1SortOption

  

SortOptions

  

V1SortOption목록

이 필드는 개발 중입니다. REST API에서는 지원되지 않습니다.

 
1.12.2.7.15. V1RawQuery

RawQuery는 검색 쿼리 문자열을 나타냅니다. 쿼리 문자열의 형식은 "<field name>:<value,value,…​><field name>:<value, value,...>…​"입니다. 예: 네임스페이스 "stackrox"에서 "central" 및 "sensor"라는 배포를 검색하는 경우 쿼리 문자열은 "Deployment:central,sensor+Namespace:stackrox"가 ListAPIs에 사용됩니다.

필드 이름필수 항목Cryostat유형설명형식

query

  

문자열

  

페이지 번호

  

V1Pagination

  
1.12.2.7.16. V1SortOption
필드 이름필수 항목Cryostat유형설명형식

field

  

문자열

  

역전됨

  

부울

  

aggregateBy

  

V1AggregateBy

  

1.12.3. ListCollections

GET /v1/collections

1.12.3.1. 설명
1.12.3.2. 매개 변수
1.12.3.2.1. 쿼리 매개변수
이름설명필수 항목기본패턴

query.query

 

-

null

 

query.pagination.limit

 

-

null

 

query.pagination.offset

 

-

null

 

query.pagination.sortOption.field

 

-

null

 

query.pagination.sortOption.reversed

 

-

null

 

query.pagination.sortOption.aggregateBy.aggrFunc

 

-

설정되지 않음

 

query.pagination.sortOption.aggregateBy.distinct

 

-

null

 
1.12.3.3. 반환 유형

V1ListCollectionsResponse

1.12.3.4. 콘텐츠 유형
  • application/json
1.12.3.5. 응답
표 1.62. HTTP 응답 코드
코드메시지datatype

200

성공적인 응답입니다.

V1ListCollectionsResponse

0

예기치 않은 오류 응답

GooglerpcStatus

1.12.3.6. Samples
1.12.3.7. 공통 오브젝트 참조
1.12.3.7.1. GooglerpcStatus
필드 이름필수 항목Cryostat유형설명형식

코드

  

정수

 

int32

message

  

문자열

  

details

  

ProtobufAny목록

  
1.12.3.7.2. ProtobufAny

any 는 직렬화된 메시지의 유형을 설명하는 URL과 함께 임의의 직렬화된 프로토콜 버퍼 메시지를 포함합니다.

protobuf 라이브러리는 유틸리티 함수 또는 Any 유형의 추가 생성 메서드 형태로 모든 값의 팩/unpack을 지원합니다.

예 1: 팩 및 C++에서 메시지의 압축을 풉니다.

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

예 2: Java에서 메시지 팩 및 압축을 풉니다.

Copy to Clipboard Toggle word wrap
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 {
  ...
}

protobuf 라이브러리에서 제공하는 pack 메서드는 기본적으로 유형 URL로 'type.googleapis.com/full.type.name'을 사용하고 압축 해제 방법은 유형 URL에서 마지막 '/' 후에만 정규화된 유형 이름을 사용합니다(예: "foo.bar.com/x/y.z")는 유형 이름 "y.z"를 생성합니다.

1.12.3.7.2.1. JSON 표현

Any 값의 JSON 표현에서는 형식 URL을 포함하는 추가 필드 @type 과 함께 deserialized 포함 메시지의 정규식을 사용합니다. 예제:

Copy to Clipboard Toggle word wrap
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>
}

포함된 메시지 유형이 잘 알려져 있고 사용자 지정 JSON 표현이 있는 경우 해당 표현에 @type 필드 외에도 사용자 지정 JSON이 포함된 필드 값을 추가합니다. 예(메시지 [google.protobuf.Duration][]).

Copy to Clipboard Toggle word wrap
{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}
필드 이름필수 항목Cryostat유형설명형식

@type

  

문자열

직렬화된 프로토콜 버퍼 메시지의 유형을 고유하게 식별하는 URL/리소스 이름입니다. 이 문자열에는 하나 이상의 \"/\" 문자가 포함되어야 합니다. URL 경로의 마지막 세그먼트는 경로/google.protobuf.Duration과 같이 유형의 정규화된 이름을 나타냅니다. 이름은 표준 형식이어야 합니다(예: leading \".\"는 허용되지 않음). 실제로 팀은 일반적으로 Any의 컨텍스트에서 사용할 것으로 예상되는 모든 유형의 바이너리로 미리 컴파일됩니다. 그러나 스키마 http,https 또는 스키마를 사용하는 URL의 경우 선택 옵션으로 유형 URL을 메시지 정의에 매핑하는 유형 서버를 설정할 수 있습니다. * 스키마가 제공되지 않는 경우 https 로 가정합니다. * URL의 HTTP GET은 바이너리 형식으로 [google.protobuf.Type][] 값을 산출하거나 오류를 생성해야 합니다. * 애플리케이션은 URL을 기반으로 조회 결과를 캐시하거나 조회를 방지하기 위해 바이너리로 사전 컴파일되도록 할 수 있습니다. 따라서 유형 변경 시 바이너리 호환성을 유지해야 합니다. (버전이 지정된 유형 이름을 사용하여 중단 변경 사항을 관리합니다.) 참고: 이 기능은 현재 공식 protobuf 릴리스에서 제공되지 않으며 type.googleapis.com으로 시작하는 유형의 URL에는 사용되지 않습니다. 2023년 5월 현재 널리 사용되는 유형 서버 구현은 없으며 이를 구현할 계획이 없습니다. http 이외의 스키마,https (또는 빈 스키마)를 구현 특정 의미와 함께 사용할 수 있습니다.

 
1.12.3.7.3. ResourceCollectionEmbeddedResourceCollection
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  
1.12.3.7.4. StorageBooleanOperator
열거 값

또는

1.12.3.7.5. StorageMatchType
열거 값

정확한

REGEX

1.12.3.7.6. StorageResourceCollection
필드 이름필수 항목Cryostat유형설명형식

id

  

문자열

  

name

  

문자열

  

description

  

문자열

  

createdAt

  

날짜

 

날짜-시간

lastUpdated

  

날짜

 

날짜-시간

createdBy

  

StorageSlimUser

  

updatedBy

  

StorageSlimUser

  

resourceSelectors

  

StorageResourceSelector목록

resource_selectors 는 서로 함께 disjunction (OR)으로 확인되고 embedded_collections 의 선택기와 함께 확인됩니다. Cryostat의 경우 resource_selectors의 크기는 대부분 UX 관점에서 1개입니다.

 

embeddedCollections

  

ResourceCollectionEmbeddedResourceCollection목록

  
1.12.3.7.7. StorageResourceSelector
필드 이름필수 항목Cryostat유형설명형식

규칙

  

StorageSelectorRule목록

규칙은 함께(AND)로 확인됩니다.

 
1.12.3.7.8. StorageRuleValue
필드 이름필수 항목Cryostat유형설명형식

value

  

문자열

  

matchType

  

StorageMatchType

 

정확한, 정규 표현식,

1.12.3.7.9. StorageSelectorRule
필드 이름필수 항목Cryostat유형설명형식

fieldName

  

문자열

  

operator