API リファレンス

Red Hat Advanced Cluster Security for Kubernetes 4.5

Red Hat Advanced Cluster Security for Kubernetes の API リファレンスガイド。

Red Hat OpenShift Documentation Team

法律上の通知

概要

このドキュメントでは、Red Hat Advanced Cluster Security for Kubernetes API オブジェクトとその詳細な仕様について説明します。

第1章 AdministrationEventService

1.1. ListAdministrationEvents

GET /v1/administration/events

ListAdministrationEvents は、要求されたフィールドでフィルターされた後、イベントの一覧を返します。

1.1.1. 説明

1.1.2. パラメーター

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

名前	説明	必須	デフォルト
pagination.limit		-	null
pagination.offset		-	null
pagination.sortOption.field		-	null
pagination.sortOption.reversed		-	null
pagination.sortOption.aggregateBy.aggrFunc		-	UNSET
pagination.sortOption.aggregateBy.distinct		-	null
filter.from	特定のタイムスタンプの後、つまり下限後に last_occurred_at のイベントを照合します。	-	null
filter.until	特定のタイムスタンプ、つまり上限の前に last_occurred_at のイベントを照合します。	-	null
filter.domain	特定のドメインからのイベントを一致させます。`String`	-	null
filter.resourceType	特定のリソースタイプに関連付けられたイベントを照合します。`String`	-	null
filter.type	それらのタイプに基づいてイベントを照合します。`String`	-	null
filter.level	レベルに基づいてイベントをマッチングします。`String`	-	null

1.1.3. 戻り値のタイプ

V1ListAdministrationEventsResponse

1.1.4. コンテンツタイプ

application/json

1.1.5. レスポンス

表1.1 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1ListAdministrationEventsResponse
0	予期しないエラーの応答です。	RuntimeError

1.1.6. サンプル

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

1.1.7.1. ProtobufAny

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

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

protobuf ライブラリーが提供するパックメソッドは、デフォルトで type.googleapis.com/full.type.name をタイプ URL として使用し、unzip メソッドは、タイプ URL の最後の//のみを使用します。たとえば、"foo.bar.com/x/y.z" のように、"foo.bar.com/x/y.z" の型名 "y.z" が生成されます。

1.1.7.1.1. JSON 表現

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

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

埋め込みメッセージタイプがよく知られていて、カスタム JSON 表現がある場合、その表現は埋め込みされ、@type フィールドに加えてカスタム JSON を保持するフィールド 値 が追加されます。例（メッセージ [google.protobuf.Duration][] の場合）:

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

1.1.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

1.1.7.3. V1AdministrationEvent

AdministrationEvents は、セントラルによって出力される管理イベントです。これらは、非同期のバックグラウンドタスクの透過性を作成するために使用されます。イベントは、Central のシステムヘルスビューの一部です。

フィールド名	型	説明	形式
id	String	イベントの 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、ADMINISTRATION_EVENT_LEVEL_ERROR、
message	String	イベントに関連付けられたメッセージ。メッセージには、この特定のイベントの詳細情報が含まれる場合があります。
hint	String	イベントに関連付けられたヒント。ヒントには、イベントの種類に基づいて異なる情報が含まれる場合があります。これには、イベントまたは情報ヒントを解決する指示を含めることができます。
domain	String	イベントに関連付けられたドメイン。イベントのドメインは、イベントが作成された機能ドメインの概要を説明します。例として、これは \"Image Scanning\" の場合があります。特定のドメインに関連付けられていないイベントの場合、これは \"General\" になります。
resource	V1AdministrationEventResource
numOccurrences	String	イベントに関連付けられた発生。イベントが複数回発生する場合、発生が金額を追跡します。	int64
lastOccurredAt	Date	イベントが最後に発生した時刻を指定します。	date-time
createdAt	Date	イベントが作成された時刻を指定します。	date-time

1.1.7.4. V1AdministrationEventLevel

AdministrationEventLevel は、さまざまなレベルのイベントを公開します。

Enum 値
ADMINISTRATION_EVENT_LEVEL_UNKNOWN
ADMINISTRATION_EVENT_LEVEL_INFO
ADMINISTRATION_EVENT_LEVEL_SUCCESS
ADMINISTRATION_EVENT_LEVEL_WARNING
ADMINISTRATION_EVENT_LEVEL_ERROR

1.1.7.5. V1AdministrationEventResource

リソースは、イベントに関連付けられたリソースに関するすべての情報を保持します。

フィールド名	型	説明
type	String	イベントに関連付けられたリソースタイプ。イベントは、特定のイメージなどの基礎となるリソースを参照する場合があります。その場合、リソースタイプはここで入力されます。
id	String	イベントに関連付けられたリソース ID。イベントが基礎となるリソースを参照する場合、リソース ID は基礎となるリソースを識別します。管理イベントのコンテキストによっては、リソース ID が設定される保証はありません。
name	String	イベントに関連付けられたリソース名。イベントが基礎となるリソースを参照する場合、リソース名は基礎となるリソースを識別します。管理イベントのコンテキストによっては、リソース名が設定される保証はありません。

1.1.7.6. V1AdministrationEventType

AdministrationEventType は、さまざまなタイプのイベントを公開します。

Enum 値
ADMINISTRATION_EVENT_TYPE_UNKNOWN
ADMINISTRATION_EVENT_TYPE_GENERIC
ADMINISTRATION_EVENT_TYPE_LOG_MESSAGE

1.1.7.7. V1ListAdministrationEventsResponse

フィールド名	必須	Null 許容型	型	説明	形式
events			V1AdministrationEventのリスト

1.2. GetAdministrationEvent

GET /v1/administration/events/{id}

GetAdministrationEvent は、ID によってイベントを取得します。

1.2.1. 説明

1.2.2. パラメーター

1.2.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

1.2.3. 戻り値のタイプ

V1GetAdministrationEventResponse

1.2.4. コンテンツタイプ

application/json

1.2.5. レスポンス

表1.2 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GetAdministrationEventResponse
0	予期しないエラーの応答です。	RuntimeError

1.2.6. サンプル

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

1.2.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

1.2.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

1.2.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

1.2.7.3. V1AdministrationEvent

フィールド名	型	説明	形式
id	String	イベントの 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、ADMINISTRATION_EVENT_LEVEL_ERROR、
message	String	イベントに関連付けられたメッセージ。メッセージには、この特定のイベントの詳細情報が含まれる場合があります。
hint	String	イベントに関連付けられたヒント。ヒントには、イベントの種類に基づいて異なる情報が含まれる場合があります。これには、イベントまたは情報ヒントを解決する指示を含めることができます。
domain	String	イベントに関連付けられたドメイン。イベントのドメインは、イベントが作成された機能ドメインの概要を説明します。例として、これは \"Image Scanning\" の場合があります。特定のドメインに関連付けられていないイベントの場合、これは \"General\" になります。
resource	V1AdministrationEventResource
numOccurrences	String	イベントに関連付けられた発生。イベントが複数回発生する場合、発生が金額を追跡します。	int64
lastOccurredAt	Date	イベントが最後に発生した時刻を指定します。	date-time
createdAt	Date	イベントが作成された時刻を指定します。	date-time

1.2.7.4. V1AdministrationEventLevel

AdministrationEventLevel は、さまざまなレベルのイベントを公開します。

Enum 値
ADMINISTRATION_EVENT_LEVEL_UNKNOWN
ADMINISTRATION_EVENT_LEVEL_INFO
ADMINISTRATION_EVENT_LEVEL_SUCCESS
ADMINISTRATION_EVENT_LEVEL_WARNING
ADMINISTRATION_EVENT_LEVEL_ERROR

1.2.7.5. V1AdministrationEventResource

リソースは、イベントに関連付けられたリソースに関するすべての情報を保持します。

フィールド名	型	説明
type	String	イベントに関連付けられたリソースタイプ。イベントは、特定のイメージなどの基礎となるリソースを参照する場合があります。その場合、リソースタイプはここで入力されます。
id	String	イベントに関連付けられたリソース ID。イベントが基礎となるリソースを参照する場合、リソース ID は基礎となるリソースを識別します。管理イベントのコンテキストによっては、リソース ID が設定される保証はありません。
name	String	イベントに関連付けられたリソース名。イベントが基礎となるリソースを参照する場合、リソース名は基礎となるリソースを識別します。管理イベントのコンテキストによっては、リソース名が設定される保証はありません。

1.2.7.6. V1AdministrationEventType

AdministrationEventType は、さまざまなタイプのイベントを公開します。

Enum 値
ADMINISTRATION_EVENT_TYPE_UNKNOWN
ADMINISTRATION_EVENT_TYPE_GENERIC
ADMINISTRATION_EVENT_TYPE_LOG_MESSAGE

1.2.7.7. V1GetAdministrationEventResponse

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

1.3. CountAdministrationEvents

GET /v1/count/administration/events

CountAdministrationEvents は、要求されたフィールドによるフィルタリング後にイベントの数を返します。

1.3.1. 説明

1.3.2. パラメーター

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

名前	説明	必須	デフォルト
filter.from	特定のタイムスタンプの後、つまり下限後に last_occurred_at のイベントを照合します。	-	null
filter.until	特定のタイムスタンプ、つまり上限の前に last_occurred_at のイベントを照合します。	-	null
filter.domain	特定のドメインからのイベントを一致させます。`String`	-	null
filter.resourceType	特定のリソースタイプに関連付けられたイベントを照合します。`String`	-	null
filter.type	それらのタイプに基づいてイベントを照合します。`String`	-	null
filter.level	レベルに基づいてイベントをマッチングします。`String`	-	null

1.3.3. 戻り値のタイプ

V1CountAdministrationEventsResponse

1.3.4. コンテンツタイプ

application/json

1.3.5. レスポンス

表1.3 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1CountAdministrationEventsResponse
0	予期しないエラーの応答です。	RuntimeError

1.3.6. サンプル

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

1.3.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

1.3.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

1.3.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

1.3.7.3. V1CountAdministrationEventsResponse

フィールド名	必須	Null 許容型	型	説明	形式
count			Integer	フィルタリングと重複排除後のイベントの総数。	int32

第2章 AdministrationUsageService

2.1. GetCurrentSecuredUnitsUsage

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

GetCurrentSecuredUnitsUsage は、現在のセキュアなユニット使用量メトリクス値を返します。

2.1.1. 説明

保護されたユニットメトリクスは 5 分ごとにすべての接続クラスターから収集されるため、返される結果には、接続クラスターのデータがこの 5 分間に正確になり、非接続クラスターの古いデータが含まれる可能性があります。

2.1.2. パラメーター

2.1.3. 戻り値のタイプ

V1SecuredUnitsUsageResponse

2.1.4. コンテンツタイプ

application/json

2.1.5. レスポンス

表2.1 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1SecuredUnitsUsageResponse
0	予期しないエラーの応答です。	RuntimeError

2.1.6. サンプル

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

2.1.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

2.1.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

2.1.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

2.1.7.3. V1SecuredUnitsUsageResponse

SecuredUnitsUsageResponse は、現在監視可能な管理使用状況メトリクスの値を保持します。

フィールド名	必須	Null 許容型	型	説明	形式
numNodes			String		int64
numCpuUnits			String		int64

2.2. GetMaxSecuredUnitsUsage

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

GetMaxSecuredUnitsUsage は最大、つまりピーク、特定の時間範囲内で観察された安全な単位使用量を、この最大値が集約および保存された時間とともに返します。

2.2.1. 説明

使用状況のメトリックは、接続されたすべてのクラスターから継続的に収集されます。最大値はメモリー内で一定期間保持され、その後定期的にデータベースに保存されます。切断されたクラスターの最後のデータが考慮されます。

2.2.2. パラメーター

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

名前	説明	必須	デフォルト	Pattern
from		-	null
to		-	null

2.2.3. 戻り値のタイプ

V1MaxSecuredUnitsUsageResponse

2.2.4. コンテンツタイプ

application/json

2.2.5. レスポンス

表2.2 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1MaxSecuredUnitsUsageResponse
0	予期しないエラーの応答です。	RuntimeError

2.2.6. サンプル

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

2.2.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

2.2.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

2.2.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

2.2.7.3. V1MaxSecuredUnitsUsageResponse

MaxSecuredUnitsUsageResponse は、集計期間の精度でこれらの値が集約された時間とともに、(Kubernetes によって報告される)セキュアなノードと CPU ユニットの最大値を保持します。

フィールド名	型	形式
maxNodesAt	Date	date-time
maxNodes	String	int64
maxCpuUnitsAt	Date	date-time
maxCpuUnits	String	int64

第3章 AlertService

3.1. CountAlerts

GET /v1/alertscount

CountAlerts は、get 要求に一致するアラートの数をカウントします。

3.1.1. 説明

3.1.2. パラメーター

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

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

3.1.3. 戻り値のタイプ

V1CountAlertsResponse

3.1.4. コンテンツタイプ

application/json

3.1.5. レスポンス

表3.1 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1CountAlertsResponse
0	予期しないエラーの応答です。	RuntimeError

3.1.6. サンプル

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

3.1.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

3.1.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

3.1.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

3.1.7.3. V1CountAlertsResponse

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

3.2. DeleteAlerts

DELETE /v1/alerts

3.2.1. 説明

3.2.2. パラメーター

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	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null
confirm	-	null

3.2.3. 戻り値のタイプ

V1DeleteAlertsResponse

3.2.4. コンテンツタイプ

application/json

3.2.5. レスポンス

表3.2 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1DeleteAlertsResponse
0	予期しないエラーの応答です。	RuntimeError

3.2.6. サンプル

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

3.2.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

3.2.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

3.2.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

3.2.7.3. V1DeleteAlertsResponse

フィールド名	必須	Null 許容型	型	説明	形式
numDeleted			Long		int64
dryRun			Boolean

3.3. ListAlerts

GET /v1/alerts

list は、アラートのスリムリストバージョンを返します。

3.3.1. 説明

3.3.2. パラメーター

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

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

3.3.3. 戻り値のタイプ

V1ListAlertsResponse

3.3.4. コンテンツタイプ

application/json

3.3.5. レスポンス

表3.3 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1ListAlertsResponse
0	予期しないエラーの応答です。	RuntimeError

3.3.6. サンプル

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

3.3.7.1. ListAlertCommonEntityInfo

アラートが属する可能性のあるすべてのエンティティーに共通するフィールド。

フィールド名	型	形式
clusterName	String
namespace	String
clusterId	String
namespaceId	String
resourceType	StorageListAlertResourceType	DEPLOYMENT、SECRETS、CONFIGMAP、CLUSTER_ROLES、CLUSTER_ROLE_BINDINGS、NETWORK_POLICIES、SECURITY_CONTEXT_CONSTRAINTS、EGRESS_FIREWALLS、

3.3.7.2. ListAlertPolicyDevFields

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

3.3.7.3. ListAlertResourceEntity

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

3.3.7.4. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

3.3.7.4.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

3.3.7.5. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

3.3.7.6. StorageEnforcementAction

FAIL_KUBE_REQUEST_ENFORCEMENT: FAIL_KUBE_REQUEST_ENFORCEMENT は、アドミッションコントロール Webhook が実行およびポート転送イベントをリッスンするように有効にされている場合にのみ有効になります。
FAIL_DEPLOYMENT_CREATE_ENFORCEMENT: FAIL_DEPLOYMENT_CREATE_ENFORCEMENT は、オブジェクト作成を強制するように受付コントロール Webhook が設定されている場合にのみ有効です。
FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT: FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT は、オブジェクトの更新を強制するように受付コントロール Webhook が設定されている場合にのみ有効になります。

Enum 値
UNSET_ENFORCEMENT
SCALE_TO_ZERO_ENFORCEMENT
UNSATISFIABLE_NODE_CONSTRAINT_ENFORCEMENT
KILL_POD_ENFORCEMENT
FAIL_BUILD_ENFORCEMENT
FAIL_KUBE_REQUEST_ENFORCEMENT
FAIL_DEPLOYMENT_CREATE_ENFORCEMENT
FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT

3.3.7.7. StorageLifecycleStage

Enum 値
DEPLOY
BUILD
RUNTIME （ランタイム）

3.3.7.8. StorageListAlert

フィールド名	型	形式
id	String
lifecycleStage	StorageLifecycleStage	DEPLOY、BUILD、RUNTIME
time	Date	date-time
policy	StorageListAlertPolicy
state	StorageViolationState	ACTIVE、SNOOZED、解決済み、試行済み
enforcementCount	Integer	int32
enforcementAction	StorageEnforcementAction	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、FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT,
commonEntityInfo	ListAlertCommonEntityInfo
deployment	StorageListAlertDeployment
resource	ListAlertResourceEntity

3.3.7.9. StorageListAlertDeployment

フィールド名	型	説明
id	String
name	String
clusterName	String	このフィールドは非推奨であり、CommonEntityInfo にあります。これは今後のリリースで今後削除されます。
namespace	String	このフィールドは非推奨であり、CommonEntityInfo にあります。これは今後のリリースで今後削除されます。
clusterId	String	このフィールドは非推奨であり、CommonEntityInfo にあります。これは今後のリリースで今後削除されます。
inactive	Boolean
namespaceId	String	このフィールドは非推奨であり、CommonEntityInfo にあります。これは今後のリリースで今後削除されます。

3.3.7.10. StorageListAlertPolicy

フィールド名	型	形式
id	String
name	String
severity	StorageSeverity	UNSET_SEVERITY、LOW_SEVERITY、MEDIUM_SEVERITY、HIGH_SEVERITY、CRITICAL_SEVERITY、
description	String
categories	`string` のリスト
developerInternalFields	ListAlertPolicyDevFields

3.3.7.11. StorageListAlertResourceType

A special ListAlert-only enumeration of all resource types. Unlike Alert.Resource.ResourceType this also includes deployment as a type This must be kept in sync with Alert.Resource.ResourceType (excluding the deployment value)

Enum 値
DEPLOYMENT
SECRETS
CONFIGMAPS
CLUSTER_ROLES
CLUSTER_ROLE_BINDINGS
NETWORK_POLICIES
SECURITY_CONTEXT_CONSTRAINTS
EGRESS_FIREWALLS

3.3.7.12. StorageSeverity

Enum 値
UNSET_SEVERITY
LOW_SEVERITY
MEDIUM_SEVERITY
HIGH_SEVERITY
CRITICAL_SEVERITY

3.3.7.13. StorageViolationState

Enum 値
ACTIVE
SNOOZED
RESOLVED
ATTEMPTED

3.3.7.14. V1ListAlertsResponse

フィールド名	必須	Null 許容型	型	説明	形式
alerts			StorageListAlertのリスト

3.4. GetAlert

GET /v1/alerts/{id}

GetAlert は、ID を指定してアラートを返します。

3.4.1. 説明

3.4.2. パラメーター

3.4.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

3.4.3. 戻り値のタイプ

StorageAlert

3.4.4. コンテンツタイプ

application/json

3.4.5. レスポンス

表3.4 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	StorageAlert
0	予期しないエラーの応答です。	RuntimeError

3.4.6. サンプル

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

3.4.7.1. AlertDeploymentContainer

フィールド名	必須	Null 許容型	型	説明	形式
image			StorageContainerImage
name			String

3.4.7.2. AlertEnforcement

フィールド名	必須	Null 許容型	型	説明	形式
action			StorageEnforcementAction		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、FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT,
message			String

3.4.7.3. AlertProcessViolation

フィールド名	必須	Null 許容型	型	説明	形式
message			String
processes			List of StorageProcessIndicator

3.4.7.4. AlertResourceResourceType

Enum 値
UNKNOWN
SECRETS
CONFIGMAPS
CLUSTER_ROLES
CLUSTER_ROLE_BINDINGS
NETWORK_POLICIES
SECURITY_CONTEXT_CONSTRAINTS
EGRESS_FIREWALLS

3.4.7.5. AlertViolation

フィールド名	型	説明	形式
message	String
keyValueAttrs	ViolationKeyValueAttrs
networkFlowInfo	ViolationNetworkFlowInfo
type	AlertViolationType		GENERIC、K8S_EVENT、NETWORK_FLOW、NETWORK_POLICY、
time	Date	違反時間を示します。このフィールドは、ポリシーアラートが複数発生した場合にアラートが最後に発生した時刻を表す最上位フィールド 'time' とは異なります。55.0 の時点で、このフィールドは kubernetes イベント違反に対してのみ設定されていますが、将来制限される可能性はあります。	date-time

3.4.7.6. AlertViolationType

Enum 値
GENERIC
K8S_EVENT
NETWORK_FLOW
NETWORK_POLICY

3.4.7.7. KeyValueAttrsKeyValueAttr

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

3.4.7.8. NetworkFlowInfoEntity

フィールド名	型	形式
name	String
entityType	StorageNetworkEntityInfoType	UNKNOWN_TYPE, DEPLOYMENT, INTERNET, LISTEN_ENDPOINT, EXTERNAL_SOURCE, INTERNAL_ENTITIES,
deploymentNamespace	String
deploymentType	String
port	Integer	int32

3.4.7.9. PolicyMitreAttackVectors

フィールド名	必須	Null 許容型	型	説明	形式
tactic			String
テクニック			`string` のリスト

3.4.7.10. ProcessSignalLineageInfo

フィールド名	必須	Null 許容型	型	説明	形式
parentUid			Long		int64
parentExecFilePath			String

3.4.7.11. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

3.4.7.11.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

3.4.7.12. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

3.4.7.13. StorageAlert

フィールド名	型	説明	形式
id	String
policy	StoragePolicy
lifecycleStage	StorageLifecycleStage		DEPLOY、BUILD、RUNTIME
clusterId	String
clusterName	String
namespace	String
namespaceId	String
deployment	StorageAlertDeployment
image	StorageContainerImage
resource	StorageAlertResource
violations	AlertViolationのリスト	ランタイムフェーズのアラートについては、最大 40 の違反が保持されます。
processViolation	AlertProcessViolation
Enforcement	AlertEnforcement
time	Date		date-time
firstOccurred	Date		date-time
resolvedAt	Date	アラートが解決された時間。ViolationState が RESOLVED である場合にのみ設定されます。	date-time
state	StorageViolationState		ACTIVE、SNOOZED、解決済み、試行済み
snoozeTill	Date		date-time

3.4.7.14. StorageAlertDeployment

フィールド名	必須	Null 許容型	型	説明	形式
id			String
name			String
type			String
namespace			String
namespaceId			String
labels			`文字列`のマップ
clusterId			String
clusterName			String
containers			AlertDeploymentContainerの一覧
annotations			`文字列`のマップ
inactive			Boolean

3.4.7.15. StorageAlertResource

Represents an alert on a kubernetes resource other than a deployment (configmaps, secrets, etc.)

フィールド名	型	形式
resourceType	AlertResourceResourceType	UNKNOWN、SECRETS、CONFIGMAP、CLUSTER_ROLES、CLUSTER_ROLE_BINDINGS、NETWORK_POLICIES、SECURITY_CONTEXT_CONSTRAINTS、EGRESS_FIREWALLS、
name	String
clusterId	String
clusterName	String
namespace	String
namespaceId	String

3.4.7.16. StorageBooleanOperator

Enum 値
OR
AND

3.4.7.17. StorageContainerImage

Next tag: 12

フィールド名	必須	Null 許容型	型	説明	形式
id			String
name			StorageImageName
notPullable			Boolean
isClusterLocal			Boolean

3.4.7.18. StorageEnforcementAction

FAIL_KUBE_REQUEST_ENFORCEMENT: FAIL_KUBE_REQUEST_ENFORCEMENT は、アドミッションコントロール Webhook が実行およびポート転送イベントをリッスンするように有効にされている場合にのみ有効になります。
FAIL_DEPLOYMENT_CREATE_ENFORCEMENT: FAIL_DEPLOYMENT_CREATE_ENFORCEMENT は、オブジェクト作成を強制するように受付コントロール Webhook が設定されている場合にのみ有効です。
FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT: FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT は、オブジェクトの更新を強制するように受付コントロール Webhook が設定されている場合にのみ有効になります。

Enum 値
UNSET_ENFORCEMENT
SCALE_TO_ZERO_ENFORCEMENT
UNSATISFIABLE_NODE_CONSTRAINT_ENFORCEMENT
KILL_POD_ENFORCEMENT
FAIL_BUILD_ENFORCEMENT
FAIL_KUBE_REQUEST_ENFORCEMENT
FAIL_DEPLOYMENT_CREATE_ENFORCEMENT
FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT

3.4.7.19. StorageEventSource

Enum 値
NOT_APPLICABLE
DEPLOYMENT_EVENT
AUDIT_LOG_EVENT

3.4.7.20. StorageExclusion

フィールド名	型	形式
name	String
deployment	StorageExclusionDeployment
image	StorageExclusionImage
有効期限	Date	date-time

3.4.7.21. StorageExclusionDeployment

フィールド名	必須	Null 許容型	型	説明	形式
name			String
scope			StorageScope

3.4.7.22. StorageExclusionImage

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

3.4.7.23. StorageImageName

フィールド名	必須	Null 許容型	型	説明	形式
registry			String
remote			String
tag			String
fullName			String

3.4.7.24. StorageL4Protocol

Enum 値
L4_PROTOCOL_UNKNOWN
L4_PROTOCOL_TCP
L4_PROTOCOL_UDP
L4_PROTOCOL_ICMP
L4_PROTOCOL_RAW
L4_PROTOCOL_SCTP
L4_PROTOCOL_ANY

3.4.7.25. StorageLifecycleStage

Enum 値
DEPLOY
BUILD
RUNTIME （ランタイム）

3.4.7.26. StorageNetworkEntityInfoType

INTERNAL_ENTITIES: INTERNAL_ENTITIES は、単一のネットワークグラフノードですべての内部エンティティーをグループ化するためのものです。

Enum 値
UNKNOWN_TYPE
DEPLOYMENT
INTERNET
LISTEN_ENDPOINT
EXTERNAL_SOURCE
INTERNAL_ENTITIES

3.4.7.27. StoragePolicy

フィールド名	型	説明	形式
id	String
name	String
description	String
理論的根拠	String
修復	String
disabled	Boolean
categories	`string` のリスト
lifecycleStages	StorageLifecycleStageの一覧
eventSource	StorageEventSource		NOT_APPLICABLE、DEPLOYMENT_EVENT、AUDIT_LOG_EVENT、
除外	StorageExclusionのリスト
scope	StorageScopeのリスト
severity	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 がオブジェクトの更新を強制するように設定されている場合にのみ有効です。
通知機能	`string` のリスト
lastUpdated	Date		date-time
SORTName	String	内部使用のみ。
SORTLifecycleStage	String	内部使用のみ。
SORTEnforcement	Boolean	内部使用のみ。
policyVersion	String
policySections	StoragePolicySectionのリスト
mitreAttackVectors	PolicyMitreAttackVectorsのリスト
criteriaLocked	Boolean	読み取り専用フィールド。true の場合、ポリシーの基準フィールドが読み取り専用でレンダリングされます。
mitreVectorsLocked	Boolean	読み取り専用フィールド。true の場合、ポリシーの MITRE ATT&CK フィールドが読み取り専用でレンダリングされます。
isDefault	Boolean	読み取り専用フィールド。true の場合はポリシーがデフォルトポリシーで、false の場合はカスタムポリシーを示します。

3.4.7.28. StoragePolicyGroup

フィールド名	型	形式
fieldName	String
booleanOperator	StorageBooleanOperator	または、AND
negate	Boolean
values	StoragePolicyValueのリスト

3.4.7.29. StoragePolicySection

フィールド名	必須	Null 許容型	型	説明	形式
sectionName			String
policyGroups			StoragePolicyGroupのリスト

3.4.7.30. StoragePolicyValue

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

3.4.7.31. StorageProcessIndicator

Next available tag: 13

フィールド名	型	形式
id	String
deploymentId	String
containerName	String
podId	String
podUid	String
signal	StorageProcessSignal
clusterId	String
namespace	String
containerStartTime	Date	date-time
imageId	String

3.4.7.32. StorageProcessSignal

フィールド名	型	説明	形式
id	String	メッセージを識別するための一意の UUID。各メッセージを自己含むため、最上位ではなくこれを持っています。
containerId	String
time	Date		date-time
name	String
args	String
execFilePath	String
pid	Long		int64
uid	Long		int64
gid	Long		int64
lineage	`string` のリスト
scraped	Boolean
lineageInfo	List of ProcessSignalLineageInfo

3.4.7.33. StorageScope

フィールド名	必須	Null 許容型	型	説明	形式
cluster			String
namespace			String
label			StorageScopeLabel

3.4.7.34. StorageScopeLabel

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

3.4.7.35. StorageSeverity

Enum 値
UNSET_SEVERITY
LOW_SEVERITY
MEDIUM_SEVERITY
HIGH_SEVERITY
CRITICAL_SEVERITY

3.4.7.36. StorageViolationState

Enum 値
ACTIVE
SNOOZED
RESOLVED
ATTEMPTED

3.4.7.37. ViolationKeyValueAttrs

フィールド名	必須	Null 許容型	型	説明	形式
attrs			List of KeyValueAttrsKeyValueAttr

3.4.7.38. ViolationNetworkFlowInfo

フィールド名	型	形式
protocol	StorageL4Protocol	L4_PROTOCOL_UNKNOWN、L4_PROTOCOL_TCP、L4_PROTOCOL_UDP、L4_PROTOCOL_ICMP、L4_PROTOCOL_RAW、L4_PROTOCOL_SCTP、L4_PROTOCOL_ANY、
source	NetworkFlowInfoEntity
destination	NetworkFlowInfoEntity

3.5. ResolveAlert

PATCH /v1/alerts/{id}/resolve

ResolveAlert は、指定されたアラートを(ID で)解決済みとしてマークします。

3.5.1. 説明

3.5.2. パラメーター

3.5.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

3.5.2.2. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1ResolveAlertRequest	X

3.5.3. 戻り値のタイプ

Object

3.5.4. コンテンツタイプ

application/json

3.5.5. レスポンス

表3.5 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	`Object`
0	予期しないエラーの応答です。	RuntimeError

3.5.6. サンプル

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

3.5.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

3.5.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

3.5.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

3.5.7.3. V1ResolveAlertRequest

フィールド名	必須	Null 許容型	型	説明	形式
id			String
ホワイトリスト			Boolean
addToBaseline			Boolean

3.6. SnoozeAlert

PATCH /v1/alerts/{id}/snooze

SnoozeAlert は非推奨になりました。

3.6.1. 説明

3.6.2. パラメーター

3.6.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

3.6.2.2. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1SnoozeAlertRequest	X

3.6.3. 戻り値のタイプ

Object

3.6.4. コンテンツタイプ

application/json

3.6.5. レスポンス

表3.6 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	`Object`
0	予期しないエラーの応答です。	RuntimeError

3.6.6. サンプル

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

3.6.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

3.6.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

3.6.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

3.6.7.3. V1SnoozeAlertRequest

フィールド名	必須	Null 許容型	型	説明	形式
id			String
snoozeTill			Date		date-time

3.7. ResolveAlerts

PATCH /v1/alerts/resolve

ResolveAlertsByQuery は、検索クエリーに一致するアラートを解決済みとしてマークします。

3.7.1. 説明

3.7.2. パラメーター

3.7.2.1. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1ResolveAlertsRequest	X

3.7.3. 戻り値のタイプ

Object

3.7.4. コンテンツタイプ

application/json

3.7.5. レスポンス

表3.7 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	`Object`
0	予期しないエラーの応答です。	RuntimeError

3.7.6. サンプル

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

3.7.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

3.7.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

3.7.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

3.7.7.3. V1ResolveAlertsRequest

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

3.8. GetAlertsCounts

GET /v1/alerts/summary/counts

GetAlertsCounts は、要求されたクラスターまたはカテゴリーのアラート数を返します。

3.8.1. 説明

3.8.2. パラメーター

3.8.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	-	UNSET
request.pagination.sortOption.aggregateBy.distinct	-	null
groupBy	-	UNSET

3.8.3. 戻り値のタイプ

V1GetAlertsCountsResponse

3.8.4. コンテンツタイプ

application/json

3.8.5. レスポンス

表3.8 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GetAlertsCountsResponse
0	予期しないエラーの応答です。	RuntimeError

3.8.6. サンプル

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

3.8.7.1. AlertGroupAlertCounts

フィールド名	必須	Null 許容型	型	説明	形式
severity			StorageSeverity		UNSET_SEVERITY、LOW_SEVERITY、MEDIUM_SEVERITY、HIGH_SEVERITY、CRITICAL_SEVERITY、
count			String		int64

3.8.7.2. GetAlertsCountsResponseAlertGroup

フィールド名	必須	Null 許容型	型	説明	形式
group			String
ノード数			AlertGroupAlertCountsのリスト

3.8.7.3. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

3.8.7.3.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

3.8.7.4. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

3.8.7.5. StorageSeverity

Enum 値
UNSET_SEVERITY
LOW_SEVERITY
MEDIUM_SEVERITY
HIGH_SEVERITY
CRITICAL_SEVERITY

3.8.7.6. V1GetAlertsCountsResponse

フィールド名	必須	Null 許容型	型	説明	形式
groups			List of GetAlertsCountsResponseAlertGroup

3.9. GetAlertsGroup

GET /v1/alerts/summary/groups

GetAlertsGroup は、ポリシー別にグループ化されたアラートを返します。

3.9.1. 説明

3.9.2. パラメーター

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

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

3.9.3. 戻り値のタイプ

V1GetAlertsGroupResponse

3.9.4. コンテンツタイプ

application/json

3.9.5. レスポンス

表3.9 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GetAlertsGroupResponse
0	予期しないエラーの応答です。	RuntimeError

3.9.6. サンプル

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

3.9.7.1. ListAlertPolicyDevFields

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

3.9.7.2. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

3.9.7.2.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

3.9.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

3.9.7.4. StorageListAlertPolicy

フィールド名	型	形式
id	String
name	String
severity	StorageSeverity	UNSET_SEVERITY、LOW_SEVERITY、MEDIUM_SEVERITY、HIGH_SEVERITY、CRITICAL_SEVERITY、
description	String
categories	`string` のリスト
developerInternalFields	ListAlertPolicyDevFields

3.9.7.5. StorageSeverity

Enum 値
UNSET_SEVERITY
LOW_SEVERITY
MEDIUM_SEVERITY
HIGH_SEVERITY
CRITICAL_SEVERITY

3.9.7.6. V1GetAlertsGroupResponse

フィールド名	必須	Null 許容型	型	説明	形式
alertsByPolicies			List of V1GetAlertsGroupResponsePolicyGroup

3.9.7.7. V1GetAlertsGroupResponsePolicyGroup

フィールド名	必須	Null 許容型	型	説明	形式
policy			StorageListAlertPolicy
numAlerts			String		int64

3.10. GetAlertTimeseries

GET /v1/alerts/summary/timeseries

GetAlertTimeseries は、時間順にソートされたアラートを返します。

3.10.1. 説明

3.10.2. パラメーター

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

名前	必須	デフォルト
query	-	null
pagination.limit	-	null
pagination.offset	-	null
pagination.sortOption.field	-	null
pagination.sortOption.reversed	-	null
pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
pagination.sortOption.aggregateBy.distinct	-	null

3.10.3. 戻り値のタイプ

V1GetAlertTimeseriesResponse

3.10.4. コンテンツタイプ

application/json

3.10.5. レスポンス

表3.10 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GetAlertTimeseriesResponse
0	予期しないエラーの応答です。	RuntimeError

3.10.6. サンプル

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

3.10.7.1. ClusterAlertsAlertEvents

フィールド名	必須	Null 許容型	型	説明	形式
severity			StorageSeverity		UNSET_SEVERITY、LOW_SEVERITY、MEDIUM_SEVERITY、HIGH_SEVERITY、CRITICAL_SEVERITY、
events			V1AlertEventのリスト

3.10.7.2. GetAlertTimeseriesResponseClusterAlerts

フィールド名	必須	Null 許容型	型	説明	形式
cluster			String
severities			ClusterAlertsAlertEventsの一覧

3.10.7.3. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

3.10.7.3.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

3.10.7.4. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

3.10.7.5. StorageSeverity

Enum 値
UNSET_SEVERITY
LOW_SEVERITY
MEDIUM_SEVERITY
HIGH_SEVERITY
CRITICAL_SEVERITY

3.10.7.6. V1AlertEvent

フィールド名	型	形式
time	String	int64
type	V1Type	作成、削除、
id	String

3.10.7.7. V1GetAlertTimeseriesResponse

フィールド名	必須	Null 許容型	型	説明	形式
clusters			List of GetAlertTimeseriesResponseClusterAlerts

3.10.7.8. V1Type

Enum 値
作成済み
廃止済み

第4章 APITokenService

4.1. ListAllowedTokenRoles

GET /v1/apitokens/generate/allowed-roles

GetAllowedTokenRoles は、ユーザーが API トークンを要求できるロールを返します。

4.1.1. 説明

4.1.2. パラメーター

4.1.3. 戻り値のタイプ

V1ListAllowedTokenRolesResponse

4.1.4. コンテンツタイプ

application/json

4.1.5. レスポンス

表4.1 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1ListAllowedTokenRolesResponse
0	予期しないエラーの応答です。	RuntimeError

4.1.6. サンプル

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

4.1.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

4.1.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

4.1.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

4.1.7.3. V1ListAllowedTokenRolesResponse

フィールド名	必須	Null 許容型	型	説明	形式
roleNames			`string` のリスト

4.2. GenerateToken

POST /v1/apitokens/generate

GenerateToken は、所定のユーザーとロールの API トークンを生成します。

4.2.1. 説明

4.2.2. パラメーター

4.2.2.1. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1GenerateTokenRequest	X

4.2.3. 戻り値のタイプ

V1GenerateTokenResponse

4.2.4. コンテンツタイプ

application/json

4.2.5. レスポンス

表4.2 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GenerateTokenResponse
0	予期しないエラーの応答です。	RuntimeError

4.2.6. サンプル

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

4.2.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

4.2.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

4.2.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

4.2.7.3. StorageTokenMetadata

フィールド名	型	形式
id	String
name	String
roles	`string` のリスト
issuedAt	Date	date-time
有効期限	Date	date-time
revoked	Boolean
role	String

4.2.7.4. V1GenerateTokenRequest

フィールド名	型	形式
name	String
role	String
roles	`string` のリスト
有効期限	Date	date-time

4.2.7.5. V1GenerateTokenResponse

フィールド名	必須	Null 許容型	型	説明	形式
token			String
metadata			StorageTokenMetadata

4.3. GetAPITokens

GET /v1/apitokens

GetAPITokens はすべての API トークンを返します。

4.3.1. 説明

4.3.2. パラメーター

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

名前	説明	必須	デフォルト	Pattern
revoked		-	null

4.3.3. 戻り値のタイプ

V1GetAPITokensResponse

4.3.4. コンテンツタイプ

application/json

4.3.5. レスポンス

表4.3 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GetAPITokensResponse
0	予期しないエラーの応答です。	RuntimeError

4.3.6. サンプル

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

4.3.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

4.3.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

4.3.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

4.3.7.3. StorageTokenMetadata

フィールド名	型	形式
id	String
name	String
roles	`string` のリスト
issuedAt	Date	date-time
有効期限	Date	date-time
revoked	Boolean
role	String

4.3.7.4. V1GetAPITokensResponse

フィールド名	必須	Null 許容型	型	説明	形式
トークン			StorageTokenMetadataの一覧

4.4. GetAPIToken

GET /v1/apitokens/{id}

GetAPIToken は特定の ID の API トークンメタデータを返します。

4.4.1. 説明

4.4.2. パラメーター

4.4.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

4.4.3. 戻り値のタイプ

StorageTokenMetadata

4.4.4. コンテンツタイプ

application/json

4.4.5. レスポンス

表4.4 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	StorageTokenMetadata
0	予期しないエラーの応答です。	RuntimeError

4.4.6. サンプル

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

4.4.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

4.4.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

4.4.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

4.4.7.3. StorageTokenMetadata

フィールド名	型	形式
id	String
name	String
roles	`string` のリスト
issuedAt	Date	date-time
有効期限	Date	date-time
revoked	Boolean
role	String

4.5. RevokeToken

PATCH /v1/apitokens/revoke/{id}

RevokeToken は特定の ID の API トークンを削除します。

4.5.1. 説明

4.5.2. パラメーター

4.5.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

4.5.3. 戻り値のタイプ

Object

4.5.4. コンテンツタイプ

application/json

4.5.5. レスポンス

表4.5 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	`Object`
0	予期しないエラーの応答です。	RuntimeError

4.5.6. サンプル

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

4.5.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

4.5.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

4.5.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

第5章 AuthProviderService

5.1. ExchangeToken

POST /v1/authProviders/exchangeToken

5.1.1. 説明

5.1.2. パラメーター

5.1.2.1. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1ExchangeTokenRequest	X

5.1.3. 戻り値のタイプ

V1ExchangeTokenResponse

5.1.4. コンテンツタイプ

application/json

5.1.5. レスポンス

表5.1 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1ExchangeTokenResponse
0	予期しないエラーの応答です。	RuntimeError

5.1.6. サンプル

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

5.1.7.1. AuthProviderRequiredAttribute

RequiredAttribute を使用すると、認証プロバイダーによって返される必要がある属性のセットを指定できます。Central が発行するトークンの外部要求内に属性がない場合、この IdP への認証要求は失敗とみなされます。

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

5.1.7.2. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

5.1.7.2.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

5.1.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

5.1.7.4. StorageAccess

Enum 値
NO_ACCESS
READ_ACCESS
READ_WRITE_ACCESS

5.1.7.5. StorageAuthProvider

次のタグ：15

フィールド名	型	説明	形式
id	String
name	String
type	String
uiEndpoint	String
enabled	Boolean
config	`文字列`のマップ	Config は認証プロバイダー固有の設定を保持します。各設定オプションは、指定の認証プロバイダータイプによって異なります。OIDC: - \"issuer\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier に準拠した OIDC 発行者。- \"client_id\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.2 に準拠したクライアント ID。- \"client_secret\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.3.1 に準拠したクライアントシークレットです。- - \"do_not_use_client_secret\": クライアント ID のみで、クライアントシークレットのない設定を作成する場合は \"true\" に設定します。- \"mode\": OIDC コールバックモード、または OIDC コールバックモード。オフライントークンが発行されない場合は、\"fragment\"、\"post\"、または \"query\": \"disable_offline_access_scope\": \"true\" に設定します。- \"extra_scopes\": https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 に従って、\"openid プロファイル email\" に加えて要求する追加のスコープのスペースで区切られた文字列。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。- \"idp_sso_url\": IdP SSO URL。- \"idp_nameid_format\": IdP 名 ID 形式。IAP: - \"audience\": 使用するオーディエンス。
loginUrl	String	ログイン URL はバックエンドにより提供され、リクエストで指定できない場合があります。
validated	Boolean
extraUiEndpoints	`string` のリスト	`ui_endpoint` に加えて許可する UI エンドポイント。つまり、ログインリクエストがこれらのいずれかから送信される場合、認証リクエストはこれらをコールバック URL に使用します(ui_endpoint ではなく)。
active	Boolean
requiredAttributes	AuthProviderRequiredAttributeのリスト
traits	StorageTraits
claimMappings	`文字列`のマップ	Rox トークン属性にコピーされる IdP トークンからの要求を指定します。このマップの各キーには、マップする IdP トークンのパスが含まれています。パスは \".\" 記号で区切られます。たとえば、IdP トークンペイロードが { \"a\": { \"b\" : \"c\", \"d\": true, \"e\": [ \"val1\", \"val2\", \"val3\" ], \"f\": [ true, false, false ], \"g\", 123.0, \"h\": [ 1、2, 3] } } で、\"a.b\" は有効なキーになり、\"a.z\" は有効ではありません。次のタイプの要求をサポートしています：* string (path \"a.b\")* bool (path \"a.d\")* string array (path \"a.e\")* bool array (path \"a.f.\")* float/integer claim (path \"a.g\")* float/integer array claims (path \"a.h\")）このマップの各値には、要求を追加する Rox トークン属性名が含まれています。たとえば、value が \"groups\" の場合、要求はトークンの \"external_user.Attributes.groups\" にあります。注記：この機能は OIDC 認証プロバイダーに対してのみサポートされます。
lastUpdated	Date	Last updated は、認証プロバイダーが最後に更新された時刻を示します。このタイムスタンプの前に認証プロバイダーによって発行されたトークンがあった場合、無効なと見なされます。その後、すべてのクライアントはトークンを再発行する必要があります（更新または追加のログイン試行のいずれか）。	date-time

5.1.7.6. StorageServiceIdentity

フィールド名	型	形式
serialStr	String
serial	String	int64
id	String
type	StorageServiceType	UNKNOWN_SERVICE、SENSOR_SERVICE、CENTRAL_SERVICE、CENTRAL_DB_SERVICE、REMOTE_SERVICE、COLLECTOR_SERVICE、MONITORING_UI_SERVICE、MONITORING_DB_SERVICE、MONITORING_CLIENT_SERVICE、ASNCHMARK_SERVICE、SCANNER_SERVICE、SCANNER_DB_SERVICE、ADMISSION_CONTROL_SERVICE、SCANNER_V4_INDEXER_SERVICE、SCANNER_V4_MATCHER_SERVICE、SCANNER_V4_DB_SERVICE、
initBundleId	String

5.1.7.7. StorageServiceType

Next available tag: 16

Enum 値
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

5.1.7.8. StorageTraits

フィールド名	型	形式
mutabilityMode	TraitsMutabilityMode	ALLOW_MUTATE, ALLOW_MUTATE_FORCED,
visibility	TraitsVisibility	VISIBLE、HIDDEN、
origin	TraitsOrigin	命令、デフォルト、宣言的、DECLARATIVE_ORPHANED

5.1.7.9. StorageUserInfo

フィールド名	必須	Null 許容型	型	説明	形式
username			String
friendlyName			String
permissions			UserInfoResourceToAccess
roles			StorageUserInfoRoleのリスト

5.1.7.10. StorageUserInfoRole

ロールは、古い storage.Role 形式との互換性があるため、ロール名と関連するパーミッションのみが含まれます。

フィールド名	必須	Null 許容型	型	説明	形式
name			String
resourceToAccess			StorageAccessのマップ

5.1.7.11. TraitsMutabilityMode

実験的注記：当面は、MutabilityMode の使用を参照してください。これは今後置き換えられる予定です(ROX-14276)。MutabilityMode は、オブジェクトを変更するかどうか、およびその方法を指定します。デフォルトは ALLOW_MUTATE であり、変更制限がないことを意味します。これは、MutabilityMode 仕様がないことと同等です。ALLOW_MUTATE_FORCED は、force ビットでのオブジェクト削除以外のすべての変更操作を禁止します。

このフィールドの状態を変更するときは注意してください。たとえば、オブジェクトを ALLOW_MUTATE から ALLOW_MUTATE_FORCED に変更することは許可されますが、これを変更すると、ALLOW_MUTATE に戻すなど、それ以降の変更はできなくなります。

Enum 値
ALLOW_MUTATE
ALLOW_MUTATE_FORCED

5.1.7.12. TraitsOrigin

origin は、オブジェクトの発信元を指定します。オブジェクトには、発信元を 4 つ持つことができます：- IMPERATIVE: オブジェクトは API 経由で作成されました。これはデフォルトで仮定されます。- DEFAULT: オブジェクトは、デフォルトのロール、アクセススコープなどのデフォルトオブジェクトです。DECLARATIVE: オブジェクトは宣言型設定を使用して作成されます。- DECLARATIVE_ORPHANED: オブジェクトは宣言型設定によって作成され、（たとえば、別のオブジェクトで参照されるため）作成元に基づいて別のルールがオブジェクトに適用されます。DECLARATIVE オリジンを持つオブジェクトは、宣言的設定を介してのみ API 経由で変更することはできません。さらに、IMPERATIVE オリジンを使用してオブジェクトを参照することはできません。DEFAULT オリジンを持つオブジェクトは、API または宣言型設定のいずれかを介して変更することはできません。それらは他のすべてのオブジェクトで参照できます。IMPERATIVE オリジンを持つオブジェクトは、宣言的設定ではなく、API を介して変更できます。これらは他のすべてのオブジェクトを参照することができます。DECLARATIVE_ORPHANED オリジンを持つオブジェクトは、API または宣言型設定のいずれかを介して変更できません。DECLARATIVE_ORPHANED リソースは、宣言的な設定で再定義されると、DECLARATIVE が再び DECLARATIVE になる可能性があります。この元のオブジェクトでは、他のリソースが参照されていない直後にシステムからクリーンアップされます。それらは他のすべてのオブジェクトで参照できます。

Enum 値
命令
デフォルト
宣言的
DECLARATIVE_ORPHANED

5.1.7.13. TraitsVisibility

EXPERIMENTAL. 可視性により、特定の API に対してオブジェクトを表示するかどうかを指定できます。

Enum 値
VISIBLE
HIDDEN

5.1.7.14. UserInfoResourceToAccess

ResourceToAccess は、パーミッションのコレクションを表します。これは、古い storage.Role 形式との互換性があり、集約されたパーミッションのみが必要な場所に置き換えます。

フィールド名	必須	Null 許容型	型	説明	形式
resourceToAccess			StorageAccessのマップ

5.1.7.15. V1AuthStatus

フィールド名	型	説明	形式
userId	String
serviceId	StorageServiceIdentity
Expires	Date		date-time
refreshUrl	String
authProvider	StorageAuthProvider
userInfo	StorageUserInfo
userAttributes	V1UserAttributeのリスト
idpToken	String	基礎となる ID プロバイダーによって ACS に返されるトークン。このフィールドは、いくつかの特定のコンテキストでのみ設定されます。応答に存在するこのフィールドに依存しないでください。

5.1.7.16. V1ExchangeTokenRequest

フィールド名	型	説明
externalToken	String	外部認証トークン。サーバーは、応答とログでこの認証情報の値をマスクします。
type	String
state	String

5.1.7.17. V1ExchangeTokenResponse

フィールド名	必須	Null 許容型	型	説明	形式
token			String
clientState			String
test			Boolean
user			V1AuthStatus

5.1.7.18. V1UserAttribute

フィールド名	必須	Null 許容型	型	説明	形式
key			String
values			`string` のリスト

5.2. GetAuthProviders

GET /v1/authProviders

5.2.1. 説明

5.2.2. パラメーター

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

名前	説明	必須	デフォルト	Pattern
name		-	null
type		-	null

5.2.3. 戻り値のタイプ

V1GetAuthProvidersResponse

5.2.4. コンテンツタイプ

application/json

5.2.5. レスポンス

表5.2 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GetAuthProvidersResponse
0	予期しないエラーの応答です。	RuntimeError

5.2.6. サンプル

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

5.2.7.1. AuthProviderRequiredAttribute

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

5.2.7.2. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

5.2.7.2.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

5.2.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

5.2.7.4. StorageAuthProvider

次のタグ：15

フィールド名	型	説明	形式
id	String
name	String
type	String
uiEndpoint	String
enabled	Boolean
config	`文字列`のマップ	Config は認証プロバイダー固有の設定を保持します。各設定オプションは、指定の認証プロバイダータイプによって異なります。OIDC: - \"issuer\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier に準拠した OIDC 発行者。- \"client_id\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.2 に準拠したクライアント ID。- \"client_secret\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.3.1 に準拠したクライアントシークレットです。- - \"do_not_use_client_secret\": クライアント ID のみで、クライアントシークレットのない設定を作成する場合は \"true\" に設定します。- \"mode\": OIDC コールバックモード、または OIDC コールバックモード。オフライントークンが発行されない場合は、\"fragment\"、\"post\"、または \"query\": \"disable_offline_access_scope\": \"true\" に設定します。- \"extra_scopes\": https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 に従って、\"openid プロファイル email\" に加えて要求する追加のスコープのスペースで区切られた文字列。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。- \"idp_sso_url\": IdP SSO URL。- \"idp_nameid_format\": IdP 名 ID 形式。IAP: - \"audience\": 使用するオーディエンス。
loginUrl	String	ログイン URL はバックエンドにより提供され、リクエストで指定できない場合があります。
validated	Boolean
extraUiEndpoints	`string` のリスト	`ui_endpoint` に加えて許可する UI エンドポイント。つまり、ログインリクエストがこれらのいずれかから送信される場合、認証リクエストはこれらをコールバック URL に使用します(ui_endpoint ではなく)。
active	Boolean
requiredAttributes	AuthProviderRequiredAttributeのリスト
traits	StorageTraits
claimMappings	`文字列`のマップ	Rox トークン属性にコピーされる IdP トークンからの要求を指定します。このマップの各キーには、マップする IdP トークンのパスが含まれています。パスは \".\" 記号で区切られます。たとえば、IdP トークンペイロードが { \"a\": { \"b\" : \"c\", \"d\": true, \"e\": [ \"val1\", \"val2\", \"val3\" ], \"f\": [ true, false, false ], \"g\", 123.0, \"h\": [ 1、2, 3] } } で、\"a.b\" は有効なキーになり、\"a.z\" は有効ではありません。次のタイプの要求をサポートしています：* string (path \"a.b\")* bool (path \"a.d\")* string array (path \"a.e\")* bool array (path \"a.f.\")* float/integer claim (path \"a.g\")* float/integer array claims (path \"a.h\")）このマップの各値には、要求を追加する Rox トークン属性名が含まれています。たとえば、value が \"groups\" の場合、要求はトークンの \"external_user.Attributes.groups\" にあります。注記：この機能は OIDC 認証プロバイダーに対してのみサポートされます。
lastUpdated	Date	Last updated は、認証プロバイダーが最後に更新された時刻を示します。このタイムスタンプの前に認証プロバイダーによって発行されたトークンがあった場合、無効なと見なされます。その後、すべてのクライアントはトークンを再発行する必要があります（更新または追加のログイン試行のいずれか）。	date-time

5.2.7.5. StorageTraits

フィールド名	型	形式
mutabilityMode	TraitsMutabilityMode	ALLOW_MUTATE, ALLOW_MUTATE_FORCED,
visibility	TraitsVisibility	VISIBLE、HIDDEN、
origin	TraitsOrigin	命令、デフォルト、宣言的、DECLARATIVE_ORPHANED

5.2.7.6. TraitsMutabilityMode

Enum 値
ALLOW_MUTATE
ALLOW_MUTATE_FORCED

5.2.7.7. TraitsOrigin

Enum 値
命令
デフォルト
宣言的
DECLARATIVE_ORPHANED

5.2.7.8. TraitsVisibility

EXPERIMENTAL. 可視性により、特定の API に対してオブジェクトを表示するかどうかを指定できます。

Enum 値
VISIBLE
HIDDEN

5.2.7.9. V1GetAuthProvidersResponse

フィールド名	必須	Null 許容型	型	説明	形式
authProviders			StorageAuthProviderの一覧

5.3. DeleteAuthProvider

DELETE /v1/authProviders/{id}

5.3.1. 説明

5.3.2. パラメーター

5.3.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

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

名前	説明	必須	デフォルト	Pattern
force		-	null

5.3.3. 戻り値のタイプ

Object

5.3.4. コンテンツタイプ

application/json

5.3.5. レスポンス

表5.3 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	`Object`
0	予期しないエラーの応答です。	RuntimeError

5.3.6. サンプル

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

5.3.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

5.3.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

5.3.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

5.4. GetAuthProvider

GET /v1/authProviders/{id}

5.4.1. 説明

5.4.2. パラメーター

5.4.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

5.4.3. 戻り値のタイプ

StorageAuthProvider

5.4.4. コンテンツタイプ

application/json

5.4.5. レスポンス

表5.4 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	StorageAuthProvider
0	予期しないエラーの応答です。	RuntimeError

5.4.6. サンプル

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

5.4.7.1. AuthProviderRequiredAttribute

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

5.4.7.2. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

5.4.7.2.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

5.4.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

5.4.7.4. StorageAuthProvider

次のタグ：15

フィールド名	型	説明	形式
id	String
name	String
type	String
uiEndpoint	String
enabled	Boolean
config	`文字列`のマップ	Config は認証プロバイダー固有の設定を保持します。各設定オプションは、指定の認証プロバイダータイプによって異なります。OIDC: - \"issuer\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier に準拠した OIDC 発行者。- \"client_id\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.2 に準拠したクライアント ID。- \"client_secret\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.3.1 に準拠したクライアントシークレットです。- - \"do_not_use_client_secret\": クライアント ID のみで、クライアントシークレットのない設定を作成する場合は \"true\" に設定します。- \"mode\": OIDC コールバックモード、または OIDC コールバックモード。オフライントークンが発行されない場合は、\"fragment\"、\"post\"、または \"query\": \"disable_offline_access_scope\": \"true\" に設定します。- \"extra_scopes\": https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 に従って、\"openid プロファイル email\" に加えて要求する追加のスコープのスペースで区切られた文字列。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。- \"idp_sso_url\": IdP SSO URL。- \"idp_nameid_format\": IdP 名 ID 形式。IAP: - \"audience\": 使用するオーディエンス。
loginUrl	String	ログイン URL はバックエンドにより提供され、リクエストで指定できない場合があります。
validated	Boolean
extraUiEndpoints	`string` のリスト	`ui_endpoint` に加えて許可する UI エンドポイント。つまり、ログインリクエストがこれらのいずれかから送信される場合、認証リクエストはこれらをコールバック URL に使用します(ui_endpoint ではなく)。
active	Boolean
requiredAttributes	AuthProviderRequiredAttributeのリスト
traits	StorageTraits
claimMappings	`文字列`のマップ	Rox トークン属性にコピーされる IdP トークンからの要求を指定します。このマップの各キーには、マップする IdP トークンのパスが含まれています。パスは \".\" 記号で区切られます。たとえば、IdP トークンペイロードが { \"a\": { \"b\" : \"c\", \"d\": true, \"e\": [ \"val1\", \"val2\", \"val3\" ], \"f\": [ true, false, false ], \"g\", 123.0, \"h\": [ 1、2, 3] } } で、\"a.b\" は有効なキーになり、\"a.z\" は有効ではありません。次のタイプの要求をサポートしています：* string (path \"a.b\")* bool (path \"a.d\")* string array (path \"a.e\")* bool array (path \"a.f.\")* float/integer claim (path \"a.g\")* float/integer array claims (path \"a.h\")）このマップの各値には、要求を追加する Rox トークン属性名が含まれています。たとえば、value が \"groups\" の場合、要求はトークンの \"external_user.Attributes.groups\" にあります。注記：この機能は OIDC 認証プロバイダーに対してのみサポートされます。
lastUpdated	Date	Last updated は、認証プロバイダーが最後に更新された時刻を示します。このタイムスタンプの前に認証プロバイダーによって発行されたトークンがあった場合、無効なと見なされます。その後、すべてのクライアントはトークンを再発行する必要があります（更新または追加のログイン試行のいずれか）。	date-time

5.4.7.5. StorageTraits

フィールド名	型	形式
mutabilityMode	TraitsMutabilityMode	ALLOW_MUTATE, ALLOW_MUTATE_FORCED,
visibility	TraitsVisibility	VISIBLE、HIDDEN、
origin	TraitsOrigin	命令、デフォルト、宣言的、DECLARATIVE_ORPHANED

5.4.7.6. TraitsMutabilityMode

Enum 値
ALLOW_MUTATE
ALLOW_MUTATE_FORCED

5.4.7.7. TraitsOrigin

Enum 値
命令
デフォルト
宣言的
DECLARATIVE_ORPHANED

5.4.7.8. TraitsVisibility

EXPERIMENTAL. 可視性により、特定の API に対してオブジェクトを表示するかどうかを指定できます。

Enum 値
VISIBLE
HIDDEN

5.5. UpdateAuthProvider

PATCH /v1/authProviders/{id}

5.5.1. 説明

5.5.2. パラメーター

5.5.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

5.5.2.2. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1UpdateAuthProviderRequest	X

5.5.3. 戻り値のタイプ

StorageAuthProvider

5.5.4. コンテンツタイプ

application/json

5.5.5. レスポンス

表5.5 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	StorageAuthProvider
0	予期しないエラーの応答です。	RuntimeError

5.5.6. サンプル

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

5.5.7.1. AuthProviderRequiredAttribute

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

5.5.7.2. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

5.5.7.2.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

5.5.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

5.5.7.4. StorageAuthProvider

次のタグ：15

フィールド名	型	説明	形式
id	String
name	String
type	String
uiEndpoint	String
enabled	Boolean
config	`文字列`のマップ	Config は認証プロバイダー固有の設定を保持します。各設定オプションは、指定の認証プロバイダータイプによって異なります。OIDC: - \"issuer\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier に準拠した OIDC 発行者。- \"client_id\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.2 に準拠したクライアント ID。- \"client_secret\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.3.1 に準拠したクライアントシークレットです。- - \"do_not_use_client_secret\": クライアント ID のみで、クライアントシークレットのない設定を作成する場合は \"true\" に設定します。- \"mode\": OIDC コールバックモード、または OIDC コールバックモード。オフライントークンが発行されない場合は、\"fragment\"、\"post\"、または \"query\": \"disable_offline_access_scope\": \"true\" に設定します。- \"extra_scopes\": https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 に従って、\"openid プロファイル email\" に加えて要求する追加のスコープのスペースで区切られた文字列。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。- \"idp_sso_url\": IdP SSO URL。- \"idp_nameid_format\": IdP 名 ID 形式。IAP: - \"audience\": 使用するオーディエンス。
loginUrl	String	ログイン URL はバックエンドにより提供され、リクエストで指定できない場合があります。
validated	Boolean
extraUiEndpoints	`string` のリスト	`ui_endpoint` に加えて許可する UI エンドポイント。つまり、ログインリクエストがこれらのいずれかから送信される場合、認証リクエストはこれらをコールバック URL に使用します(ui_endpoint ではなく)。
active	Boolean
requiredAttributes	AuthProviderRequiredAttributeのリスト
traits	StorageTraits
claimMappings	`文字列`のマップ	Rox トークン属性にコピーされる IdP トークンからの要求を指定します。このマップの各キーには、マップする IdP トークンのパスが含まれています。パスは \".\" 記号で区切られます。たとえば、IdP トークンペイロードが { \"a\": { \"b\" : \"c\", \"d\": true, \"e\": [ \"val1\", \"val2\", \"val3\" ], \"f\": [ true, false, false ], \"g\", 123.0, \"h\": [ 1、2, 3] } } で、\"a.b\" は有効なキーになり、\"a.z\" は有効ではありません。次のタイプの要求をサポートしています：* string (path \"a.b\")* bool (path \"a.d\")* string array (path \"a.e\")* bool array (path \"a.f.\")* float/integer claim (path \"a.g\")* float/integer array claims (path \"a.h\")）このマップの各値には、要求を追加する Rox トークン属性名が含まれています。たとえば、value が \"groups\" の場合、要求はトークンの \"external_user.Attributes.groups\" にあります。注記：この機能は OIDC 認証プロバイダーに対してのみサポートされます。
lastUpdated	Date	Last updated は、認証プロバイダーが最後に更新された時刻を示します。このタイムスタンプの前に認証プロバイダーによって発行されたトークンがあった場合、無効なと見なされます。その後、すべてのクライアントはトークンを再発行する必要があります（更新または追加のログイン試行のいずれか）。	date-time

5.5.7.5. StorageTraits

フィールド名	型	形式
mutabilityMode	TraitsMutabilityMode	ALLOW_MUTATE, ALLOW_MUTATE_FORCED,
visibility	TraitsVisibility	VISIBLE、HIDDEN、
origin	TraitsOrigin	命令、デフォルト、宣言的、DECLARATIVE_ORPHANED

5.5.7.6. TraitsMutabilityMode

Enum 値
ALLOW_MUTATE
ALLOW_MUTATE_FORCED

5.5.7.7. TraitsOrigin

Enum 値
命令
デフォルト
宣言的
DECLARATIVE_ORPHANED

5.5.7.8. TraitsVisibility

EXPERIMENTAL. 可視性により、特定の API に対してオブジェクトを表示するかどうかを指定できます。

Enum 値
VISIBLE
HIDDEN

5.5.7.9. V1UpdateAuthProviderRequest

フィールド名	必須	Null 許容型	型	説明	形式
id			String
name			String
enabled			Boolean

5.6. PutAuthProvider

PUT /v1/authProviders/{id}

5.6.1. 説明

5.6.2. パラメーター

5.6.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

5.6.2.2. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	StorageAuthProvider	X

5.6.3. 戻り値のタイプ

StorageAuthProvider

5.6.4. コンテンツタイプ

application/json

5.6.5. レスポンス

表5.6 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	StorageAuthProvider
0	予期しないエラーの応答です。	RuntimeError

5.6.6. サンプル

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

5.6.7.1. AuthProviderRequiredAttribute

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

5.6.7.2. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

5.6.7.2.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

5.6.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

5.6.7.4. StorageAuthProvider

次のタグ：15

フィールド名	型	説明	形式
id	String
name	String
type	String
uiEndpoint	String
enabled	Boolean
config	`文字列`のマップ	Config は認証プロバイダー固有の設定を保持します。各設定オプションは、指定の認証プロバイダータイプによって異なります。OIDC: - \"issuer\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier に準拠した OIDC 発行者。- \"client_id\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.2 に準拠したクライアント ID。- \"client_secret\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.3.1 に準拠したクライアントシークレットです。- - \"do_not_use_client_secret\": クライアント ID のみで、クライアントシークレットのない設定を作成する場合は \"true\" に設定します。- \"mode\": OIDC コールバックモード、または OIDC コールバックモード。オフライントークンが発行されない場合は、\"fragment\"、\"post\"、または \"query\": \"disable_offline_access_scope\": \"true\" に設定します。- \"extra_scopes\": https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 に従って、\"openid プロファイル email\" に加えて要求する追加のスコープのスペースで区切られた文字列。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。- \"idp_sso_url\": IdP SSO URL。- \"idp_nameid_format\": IdP 名 ID 形式。IAP: - \"audience\": 使用するオーディエンス。
loginUrl	String	ログイン URL はバックエンドにより提供され、リクエストで指定できない場合があります。
validated	Boolean
extraUiEndpoints	`string` のリスト	`ui_endpoint` に加えて許可する UI エンドポイント。つまり、ログインリクエストがこれらのいずれかから送信される場合、認証リクエストはこれらをコールバック URL に使用します(ui_endpoint ではなく)。
active	Boolean
requiredAttributes	AuthProviderRequiredAttributeのリスト
traits	StorageTraits
claimMappings	`文字列`のマップ	Rox トークン属性にコピーされる IdP トークンからの要求を指定します。このマップの各キーには、マップする IdP トークンのパスが含まれています。パスは \".\" 記号で区切られます。たとえば、IdP トークンペイロードが { \"a\": { \"b\" : \"c\", \"d\": true, \"e\": [ \"val1\", \"val2\", \"val3\" ], \"f\": [ true, false, false ], \"g\", 123.0, \"h\": [ 1、2, 3] } } で、\"a.b\" は有効なキーになり、\"a.z\" は有効ではありません。次のタイプの要求をサポートしています：* string (path \"a.b\")* bool (path \"a.d\")* string array (path \"a.e\")* bool array (path \"a.f.\")* float/integer claim (path \"a.g\")* float/integer array claims (path \"a.h\")）このマップの各値には、要求を追加する Rox トークン属性名が含まれています。たとえば、value が \"groups\" の場合、要求はトークンの \"external_user.Attributes.groups\" にあります。注記：この機能は OIDC 認証プロバイダーに対してのみサポートされます。
lastUpdated	Date	Last updated は、認証プロバイダーが最後に更新された時刻を示します。このタイムスタンプの前に認証プロバイダーによって発行されたトークンがあった場合、無効なと見なされます。その後、すべてのクライアントはトークンを再発行する必要があります（更新または追加のログイン試行のいずれか）。	date-time

5.6.7.5. StorageTraits

フィールド名	型	形式
mutabilityMode	TraitsMutabilityMode	ALLOW_MUTATE, ALLOW_MUTATE_FORCED,
visibility	TraitsVisibility	VISIBLE、HIDDEN、
origin	TraitsOrigin	命令、デフォルト、宣言的、DECLARATIVE_ORPHANED

5.6.7.6. TraitsMutabilityMode

Enum 値
ALLOW_MUTATE
ALLOW_MUTATE_FORCED

5.6.7.7. TraitsOrigin

Enum 値
命令
デフォルト
宣言的
DECLARATIVE_ORPHANED

5.6.7.8. TraitsVisibility

EXPERIMENTAL. 可視性により、特定の API に対してオブジェクトを表示するかどうかを指定できます。

Enum 値
VISIBLE
HIDDEN

5.7. PostAuthProvider

POST /v1/authProviders

5.7.1. 説明

5.7.2. パラメーター

5.7.2.1. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	StorageAuthProvider	X

5.7.3. 戻り値のタイプ

StorageAuthProvider

5.7.4. コンテンツタイプ

application/json

5.7.5. レスポンス

表5.7 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	StorageAuthProvider
0	予期しないエラーの応答です。	RuntimeError

5.7.6. サンプル

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

5.7.7.1. AuthProviderRequiredAttribute

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

5.7.7.2. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

5.7.7.2.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

5.7.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

5.7.7.4. StorageAuthProvider

次のタグ：15

フィールド名	型	説明	形式
id	String
name	String
type	String
uiEndpoint	String
enabled	Boolean
config	`文字列`のマップ	Config は認証プロバイダー固有の設定を保持します。各設定オプションは、指定の認証プロバイダータイプによって異なります。OIDC: - \"issuer\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier に準拠した OIDC 発行者。- \"client_id\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.2 に準拠したクライアント ID。- \"client_secret\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.3.1 に準拠したクライアントシークレットです。- - \"do_not_use_client_secret\": クライアント ID のみで、クライアントシークレットのない設定を作成する場合は \"true\" に設定します。- \"mode\": OIDC コールバックモード、または OIDC コールバックモード。オフライントークンが発行されない場合は、\"fragment\"、\"post\"、または \"query\": \"disable_offline_access_scope\": \"true\" に設定します。- \"extra_scopes\": https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 に従って、\"openid プロファイル email\" に加えて要求する追加のスコープのスペースで区切られた文字列。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。- \"idp_sso_url\": IdP SSO URL。- \"idp_nameid_format\": IdP 名 ID 形式。IAP: - \"audience\": 使用するオーディエンス。
loginUrl	String	ログイン URL はバックエンドにより提供され、リクエストで指定できない場合があります。
validated	Boolean
extraUiEndpoints	`string` のリスト	`ui_endpoint` に加えて許可する UI エンドポイント。つまり、ログインリクエストがこれらのいずれかから送信される場合、認証リクエストはこれらをコールバック URL に使用します(ui_endpoint ではなく)。
active	Boolean
requiredAttributes	AuthProviderRequiredAttributeのリスト
traits	StorageTraits
claimMappings	`文字列`のマップ	Rox トークン属性にコピーされる IdP トークンからの要求を指定します。このマップの各キーには、マップする IdP トークンのパスが含まれています。パスは \".\" 記号で区切られます。たとえば、IdP トークンペイロードが { \"a\": { \"b\" : \"c\", \"d\": true, \"e\": [ \"val1\", \"val2\", \"val3\" ], \"f\": [ true, false, false ], \"g\", 123.0, \"h\": [ 1、2, 3] } } で、\"a.b\" は有効なキーになり、\"a.z\" は有効ではありません。次のタイプの要求をサポートしています：* string (path \"a.b\")* bool (path \"a.d\")* string array (path \"a.e\")* bool array (path \"a.f.\")* float/integer claim (path \"a.g\")* float/integer array claims (path \"a.h\")）このマップの各値には、要求を追加する Rox トークン属性名が含まれています。たとえば、value が \"groups\" の場合、要求はトークンの \"external_user.Attributes.groups\" にあります。注記：この機能は OIDC 認証プロバイダーに対してのみサポートされます。
lastUpdated	Date	Last updated は、認証プロバイダーが最後に更新された時刻を示します。このタイムスタンプの前に認証プロバイダーによって発行されたトークンがあった場合、無効なと見なされます。その後、すべてのクライアントはトークンを再発行する必要があります（更新または追加のログイン試行のいずれか）。	date-time

5.7.7.5. StorageTraits

フィールド名	型	形式
mutabilityMode	TraitsMutabilityMode	ALLOW_MUTATE, ALLOW_MUTATE_FORCED,
visibility	TraitsVisibility	VISIBLE、HIDDEN、
origin	TraitsOrigin	命令、デフォルト、宣言的、DECLARATIVE_ORPHANED

5.7.7.6. TraitsMutabilityMode

Enum 値
ALLOW_MUTATE
ALLOW_MUTATE_FORCED

5.7.7.7. TraitsOrigin

Enum 値
命令
デフォルト
宣言的
DECLARATIVE_ORPHANED

5.7.7.8. TraitsVisibility

EXPERIMENTAL. 可視性により、特定の API に対してオブジェクトを表示するかどうかを指定できます。

Enum 値
VISIBLE
HIDDEN

5.8. ListAvailableProviderTypes

GET /v1/availableAuthProviders

5.8.1. 説明

5.8.2. パラメーター

5.8.3. 戻り値のタイプ

V1AvailableProviderTypesResponse

5.8.4. コンテンツタイプ

application/json

5.8.5. レスポンス

表5.8 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1AvailableProviderTypesResponse
0	予期しないエラーの応答です。	RuntimeError

5.8.6. サンプル

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

5.8.7.1. AvailableProviderTypesResponseAuthProviderType

フィールド名	必須	Null 許容型	型	説明	形式
type			String
suggestedAttributes			`string` のリスト

5.8.7.2. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

5.8.7.2.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

5.8.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

5.8.7.4. V1AvailableProviderTypesResponse

フィールド名	必須	Null 許容型	型	説明	形式
authProviderTypes			List of AvailableProviderTypesResponseAuthProviderType

5.9. GetLoginAuthProviders

GET /v1/login/authproviders

5.9.1. 説明

5.9.2. パラメーター

5.9.3. 戻り値のタイプ

V1GetLoginAuthProvidersResponse

5.9.4. コンテンツタイプ

application/json

5.9.5. レスポンス

表5.9 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GetLoginAuthProvidersResponse
0	予期しないエラーの応答です。	RuntimeError

5.9.6. サンプル

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

5.9.7.1. GetLoginAuthProvidersResponseLoginAuthProvider

フィールド名	必須	Null 許容型	型	説明	形式
id			String
name			String
type			String
loginUrl			String

5.9.7.2. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

5.9.7.2.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

5.9.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

5.9.7.4. V1GetLoginAuthProvidersResponse

フィールド名	必須	Null 許容型	型	説明	形式
authProviders			List of GetLoginAuthProvidersResponseLoginAuthProvider

第6章 AuthService

6.1. UpdateAuthMachineToMachineConfig

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

UpdateAuthMachineToMachineConfig は、既存の認証マシンをマシン設定に更新します。マシン設定への auth マシンが存在しない場合は、新しいマシン設定が作成されます。

6.1.1. 説明

6.1.2. パラメーター

6.1.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
config.id	設定の UUID。マシン設定に追加する際に、このフィールドは設定できないことに注意してください。	X	null

6.1.2.2. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1UpdateAuthMachineToMachineConfigRequest	X

6.1.3. 戻り値のタイプ

Object

6.1.4. コンテンツタイプ

application/json

6.1.5. レスポンス

表6.1 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	`Object`
0	予期しないエラーの応答です。	RuntimeError

6.1.6. サンプル

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

6.1.7.1. AuthMachineToMachineConfigMapping

マッピングにより、アイデンティティートークンのクレーム値が Central 内の特定のロールにマッピングされます。

フィールド名	型	説明
key	String	使用する ID トークンのクレーム値内のキー。
valueExpression	String	指定されたキーで識別されるアイデンティティートークンクレームの値に対して評価される正規表現。この正規表現は RE2 形式になります。https://github.com/google/re2/wiki/Syntax を参照してください。
role	String	キーと値が特定の ID トークンと一致するときに発行する必要があるロール。

6.1.7.2. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

6.1.7.2.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

6.1.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

6.1.7.4. V1AuthMachineToMachineConfig

AuthMachineToMachineConfig は、Central アクセストークンを使用して、サードパーティーから ID トークンを交換するためのルールを決定します。M2M は、設定の意図されたユースケースであるため、マシンへのマシンを表します。

フィールド名	型	説明	形式
id	String	設定の UUID。マシン設定に追加する際に、このフィールドは設定できないことに注意してください。
type	V1AuthMachineToMachineConfigType		GENERIC, GITHUB_ACTIONS,
tokenExpirationDuration	String	ExchangeAuthMachineToMachineToken API 呼び出しから返されるトークンの有効期限を設定します。有効な時間単位は、s、m、h です。最大許容有効期限は 24h です。たとえば、2h45m です。期間の検証に関する追加情報は、https://pkg.go.dev/time#ParseDuration を参照してください。
マッピング	List of AuthMachineToMachineConfigMapping	アクセストークンを正常に生成するには、有効なロールに対して解決するには、1 つ以上のマッピングが必要です。
issuer	String	交換する ID トークンを発行する、関連する OIDC プロバイダーの発行者。タイプが GENERIC の場合は、URL が含まれる空でない文字列である必要があります。GitHub アクションの場合、これは空であるか、https://token.actions.githubusercontent.com に設定する必要があります。発行者は一意のキーであるため、最大 1 つの GITHUB_ACTIONS 設定があり、各 GENERIC 設定には個別の発行者が必要です。

6.1.7.5. V1AuthMachineToMachineConfigType

マシン設定への認証マシンのタイプ。現在、トークンの検証および交換に使用する GitHub アクションまたはその他の汎用 OIDC プロバイダーをサポートしています。

Enum 値
GENERIC
GITHUB_ACTIONS

6.1.7.6. V1UpdateAuthMachineToMachineConfigRequest

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

6.2. ExchangeAuthMachineToMachineToken

POST /v1/auth/m2m/exchange

ExchangeAuthMachineToMachineToken は、設定された auth マシンに基づいて Central アクセストークンの特定の ID トークンをマシン設定に交換します。

6.2.1. 説明

6.2.2. パラメーター

6.2.2.1. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1ExchangeAuthMachineToMachineTokenRequest	X

6.2.3. 戻り値のタイプ

V1ExchangeAuthMachineToMachineTokenResponse

6.2.4. コンテンツタイプ

application/json

6.2.5. レスポンス

表6.2 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1ExchangeAuthMachineToMachineTokenResponse
0	予期しないエラーの応答です。	RuntimeError

6.2.6. サンプル

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

6.2.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

6.2.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

6.2.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

6.2.7.3. V1ExchangeAuthMachineToMachineTokenRequest

フィールド名	必須	Null 許容型	型	説明	形式
idToken			String	交換することが予想される ID トークン。

6.2.7.4. V1ExchangeAuthMachineToMachineTokenResponse

フィールド名	必須	Null 許容型	型	説明	形式
accessToken			String	交換されたアクセストークン。

6.3. ListAuthMachineToMachineConfigs

GET /v1/auth/m2m

ListAuthMachineToMachineConfigs は、マシン設定で利用可能な認証マシンを一覧表示します。

6.3.1. 説明

6.3.2. パラメーター

6.3.3. 戻り値のタイプ

V1ListAuthMachineToMachineConfigResponse

6.3.4. コンテンツタイプ

application/json

6.3.5. レスポンス

表6.3 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1ListAuthMachineToMachineConfigResponse
0	予期しないエラーの応答です。	RuntimeError

6.3.6. サンプル

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

6.3.7.1. AuthMachineToMachineConfigMapping

マッピングにより、アイデンティティートークンのクレーム値が Central 内の特定のロールにマッピングされます。

フィールド名	型	説明
key	String	使用する ID トークンのクレーム値内のキー。
valueExpression	String	指定されたキーで識別されるアイデンティティートークンクレームの値に対して評価される正規表現。この正規表現は RE2 形式になります。https://github.com/google/re2/wiki/Syntax を参照してください。
role	String	キーと値が特定の ID トークンと一致するときに発行する必要があるロール。

6.3.7.2. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

6.3.7.2.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

6.3.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

6.3.7.4. V1AuthMachineToMachineConfig

フィールド名	型	説明	形式
id	String	設定の UUID。マシン設定に追加する際に、このフィールドは設定できないことに注意してください。
type	V1AuthMachineToMachineConfigType		GENERIC, GITHUB_ACTIONS,
tokenExpirationDuration	String	ExchangeAuthMachineToMachineToken API 呼び出しから返されるトークンの有効期限を設定します。有効な時間単位は、s、m、h です。最大許容有効期限は 24h です。たとえば、2h45m です。期間の検証に関する追加情報は、https://pkg.go.dev/time#ParseDuration を参照してください。
マッピング	List of AuthMachineToMachineConfigMapping	アクセストークンを正常に生成するには、有効なロールに対して解決するには、1 つ以上のマッピングが必要です。
issuer	String	交換する ID トークンを発行する、関連する OIDC プロバイダーの発行者。タイプが GENERIC の場合は、URL が含まれる空でない文字列である必要があります。GitHub アクションの場合、これは空であるか、https://token.actions.githubusercontent.com に設定する必要があります。発行者は一意のキーであるため、最大 1 つの GITHUB_ACTIONS 設定があり、各 GENERIC 設定には個別の発行者が必要です。

6.3.7.5. V1AuthMachineToMachineConfigType

Enum 値
GENERIC
GITHUB_ACTIONS

6.3.7.6. V1ListAuthMachineToMachineConfigResponse

フィールド名	必須	Null 許容型	型	説明	形式
configs			List of V1AuthMachineToMachineConfig

6.4. DeleteAuthMachineToMachineConfig

DELETE /v1/auth/m2m/{id}

DeleteAuthMachineToMachineConfig は、特定の認証マシンをマシン設定から削除します。マシン設定に指定された auth マシンが削除されても、エラーが返されません。

6.4.1. 説明

6.4.2. パラメーター

6.4.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

6.4.3. 戻り値のタイプ

Object

6.4.4. コンテンツタイプ

application/json

6.4.5. レスポンス

表6.4 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	`Object`
0	予期しないエラーの応答です。	RuntimeError

6.4.6. サンプル

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

6.4.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

6.4.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

6.4.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

6.5. GetAuthMachineToMachineConfig

GET /v1/auth/m2m/{id}

GetAuthMachineToMachineConfig は、特定の認証マシンをマシン設定に取得します。

6.5.1. 説明

6.5.2. パラメーター

6.5.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

6.5.3. 戻り値のタイプ

V1GetAuthMachineToMachineConfigResponse

6.5.4. コンテンツタイプ

application/json

6.5.5. レスポンス

表6.5 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GetAuthMachineToMachineConfigResponse
0	予期しないエラーの応答です。	RuntimeError

6.5.6. サンプル

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

6.5.7.1. AuthMachineToMachineConfigMapping

マッピングにより、アイデンティティートークンのクレーム値が Central 内の特定のロールにマッピングされます。

フィールド名	型	説明
key	String	使用する ID トークンのクレーム値内のキー。
valueExpression	String	指定されたキーで識別されるアイデンティティートークンクレームの値に対して評価される正規表現。この正規表現は RE2 形式になります。https://github.com/google/re2/wiki/Syntax を参照してください。
role	String	キーと値が特定の ID トークンと一致するときに発行する必要があるロール。

6.5.7.2. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

6.5.7.2.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

6.5.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

6.5.7.4. V1AuthMachineToMachineConfig

フィールド名	型	説明	形式
id	String	設定の UUID。マシン設定に追加する際に、このフィールドは設定できないことに注意してください。
type	V1AuthMachineToMachineConfigType		GENERIC, GITHUB_ACTIONS,
tokenExpirationDuration	String	ExchangeAuthMachineToMachineToken API 呼び出しから返されるトークンの有効期限を設定します。有効な時間単位は、s、m、h です。最大許容有効期限は 24h です。たとえば、2h45m です。期間の検証に関する追加情報は、https://pkg.go.dev/time#ParseDuration を参照してください。
マッピング	List of AuthMachineToMachineConfigMapping	アクセストークンを正常に生成するには、有効なロールに対して解決するには、1 つ以上のマッピングが必要です。
issuer	String	交換する ID トークンを発行する、関連する OIDC プロバイダーの発行者。タイプが GENERIC の場合は、URL が含まれる空でない文字列である必要があります。GitHub アクションの場合、これは空であるか、https://token.actions.githubusercontent.com に設定する必要があります。発行者は一意のキーであるため、最大 1 つの GITHUB_ACTIONS 設定があり、各 GENERIC 設定には個別の発行者が必要です。

6.5.7.5. V1AuthMachineToMachineConfigType

Enum 値
GENERIC
GITHUB_ACTIONS

6.5.7.6. V1GetAuthMachineToMachineConfigResponse

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

6.6. AddAuthMachineToMachineConfig

POST /v1/auth/m2m

AddAuthMachineToMachineConfig は、マシン設定への新規の auth マシンを作成します。

6.6.1. 説明

6.6.2. パラメーター

6.6.2.1. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1AddAuthMachineToMachineConfigRequest	X

6.6.3. 戻り値のタイプ

V1AddAuthMachineToMachineConfigResponse

6.6.4. コンテンツタイプ

application/json

6.6.5. レスポンス

表6.6 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1AddAuthMachineToMachineConfigResponse
0	予期しないエラーの応答です。	RuntimeError

6.6.6. サンプル

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

6.6.7.1. AuthMachineToMachineConfigMapping

マッピングにより、アイデンティティートークンのクレーム値が Central 内の特定のロールにマッピングされます。

フィールド名	型	説明
key	String	使用する ID トークンのクレーム値内のキー。
valueExpression	String	指定されたキーで識別されるアイデンティティートークンクレームの値に対して評価される正規表現。この正規表現は RE2 形式になります。https://github.com/google/re2/wiki/Syntax を参照してください。
role	String	キーと値が特定の ID トークンと一致するときに発行する必要があるロール。

6.6.7.2. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

6.6.7.2.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

6.6.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

6.6.7.4. V1AddAuthMachineToMachineConfigRequest

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

6.6.7.5. V1AddAuthMachineToMachineConfigResponse

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

6.6.7.6. V1AuthMachineToMachineConfig

フィールド名	型	説明	形式
id	String	設定の UUID。マシン設定に追加する際に、このフィールドは設定できないことに注意してください。
type	V1AuthMachineToMachineConfigType		GENERIC, GITHUB_ACTIONS,
tokenExpirationDuration	String	ExchangeAuthMachineToMachineToken API 呼び出しから返されるトークンの有効期限を設定します。有効な時間単位は、s、m、h です。最大許容有効期限は 24h です。たとえば、2h45m です。期間の検証に関する追加情報は、https://pkg.go.dev/time#ParseDuration を参照してください。
マッピング	List of AuthMachineToMachineConfigMapping	アクセストークンを正常に生成するには、有効なロールに対して解決するには、1 つ以上のマッピングが必要です。
issuer	String	交換する ID トークンを発行する、関連する OIDC プロバイダーの発行者。タイプが GENERIC の場合は、URL が含まれる空でない文字列である必要があります。GitHub アクションの場合、これは空であるか、https://token.actions.githubusercontent.com に設定する必要があります。発行者は一意のキーであるため、最大 1 つの GITHUB_ACTIONS 設定があり、各 GENERIC 設定には個別の発行者が必要です。

6.6.7.7. V1AuthMachineToMachineConfigType

Enum 値
GENERIC
GITHUB_ACTIONS

6.7. GetAuthStatus

GET /v1/auth/status

GetAuthStatus は、現在のクライアントのステータスを返します。

6.7.1. 説明

6.7.2. パラメーター

6.7.3. 戻り値のタイプ

V1AuthStatus

6.7.4. コンテンツタイプ

application/json

6.7.5. レスポンス

表6.7 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1AuthStatus
0	予期しないエラーの応答です。	RuntimeError

6.7.6. サンプル

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

6.7.7.1. AuthProviderRequiredAttribute

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

6.7.7.2. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

6.7.7.2.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

6.7.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

6.7.7.4. StorageAccess

Enum 値
NO_ACCESS
READ_ACCESS
READ_WRITE_ACCESS

6.7.7.5. StorageAuthProvider

次のタグ：15

フィールド名	型	説明	形式
id	String
name	String
type	String
uiEndpoint	String
enabled	Boolean
config	`文字列`のマップ	Config は認証プロバイダー固有の設定を保持します。各設定オプションは、指定の認証プロバイダータイプによって異なります。OIDC: - \"issuer\": https://openid.net/specs/openid-connect-core-1_0.html#IssuerIdentifier に準拠した OIDC 発行者。- \"client_id\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.2 に準拠したクライアント ID。- \"client_secret\": https://www.rfc-editor.org/rfc/rfc6749.html#section-2.3.1 に準拠したクライアントシークレットです。- - \"do_not_use_client_secret\": クライアント ID のみで、クライアントシークレットのない設定を作成する場合は \"true\" に設定します。- \"mode\": OIDC コールバックモード、または OIDC コールバックモード。オフライントークンが発行されない場合は、\"fragment\"、\"post\"、または \"query\": \"disable_offline_access_scope\": \"true\" に設定します。- \"extra_scopes\": https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 に従って、\"openid プロファイル email\" に加えて要求する追加のスコープのスペースで区切られた文字列。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。- \"idp_sso_url\": IdP SSO URL。- \"idp_nameid_format\": IdP 名 ID 形式。IAP: - \"audience\": 使用するオーディエンス。
loginUrl	String	ログイン URL はバックエンドにより提供され、リクエストで指定できない場合があります。
validated	Boolean
extraUiEndpoints	`string` のリスト	`ui_endpoint` に加えて許可する UI エンドポイント。つまり、ログインリクエストがこれらのいずれかから送信される場合、認証リクエストはこれらをコールバック URL に使用します(ui_endpoint ではなく)。
active	Boolean
requiredAttributes	AuthProviderRequiredAttributeのリスト
traits	StorageTraits
claimMappings	`文字列`のマップ	Rox トークン属性にコピーされる IdP トークンからの要求を指定します。このマップの各キーには、マップする IdP トークンのパスが含まれています。パスは \".\" 記号で区切られます。たとえば、IdP トークンペイロードが { \"a\": { \"b\" : \"c\", \"d\": true, \"e\": [ \"val1\", \"val2\", \"val3\" ], \"f\": [ true, false, false ], \"g\", 123.0, \"h\": [ 1、2, 3] } } で、\"a.b\" は有効なキーになり、\"a.z\" は有効ではありません。次のタイプの要求をサポートしています：* string (path \"a.b\")* bool (path \"a.d\")* string array (path \"a.e\")* bool array (path \"a.f.\")* float/integer claim (path \"a.g\")* float/integer array claims (path \"a.h\")）このマップの各値には、要求を追加する Rox トークン属性名が含まれています。たとえば、value が \"groups\" の場合、要求はトークンの \"external_user.Attributes.groups\" にあります。注記：この機能は OIDC 認証プロバイダーに対してのみサポートされます。
lastUpdated	Date	Last updated は、認証プロバイダーが最後に更新された時刻を示します。このタイムスタンプの前に認証プロバイダーによって発行されたトークンがあった場合、無効なと見なされます。その後、すべてのクライアントはトークンを再発行する必要があります（更新または追加のログイン試行のいずれか）。	date-time

6.7.7.6. StorageServiceIdentity

フィールド名	型	形式
serialStr	String
serial	String	int64
id	String
type	StorageServiceType	UNKNOWN_SERVICE、SENSOR_SERVICE、CENTRAL_SERVICE、CENTRAL_DB_SERVICE、REMOTE_SERVICE、COLLECTOR_SERVICE、MONITORING_UI_SERVICE、MONITORING_DB_SERVICE、MONITORING_CLIENT_SERVICE、ASNCHMARK_SERVICE、SCANNER_SERVICE、SCANNER_DB_SERVICE、ADMISSION_CONTROL_SERVICE、SCANNER_V4_INDEXER_SERVICE、SCANNER_V4_MATCHER_SERVICE、SCANNER_V4_DB_SERVICE、
initBundleId	String

6.7.7.7. StorageServiceType

Next available tag: 16

Enum 値
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

6.7.7.8. StorageTraits

フィールド名	型	形式
mutabilityMode	TraitsMutabilityMode	ALLOW_MUTATE, ALLOW_MUTATE_FORCED,
visibility	TraitsVisibility	VISIBLE、HIDDEN、
origin	TraitsOrigin	命令、デフォルト、宣言的、DECLARATIVE_ORPHANED

6.7.7.9. StorageUserInfo

フィールド名	必須	Null 許容型	型	説明	形式
username			String
friendlyName			String
permissions			UserInfoResourceToAccess
roles			StorageUserInfoRoleのリスト

6.7.7.10. StorageUserInfoRole

ロールは、古い storage.Role 形式との互換性があるため、ロール名と関連するパーミッションのみが含まれます。

フィールド名	必須	Null 許容型	型	説明	形式
name			String
resourceToAccess			StorageAccessのマップ

6.7.7.11. TraitsMutabilityMode

Enum 値
ALLOW_MUTATE
ALLOW_MUTATE_FORCED

6.7.7.12. TraitsOrigin

Enum 値
命令
デフォルト
宣言的
DECLARATIVE_ORPHANED

6.7.7.13. TraitsVisibility

EXPERIMENTAL. 可視性により、特定の API に対してオブジェクトを表示するかどうかを指定できます。

Enum 値
VISIBLE
HIDDEN

6.7.7.14. UserInfoResourceToAccess

フィールド名	必須	Null 許容型	型	説明	形式
resourceToAccess			StorageAccessのマップ

6.7.7.15. V1AuthStatus

フィールド名	型	説明	形式
userId	String
serviceId	StorageServiceIdentity
Expires	Date		date-time
refreshUrl	String
authProvider	StorageAuthProvider
userInfo	StorageUserInfo
userAttributes	V1UserAttributeのリスト
idpToken	String	基礎となる ID プロバイダーによって ACS に返されるトークン。このフィールドは、いくつかの特定のコンテキストでのみ設定されます。応答に存在するこのフィールドに依存しないでください。

6.7.7.16. V1UserAttribute

フィールド名	必須	Null 許容型	型	説明	形式
key			String
values			`string` のリスト

第7章 CentralHealthService

7.1. GetUpgradeStatus

GET /v1/centralhealth/upgradestatus

7.1.1. 説明

7.1.2. パラメーター

7.1.3. 戻り値のタイプ

V1GetUpgradeStatusResponse

7.1.4. コンテンツタイプ

application/json

7.1.5. レスポンス

表7.1 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GetUpgradeStatusResponse
0	予期しないエラーの応答です。	RuntimeError

7.1.6. サンプル

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

7.1.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

7.1.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

7.1.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

7.1.7.3. V1CentralUpgradeStatus

フィールド名	型	説明	形式
version	String
forceRollbackTo	String	Central における以前のクローンのバージョン。これは、強制的にロールバックできるバージョンです。
canRollbackAfterUpgrade	Boolean	true の場合、アップグレードに失敗した場合に現行バージョンにロールバックできます。
spaceRequiredForRollbackAfterUpgrade	String		int64
spaceAvailableForRollbackAfterUpgrade	String		int64

7.1.7.4. V1GetUpgradeStatusResponse

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

第8章 CloudSourcesService

8.1. UpdateCloudSource

PUT /v1/cloud-sources/{cloudSource.id}

UpdateCloudSource はクラウドソースを作成または置き換えます。

8.1.1. 説明

8.1.2. パラメーター

8.1.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
cloudSource.id		X	null

8.1.2.2. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1UpdateCloudSourceRequest	X

8.1.3. 戻り値のタイプ

Object

8.1.4. コンテンツタイプ

application/json

8.1.5. レスポンス

表8.1 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	`Object`
0	予期しないエラーの応答です。	RuntimeError

8.1.6. サンプル

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

8.1.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

8.1.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

8.1.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

8.1.7.3. V1CloudSource

CloudSource は、検出されたクラスターのソースを提供するインテグレーションです。

フィールド名	型	形式
id	String
name	String
type	V1CloudSourceType	TYPE_UNSPECIFIED, TYPE_PALADIN_CLOUD, TYPE_OCM,
credentials	V1CloudSourceCredentials
skipTestIntegration	Boolean
paladinCloud	V1PaladinCloudConfig
ocm	V1OCMConfig

8.1.7.4. V1CloudSourceCredentials

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

8.1.7.5. V1CloudSourceType

Enum 値
TYPE_UNSPECIFIED
TYPE_PALADIN_CLOUD
TYPE_OCM

8.1.7.6. V1OCMConfig

OCMConfig は、OpenShift クラスターマネージャーから検出されたクラスターを取得するために必要な情報を提供します。

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

8.1.7.7. V1PaladinCloudConfig

PaladinCloudConfig は、Paladin Cloud から検出されたクラスターをフェッチするために必要な情報を提供します。

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

8.1.7.8. V1UpdateCloudSourceRequest

フィールド名	必須	Null 許容型	型	説明	形式
cloudSource			V1CloudSource
updateCredentials			Boolean	true の場合、cloud_source には有効な認証情報が含まれている必要があります。false の場合、リソースがすでに存在し、cloud_source の認証情報は無視されます。

8.2. ListCloudSources

GET /v1/cloud-sources

ListCloudSources は、要求されたフィールドでフィルターされた後にクラウドソースの一覧を返します。

8.2.1. 説明

8.2.2. パラメーター

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

名前	説明	必須	デフォルト
pagination.limit		-	null
pagination.offset		-	null
pagination.sortOption.field		-	null
pagination.sortOption.reversed		-	null
pagination.sortOption.aggregateBy.aggrFunc		-	UNSET
pagination.sortOption.aggregateBy.distinct		-	null
filter.names	名前をもとにクラウドソースを照合します。`String`	-	null
filter.types	それらのタイプに基づいてクラウドソースをマッチします。`String`	-	null

8.2.3. 戻り値のタイプ

V1ListCloudSourcesResponse

8.2.4. コンテンツタイプ

application/json

8.2.5. レスポンス

表8.2 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1ListCloudSourcesResponse
0	予期しないエラーの応答です。	RuntimeError

8.2.6. サンプル

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

8.2.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

8.2.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

8.2.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

8.2.7.3. V1CloudSource

CloudSource は、検出されたクラスターのソースを提供するインテグレーションです。

フィールド名	型	形式
id	String
name	String
type	V1CloudSourceType	TYPE_UNSPECIFIED, TYPE_PALADIN_CLOUD, TYPE_OCM,
credentials	V1CloudSourceCredentials
skipTestIntegration	Boolean
paladinCloud	V1PaladinCloudConfig
ocm	V1OCMConfig

8.2.7.4. V1CloudSourceCredentials

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

8.2.7.5. V1CloudSourceType

Enum 値
TYPE_UNSPECIFIED
TYPE_PALADIN_CLOUD
TYPE_OCM

8.2.7.6. V1ListCloudSourcesResponse

フィールド名	必須	Null 許容型	型	説明	形式
cloudSources			V1CloudSourceのリスト

8.2.7.7. V1OCMConfig

OCMConfig は、OpenShift クラスターマネージャーから検出されたクラスターを取得するために必要な情報を提供します。

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

8.2.7.8. V1PaladinCloudConfig

PaladinCloudConfig は、Paladin Cloud から検出されたクラスターをフェッチするために必要な情報を提供します。

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

8.3. DeleteCloudSource

DELETE /v1/cloud-sources/{id}

DeleteCloudSource はクラウドソースを削除します。

8.3.1. 説明

8.3.2. パラメーター

8.3.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

8.3.3. 戻り値のタイプ

Object

8.3.4. コンテンツタイプ

application/json

8.3.5. レスポンス

表8.3 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	`Object`
0	予期しないエラーの応答です。	RuntimeError

8.3.6. サンプル

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

8.3.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

8.3.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

8.3.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

8.4. GetCloudSource

GET /v1/cloud-sources/{id}

GetCloudSource は、ID によってクラウドソースを取得します。

8.4.1. 説明

8.4.2. パラメーター

8.4.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

8.4.3. 戻り値のタイプ

V1GetCloudSourceResponse

8.4.4. コンテンツタイプ

application/json

8.4.5. レスポンス

表8.4 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GetCloudSourceResponse
0	予期しないエラーの応答です。	RuntimeError

8.4.6. サンプル

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

8.4.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

8.4.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

8.4.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

8.4.7.3. V1CloudSource

CloudSource は、検出されたクラスターのソースを提供するインテグレーションです。

フィールド名	型	形式
id	String
name	String
type	V1CloudSourceType	TYPE_UNSPECIFIED, TYPE_PALADIN_CLOUD, TYPE_OCM,
credentials	V1CloudSourceCredentials
skipTestIntegration	Boolean
paladinCloud	V1PaladinCloudConfig
ocm	V1OCMConfig

8.4.7.4. V1CloudSourceCredentials

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

8.4.7.5. V1CloudSourceType

Enum 値
TYPE_UNSPECIFIED
TYPE_PALADIN_CLOUD
TYPE_OCM

8.4.7.6. V1GetCloudSourceResponse

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

8.4.7.7. V1OCMConfig

OCMConfig は、OpenShift クラスターマネージャーから検出されたクラスターを取得するために必要な情報を提供します。

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

8.4.7.8. V1PaladinCloudConfig

PaladinCloudConfig は、Paladin Cloud から検出されたクラスターをフェッチするために必要な情報を提供します。

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

8.5. CreateCloudSource

POST /v1/cloud-sources

CreateCloudSource はクラウドソースを作成します。

8.5.1. 説明

8.5.2. パラメーター

8.5.2.1. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1CreateCloudSourceRequest	X

8.5.3. 戻り値のタイプ

V1CreateCloudSourceResponse

8.5.4. コンテンツタイプ

application/json

8.5.5. レスポンス

表8.5 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1CreateCloudSourceResponse
0	予期しないエラーの応答です。	RuntimeError

8.5.6. サンプル

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

8.5.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

8.5.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

8.5.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

8.5.7.3. V1CloudSource

CloudSource は、検出されたクラスターのソースを提供するインテグレーションです。

フィールド名	型	形式
id	String
name	String
type	V1CloudSourceType	TYPE_UNSPECIFIED, TYPE_PALADIN_CLOUD, TYPE_OCM,
credentials	V1CloudSourceCredentials
skipTestIntegration	Boolean
paladinCloud	V1PaladinCloudConfig
ocm	V1OCMConfig

8.5.7.4. V1CloudSourceCredentials

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

8.5.7.5. V1CloudSourceType

Enum 値
TYPE_UNSPECIFIED
TYPE_PALADIN_CLOUD
TYPE_OCM

8.5.7.6. V1CreateCloudSourceRequest

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

8.5.7.7. V1CreateCloudSourceResponse

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

8.5.7.8. V1OCMConfig

OCMConfig は、OpenShift クラスターマネージャーから検出されたクラスターを取得するために必要な情報を提供します。

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

8.5.7.9. V1PaladinCloudConfig

PaladinCloudConfig は、Paladin Cloud から検出されたクラスターをフェッチするために必要な情報を提供します。

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

8.6. TestCloudSource

POST /v1/cloud-sources/test

TestCloudSource はクラウドソースをテストします。

8.6.1. 説明

8.6.2. パラメーター

8.6.2.1. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1TestCloudSourceRequest	X

8.6.3. 戻り値のタイプ

Object

8.6.4. コンテンツタイプ

application/json

8.6.5. レスポンス

表8.6 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	`Object`
0	予期しないエラーの応答です。	RuntimeError

8.6.6. サンプル

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

8.6.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

8.6.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

8.6.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

8.6.7.3. V1CloudSource

CloudSource は、検出されたクラスターのソースを提供するインテグレーションです。

フィールド名	型	形式
id	String
name	String
type	V1CloudSourceType	TYPE_UNSPECIFIED, TYPE_PALADIN_CLOUD, TYPE_OCM,
credentials	V1CloudSourceCredentials
skipTestIntegration	Boolean
paladinCloud	V1PaladinCloudConfig
ocm	V1OCMConfig

8.6.7.4. V1CloudSourceCredentials

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

8.6.7.5. V1CloudSourceType

Enum 値
TYPE_UNSPECIFIED
TYPE_PALADIN_CLOUD
TYPE_OCM

8.6.7.6. V1OCMConfig

OCMConfig は、OpenShift クラスターマネージャーから検出されたクラスターを取得するために必要な情報を提供します。

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

8.6.7.7. V1PaladinCloudConfig

PaladinCloudConfig は、Paladin Cloud から検出されたクラスターをフェッチするために必要な情報を提供します。

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

8.6.7.8. V1TestCloudSourceRequest

フィールド名	必須	Null 許容型	型	説明	形式
cloudSource			V1CloudSource
updateCredentials			Boolean	true の場合、cloud_source には有効な認証情報が含まれている必要があります。false の場合、リソースがすでに存在し、cloud_source の認証情報は無視されます。

8.7. CountCloudSources

GET /v1/count/cloud-sources

CountCloudSources は、要求されたフィールドによるフィルタリング後にクラウドソースの数を返します。

8.7.1. 説明

8.7.2. パラメーター

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

名前	説明	必須	デフォルト	Pattern
filter.names	名前をもとにクラウドソースを照合します。`String`	-	null
filter.types	それらのタイプに基づいてクラウドソースをマッチします。`String`	-	null

8.7.3. 戻り値のタイプ

V1CountCloudSourcesResponse

8.7.4. コンテンツタイプ

application/json

8.7.5. レスポンス

表8.7 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1CountCloudSourcesResponse
0	予期しないエラーの応答です。	RuntimeError

8.7.6. サンプル

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

8.7.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

8.7.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

8.7.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

8.7.7.3. V1CountCloudSourcesResponse

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

第9章 ClusterCVEService

9.1. SuppressCVEs

PATCH /v1/clustercves/suppress

SuppressCVE はクラスター cves を抑制します。

9.1.1. 説明

9.1.2. パラメーター

9.1.2.1. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1SuppressCVERequest	X

9.1.3. 戻り値のタイプ

Object

9.1.4. コンテンツタイプ

application/json

9.1.5. レスポンス

表9.1 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	`Object`
0	予期しないエラーの応答です。	RuntimeError

9.1.6. サンプル

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

9.1.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

9.1.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

9.1.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

9.1.7.3. V1SuppressCVERequest

フィールド名	必須	Null 許容型	型	説明	形式
cves			`string` のリスト	これらは、`id` フィールドではなく、`storage.CVE` の脆弱性識別子(NVD)です。たとえば、CVE-2021-44832 です。
duration			String

9.2. UnsuppressCVEs

PATCH /v1/clustercves/unsuppress

UnsuppressCVE は、クラスター cves を表示しません。

9.2.1. 説明

9.2.2. パラメーター

9.2.2.1. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1UnsuppressCVERequest	X

9.2.3. 戻り値のタイプ

Object

9.2.4. コンテンツタイプ

application/json

9.2.5. レスポンス

表9.2 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	`Object`
0	予期しないエラーの応答です。	RuntimeError

9.2.6. サンプル

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

9.2.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

9.2.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

9.2.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

9.2.7.3. V1UnsuppressCVERequest

フィールド名	必須	Null 許容型	型	説明	形式
cves			`string` のリスト	これらは、`id` フィールドではなく、`storage.CVE` の脆弱性識別子(NVD)です。たとえば、CVE-2021-44832 です。

第10章 ClusterInitService

10.1. GetCAConfig

GET /v1/cluster-init/ca-config

10.1.1. 説明

10.1.2. パラメーター

10.1.3. 戻り値のタイプ

V1GetCAConfigResponse

10.1.4. コンテンツタイプ

application/json

10.1.5. レスポンス

表10.1 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GetCAConfigResponse
0	予期しないエラーの応答です。	RuntimeError

10.1.6. サンプル

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

10.1.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

10.1.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

10.1.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

10.1.7.3. V1GetCAConfigResponse

フィールド名	必須	Null 許容型	型	説明	形式
helmValuesBundle			byte[]		byte

10.2. GetInitBundles

GET /v1/cluster-init/init-bundles

10.2.1. 説明

10.2.2. パラメーター

10.2.3. 戻り値のタイプ

V1InitBundleMetasResponse

10.2.4. コンテンツタイプ

application/json

10.2.5. レスポンス

表10.2 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1InitBundleMetasResponse
0	予期しないエラーの応答です。	RuntimeError

10.2.6. サンプル

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

10.2.7.1. InitBundleMetaImpactedCluster

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

10.2.7.2. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

10.2.7.2.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

10.2.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

10.2.7.4. StorageUser

ユーザーとは、ユーザーが関連付けられているロール、およびログイン方法を追跡できるようにするオブジェクトです。

フィールド名	必須	Null 許容型	型	説明	形式
id			String
authProviderId			String
attributes			StorageUserAttributeのリスト
idpToken			String

10.2.7.5. StorageUserAttribute

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

10.2.7.6. V1InitBundleMeta

フィールド名	型	形式
id	String
name	String
impactedClusters	List of InitBundleMetaImpactedCluster
createdAt	Date	date-time
createdBy	StorageUser
expiresAt	Date	date-time

10.2.7.7. V1InitBundleMetasResponse

フィールド名	必須	Null 許容型	型	説明	形式
items			V1InitBundleMetaのリスト

10.3. GenerateInitBundle

POST /v1/cluster-init/init-bundles

10.3.1. 説明

10.3.2. パラメーター

10.3.2.1. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1InitBundleGenRequest	X

10.3.3. 戻り値のタイプ

V1InitBundleGenResponse

10.3.4. コンテンツタイプ

application/json

10.3.5. レスポンス

表10.3 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1InitBundleGenResponse
0	予期しないエラーの応答です。	RuntimeError

10.3.6. サンプル

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

10.3.7.1. InitBundleMetaImpactedCluster

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

10.3.7.2. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

10.3.7.2.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

10.3.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

10.3.7.4. StorageUser

ユーザーとは、ユーザーが関連付けられているロール、およびログイン方法を追跡できるようにするオブジェクトです。

フィールド名	必須	Null 許容型	型	説明	形式
id			String
authProviderId			String
attributes			StorageUserAttributeのリスト
idpToken			String

10.3.7.5. StorageUserAttribute

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

10.3.7.6. V1InitBundleGenRequest

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

10.3.7.7. V1InitBundleGenResponse

フィールド名	型	形式
meta	V1InitBundleMeta
helmValuesBundle	byte[]	byte
kubectlBundle	byte[]	byte

10.3.7.8. V1InitBundleMeta

フィールド名	型	形式
id	String
name	String
impactedClusters	List of InitBundleMetaImpactedCluster
createdAt	Date	date-time
createdBy	StorageUser
expiresAt	Date	date-time

10.4. RevokeInitBundle

PATCH /v1/cluster-init/init-bundles/revoke

RevokeInitBundle は、クラスター init バンドルを削除します。この操作がクラスターに影響を及ぼす場合は、その ID をリクエストに含める必要があります。confirm_impacted_clusters_ids が現在の影響を受けるクラスターと一致しない場合、リクエストは影響を受けるすべてのクラスターを含むエラーで失敗します。

10.4.1. 説明

10.4.2. パラメーター

10.4.2.1. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1InitBundleRevokeRequest	X

10.4.3. 戻り値のタイプ

V1InitBundleRevokeResponse

10.4.4. コンテンツタイプ

application/json

10.4.5. レスポンス

表10.4 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1InitBundleRevokeResponse
0	予期しないエラーの応答です。	RuntimeError

10.4.6. サンプル

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

10.4.7.1. InitBundleMetaImpactedCluster

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

10.4.7.2. InitBundleRevokeResponseInitBundleRevocationError

フィールド名	必須	Null 許容型	型	説明	形式
id			String
error			String
impactedClusters			List of InitBundleMetaImpactedCluster

10.4.7.3. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

10.4.7.3.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

10.4.7.4. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

10.4.7.5. V1InitBundleRevokeRequest

フィールド名	必須	Null 許容型	型	説明	形式
ids			`string` のリスト
confirmImpactedClustersIds			`string` のリスト

10.4.7.6. V1InitBundleRevokeResponse

フィールド名	必須	Null 許容型	型	説明	形式
initBundleRevocationErrors			List of InitBundleRevokeResponseInitBundleRevocationError
initBundleRevokedIds			`string` のリスト

第11章 ClustersService

11.1. GetClusterDefaultValues

GET /v1/cluster-defaults

11.1.1. 説明

11.1.2. パラメーター

11.1.3. 戻り値のタイプ

V1ClusterDefaultsResponse

11.1.4. コンテンツタイプ

application/json

11.1.5. レスポンス

表11.1 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1ClusterDefaultsResponse
0	予期しないエラーの応答です。	RuntimeError

11.1.6. サンプル

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

11.1.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

11.1.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

11.1.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

11.1.7.3. V1ClusterDefaultsResponse

フィールド名	必須	Null 許容型	型	説明	形式
mainImageRepository			String
collectorImageRepository			String
kernelSupportAvailable			Boolean

11.2. GetKernelSupportAvailable

GET /v1/clusters-env/kernel-support-available

GetKernelSupportAvailable は非推奨となり、GetClusterDefaultValues が優先されます。

11.2.1. 説明

11.2.2. パラメーター

11.2.3. 戻り値のタイプ

V1KernelSupportAvailableResponse

11.2.4. コンテンツタイプ

application/json

11.2.5. レスポンス

表11.2 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1KernelSupportAvailableResponse
0	予期しないエラーの応答です。	RuntimeError

11.2.6. サンプル

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

11.2.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

11.2.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

11.2.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

11.2.7.3. V1KernelSupportAvailableResponse

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

11.3. GetClusters

GET /v1/clusters

11.3.1. 説明

11.3.2. パラメーター

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

名前	説明	必須	デフォルト	Pattern
query		-	null

11.3.3. 戻り値のタイプ

V1ClustersList

11.3.4. コンテンツタイプ

application/json

11.3.5. レスポンス

表11.3 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1ClustersList
0	予期しないエラーの応答です。	RuntimeError

11.3.6. サンプル

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

11.3.7.1. ClusterHealthStatusHealthStatusLabel

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

Enum 値
UNINITIALIZED
利用できません
UNHEALTHY
DEGRADED
HEALTHY

11.3.7.2. ClusterUpgradeStatusUpgradability

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

Enum 値
UNSET
UP_TO_DATE
MANUAL_UPGRADE_REQUIRED
AUTO_UPGRADE_POSSIBLE
SENSOR_VERSION_HIGHER

11.3.7.3. ClusterUpgradeStatusUpgradeProcessStatus

フィールド名	型	形式
active	Boolean
id	String
targetVersion	String
upgraderImage	String
initiatedAt	Date	date-time
progress	StorageUpgradeProgress
type	UpgradeProcessStatusUpgradeProcessType	UPGRADE、CERT_ROTATION、

11.3.7.4. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

11.3.7.4.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

11.3.7.5. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

11.3.7.6. StorageAWSProviderMetadata

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

11.3.7.7. StorageAdmissionControlHealthInfo

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

フィールド名	型	説明	形式
totalDesiredPods	Integer		int32
totalReadyPods	Integer		int32
statusErrors	`string` のリスト	アドミッションコントロールのヘルス情報を取得する際に発生したエラーのコレクション。

11.3.7.8. StorageAdmissionControllerConfig

フィールド名	型	形式
enabled	Boolean
timeoutSeconds	Integer	int32
scanInline	Boolean
disableBypass	Boolean
enforceOnUpdates	Boolean

11.3.7.9. StorageAuditLogFileState

AuditLogFileState tracks the last audit log event timestamp and ID that was collected by Compliance For internal use only

フィールド名	必須	Null 許容型	型	説明	形式
collectLogsSince			Date		date-time
lastAuditId			String

11.3.7.10. StorageAzureProviderMetadata

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

11.3.7.11. StorageCluster

フィールド名	型	説明	形式
id	String
name	String
type	StorageClusterType		GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,
labels	`文字列`のマップ
mainImage	String
collectorImage	String
centralApiEndpoint	String
runtimeSupport	Boolean
collectionMethod	StorageCollectionMethod		UNSET_COLLECTION、NO_COLLECTION、KERNEL_MODULE、EBPF、CORE_BPF
admissionController	Boolean
admissionControllerUpdates	Boolean
admissionControllerEvents	Boolean
status	StorageClusterStatus
dynamicConfig	StorageDynamicClusterConfig
tolerationsConfig	StorageTolerationsConfig
priority	String		int64
healthStatus	StorageClusterHealthStatus
slimCollector	Boolean
helmConfig	StorageCompleteClusterConfig
mostRecentSensorId	StorageSensorDeploymentIdentification
auditLogState	Map of StorageAuditLogFileState	内部使用のみ。
initBundleId	String
managedBy	StorageManagerType		MANAGER_TYPE_UNKNOWN、MANAGER_TYPE_MANUAL、MANAGER_TYPE_HELM_CHART、MANAGER_TYPE_KUBERNETES_OPERATOR、

11.3.7.12. StorageClusterCertExpiryStatus

フィールド名	必須	Null 許容型	型	説明	形式
sensorCertExpiry			Date		date-time
sensorCertNotBefore			Date		date-time

11.3.7.13. StorageClusterHealthStatus

フィールド名	型	形式
id	String
collectorHealthInfo	StorageCollectorHealthInfo
admissionControlHealthInfo	StorageAdmissionControlHealthInfo
scannerHealthInfo	StorageScannerHealthInfo
sensorHealthStatus	ClusterHealthStatusHealthStatusLabel	UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY
collectorHealthStatus	ClusterHealthStatusHealthStatusLabel	UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY
overallHealthStatus	ClusterHealthStatusHealthStatusLabel	UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY
admissionControlHealthStatus	ClusterHealthStatusHealthStatusLabel	UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY
scannerHealthStatus	ClusterHealthStatusHealthStatusLabel	UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY
lastContact	Date	date-time
healthInfoComplete	Boolean

11.3.7.14. StorageClusterMetadata

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

フィールド名	型	説明	形式
type	StorageClusterMetadataType		UNSPECIFIED、AKS、ARO、EKS、GKE、OCP、OSD、ROSA、
name	String	name は、クラスターがクラウドプロバイダーに登録されている名前を表します。自己管理の OpenShift の場合、これは OpenShift インストーラーによって選択される名前です。
id	String	id は、クラスターがクラウドプロバイダーに登録されている一意の ID を表します。すべてのクラスタータイプに ID が割り当てられているわけではありません。すべての OpenShift クラスターの場合、これは OCM に登録された Red Hat `cluster_id` です。

11.3.7.15. StorageClusterMetadataType

Enum 値
指定なし
AKS
ARO
EKS
GKE
OCP
OSD
ROSA

11.3.7.16. StorageClusterStatus

フィールド名	型	説明	形式
sensorVersion	String
DEPRECATEDLastContact	Date	このフィールドは、リリース 49.0 以降非推奨になりました。代わりに healthStatus.lastContact を使用してください。	date-time
providerMetadata	StorageProviderMetadata
orchestratorMetadata	StorageOrchestratorMetadata
upgradeStatus	StorageClusterUpgradeStatus
certExpiryStatus	StorageClusterCertExpiryStatus

11.3.7.17. StorageClusterType

Enum 値
GENERIC_CLUSTER
KUBERNETES_CLUSTER
OPENSHIFT_CLUSTER
OPENSHIFT4_CLUSTER

11.3.7.18. StorageClusterUpgradeStatus

フィールド名	型	形式
アップグレード可能性	ClusterUpgradeStatusUpgradability	UNSET, UP_TO_DATE, MANUAL_UPGRADE_REQUIRED, AUTO_UPGRADE_POSSIBLE, SENSOR_VERSION_HIGHER,
upgradabilityStatusReason	String
mostRecentProcess	ClusterUpgradeStatusUpgradeProcessStatus

11.3.7.19. StorageCollectionMethod

Enum 値
UNSET_COLLECTION
NO_COLLECTION
KERNEL_MODULE
EBPF
CORE_BPF

11.3.7.20. StorageCollectorHealthInfo

CollectorHealthInfo は、コレクターのデプロイメントに関するデータを保持しますが、このデータから取得するコレクターのヘルスステータスは含まれません。集約コレクターのヘルスステータスは、最初に CollectorHealthInfo (sensor)を報告するコンポーネントではなく、中央で派生しているため、含まれません。

フィールド名	型	説明	形式
version	String
totalDesiredPods	Integer		int32
totalReadyPods	Integer		int32
totalRegisteredNodes	Integer		int32
statusErrors	`string` のリスト	コレクターの正常性情報の取得の試行中に発生したエラーのコレクション。

11.3.7.21. StorageCompleteClusterConfig

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

フィールド名	必須	Null 許容型	型	説明	形式
dynamicConfig			StorageDynamicClusterConfig
staticConfig			StorageStaticClusterConfig
configFingerprint			String
clusterLabels			`文字列`のマップ

11.3.7.22. StorageDynamicClusterConfig

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

フィールド名	必須	Null 許容型	型	説明	形式
admissionControllerConfig			StorageAdmissionControllerConfig
registryOverride			String
disableAuditLogs			Boolean

11.3.7.23. StorageGoogleProviderMetadata

フィールド名	必須	Null 許容型	型	説明	形式
project			String
clusterName			String	providerMetadata.cluster.name が導入されたため非推奨になりました。

11.3.7.24. StorageManagerType

Enum 値
MANAGER_TYPE_UNKNOWN
MANAGER_TYPE_MANUAL
MANAGER_TYPE_HELM_CHART
MANAGER_TYPE_KUBERNETES_OPERATOR

11.3.7.25. StorageOrchestratorMetadata

フィールド名	型	形式
version	String
openshiftVersion	String
buildDate	Date	date-time
apiVersions	`string` のリスト

11.3.7.26. StorageProviderMetadata

フィールド名	必須	Null 許容型	型	説明	形式
region			String
zone			String
google			StorageGoogleProviderMetadata
aws			StorageAWSProviderMetadata
azure			StorageAzureProviderMetadata
verified			Boolean
cluster			StorageClusterMetadata

11.3.7.27. StorageScannerHealthInfo

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

フィールド名	型	説明	形式
totalDesiredAnalyzerPods	Integer		int32
totalReadyAnalyzerPods	Integer		int32
totalDesiredDbPods	Integer		int32
totalReadyDbPods	Integer		int32
statusErrors	`string` のリスト	スキャナーの正常性情報の取得の試行中に発生したエラーのコレクション。

11.3.7.28. StorageSensorDeploymentIdentification

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

フィールド名	必須	Null 許容型	型	説明	形式
systemNamespaceId			String
defaultNamespaceId			String
appNamespace			String
appNamespaceId			String
appServiceaccountId			String
k8sNodeName			String

11.3.7.29. StorageStaticClusterConfig

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

フィールド名	型	形式
type	StorageClusterType	GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,
mainImage	String
centralApiEndpoint	String
collectionMethod	StorageCollectionMethod	UNSET_COLLECTION、NO_COLLECTION、KERNEL_MODULE、EBPF、CORE_BPF
collectorImage	String
admissionController	Boolean
admissionControllerUpdates	Boolean
tolerationsConfig	StorageTolerationsConfig
slimCollector	Boolean
admissionControllerEvents	Boolean

11.3.7.30. StorageTolerationsConfig

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

11.3.7.31. StorageUpgradeProgress

フィールド名	型	形式
upgradeState	UpgradeProgressUpgradeState	UPGRADE_INITIALIZING、UPGRADER_LAUNCHING、UPGRADER_LAUNCHED、PRE_FLIGHT_CHECKS_COMPLETE、UPGRADE_OPERATIONS_DONE、UPGRADE_COMPLETE、UPGRADE_INITIALIZATION_ERROR、PRE_FLIGHT_CHECKS_FAILED、UPGRADE_ERROR_ROLLING_BACK、UPGRA_ERROR_ROLLED_BACK、UPGRADE_ERROR_ROLLBACK_FAILED、UPGRADE_ERROR_UNKNOWN、UPGRADE_TIMED_OUT
upgradeStatusDetail	String
次以降	Date	date-time

11.3.7.32. UpgradeProcessStatusUpgradeProcessType

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

Enum 値
アップグレード
CERT_ROTATION

11.3.7.33. UpgradeProgressUpgradeState

UPGRADER_LAUNCHING: 進行中の状態。
UPGRADE_COMPLETE: 成功状態。こちら以下のすべてのエラー状態とすべてのエラー状態を確認してください。
UPGRADE_INITIALIZATION_ERROR: エラーの状態。

Enum 値
UPGRADE_INITIALIZING
UPGRADER_LAUNCHING
UPGRADER_LAUNCHED
PRE_FLIGHT_CHECKS_COMPLETE
UPGRADE_OPERATIONS_DONE
UPGRADE_COMPLETE
UPGRADE_INITIALIZATION_ERROR
PRE_FLIGHT_CHECKS_FAILED
UPGRADE_ERROR_ROLLING_BACK
UPGRADE_ERROR_ROLLED_BACK
UPGRADE_ERROR_ROLLBACK_FAILED
UPGRADE_ERROR_UNKNOWN
UPGRADE_TIMED_OUT

11.3.7.34. V1ClustersList

フィールド名	必須	Null 許容型	型	説明	形式
clusters			StorageClusterの一覧
clusterIdToRetentionInfo			Map of V1DecommissionedClusterRetentionInfo

11.3.7.35. V1DecommissionedClusterRetentionInfo

next available tag: 3

フィールド名	必須	Null 許容型	型	説明	形式
isExcluded			Boolean
daysUntilDeletion			Integer		int32

11.4. DeleteCluster

DELETE /v1/clusters/{id}

11.4.1. 説明

11.4.2. パラメーター

11.4.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

11.4.3. 戻り値のタイプ

Object

11.4.4. コンテンツタイプ

application/json

11.4.5. レスポンス

表11.4 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	`Object`
0	予期しないエラーの応答です。	RuntimeError

11.4.6. サンプル

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

11.4.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

11.4.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

11.4.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

11.5. GetCluster

GET /v1/clusters/{id}

11.5.1. 説明

11.5.2. パラメーター

11.5.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

11.5.3. 戻り値のタイプ

V1ClusterResponse

11.5.4. コンテンツタイプ

application/json

11.5.5. レスポンス

表11.5 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1ClusterResponse
0	予期しないエラーの応答です。	RuntimeError

11.5.6. サンプル

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

11.5.7.1. ClusterHealthStatusHealthStatusLabel

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

Enum 値
UNINITIALIZED
利用できません
UNHEALTHY
DEGRADED
HEALTHY

11.5.7.2. ClusterUpgradeStatusUpgradability

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

Enum 値
UNSET
UP_TO_DATE
MANUAL_UPGRADE_REQUIRED
AUTO_UPGRADE_POSSIBLE
SENSOR_VERSION_HIGHER

11.5.7.3. ClusterUpgradeStatusUpgradeProcessStatus

フィールド名	型	形式
active	Boolean
id	String
targetVersion	String
upgraderImage	String
initiatedAt	Date	date-time
progress	StorageUpgradeProgress
type	UpgradeProcessStatusUpgradeProcessType	UPGRADE、CERT_ROTATION、

11.5.7.4. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

11.5.7.4.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

11.5.7.5. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

11.5.7.6. StorageAWSProviderMetadata

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

11.5.7.7. StorageAdmissionControlHealthInfo

フィールド名	型	説明	形式
totalDesiredPods	Integer		int32
totalReadyPods	Integer		int32
statusErrors	`string` のリスト	アドミッションコントロールのヘルス情報を取得する際に発生したエラーのコレクション。

11.5.7.8. StorageAdmissionControllerConfig

フィールド名	型	形式
enabled	Boolean
timeoutSeconds	Integer	int32
scanInline	Boolean
disableBypass	Boolean
enforceOnUpdates	Boolean

11.5.7.9. StorageAuditLogFileState

AuditLogFileState tracks the last audit log event timestamp and ID that was collected by Compliance For internal use only

フィールド名	必須	Null 許容型	型	説明	形式
collectLogsSince			Date		date-time
lastAuditId			String

11.5.7.10. StorageAzureProviderMetadata

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

11.5.7.11. StorageCluster

フィールド名	型	説明	形式
id	String
name	String
type	StorageClusterType		GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,
labels	`文字列`のマップ
mainImage	String
collectorImage	String
centralApiEndpoint	String
runtimeSupport	Boolean
collectionMethod	StorageCollectionMethod		UNSET_COLLECTION、NO_COLLECTION、KERNEL_MODULE、EBPF、CORE_BPF
admissionController	Boolean
admissionControllerUpdates	Boolean
admissionControllerEvents	Boolean
status	StorageClusterStatus
dynamicConfig	StorageDynamicClusterConfig
tolerationsConfig	StorageTolerationsConfig
priority	String		int64
healthStatus	StorageClusterHealthStatus
slimCollector	Boolean
helmConfig	StorageCompleteClusterConfig
mostRecentSensorId	StorageSensorDeploymentIdentification
auditLogState	Map of StorageAuditLogFileState	内部使用のみ。
initBundleId	String
managedBy	StorageManagerType		MANAGER_TYPE_UNKNOWN、MANAGER_TYPE_MANUAL、MANAGER_TYPE_HELM_CHART、MANAGER_TYPE_KUBERNETES_OPERATOR、

11.5.7.12. StorageClusterCertExpiryStatus

フィールド名	必須	Null 許容型	型	説明	形式
sensorCertExpiry			Date		date-time
sensorCertNotBefore			Date		date-time

11.5.7.13. StorageClusterHealthStatus

フィールド名	型	形式
id	String
collectorHealthInfo	StorageCollectorHealthInfo
admissionControlHealthInfo	StorageAdmissionControlHealthInfo
scannerHealthInfo	StorageScannerHealthInfo
sensorHealthStatus	ClusterHealthStatusHealthStatusLabel	UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY
collectorHealthStatus	ClusterHealthStatusHealthStatusLabel	UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY
overallHealthStatus	ClusterHealthStatusHealthStatusLabel	UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY
admissionControlHealthStatus	ClusterHealthStatusHealthStatusLabel	UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY
scannerHealthStatus	ClusterHealthStatusHealthStatusLabel	UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY
lastContact	Date	date-time
healthInfoComplete	Boolean

11.5.7.14. StorageClusterMetadata

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

フィールド名	型	説明	形式
type	StorageClusterMetadataType		UNSPECIFIED、AKS、ARO、EKS、GKE、OCP、OSD、ROSA、
name	String	name は、クラスターがクラウドプロバイダーに登録されている名前を表します。自己管理の OpenShift の場合、これは OpenShift インストーラーによって選択される名前です。
id	String	id は、クラスターがクラウドプロバイダーに登録されている一意の ID を表します。すべてのクラスタータイプに ID が割り当てられているわけではありません。すべての OpenShift クラスターの場合、これは OCM に登録された Red Hat `cluster_id` です。

11.5.7.15. StorageClusterMetadataType

Enum 値
指定なし
AKS
ARO
EKS
GKE
OCP
OSD
ROSA

11.5.7.16. StorageClusterStatus

フィールド名	型	説明	形式
sensorVersion	String
DEPRECATEDLastContact	Date	このフィールドは、リリース 49.0 以降非推奨になりました。代わりに healthStatus.lastContact を使用してください。	date-time
providerMetadata	StorageProviderMetadata
orchestratorMetadata	StorageOrchestratorMetadata
upgradeStatus	StorageClusterUpgradeStatus
certExpiryStatus	StorageClusterCertExpiryStatus

11.5.7.17. StorageClusterType

Enum 値
GENERIC_CLUSTER
KUBERNETES_CLUSTER
OPENSHIFT_CLUSTER
OPENSHIFT4_CLUSTER

11.5.7.18. StorageClusterUpgradeStatus

フィールド名	型	形式
アップグレード可能性	ClusterUpgradeStatusUpgradability	UNSET, UP_TO_DATE, MANUAL_UPGRADE_REQUIRED, AUTO_UPGRADE_POSSIBLE, SENSOR_VERSION_HIGHER,
upgradabilityStatusReason	String
mostRecentProcess	ClusterUpgradeStatusUpgradeProcessStatus

11.5.7.19. StorageCollectionMethod

Enum 値
UNSET_COLLECTION
NO_COLLECTION
KERNEL_MODULE
EBPF
CORE_BPF

11.5.7.20. StorageCollectorHealthInfo

フィールド名	型	説明	形式
version	String
totalDesiredPods	Integer		int32
totalReadyPods	Integer		int32
totalRegisteredNodes	Integer		int32
statusErrors	`string` のリスト	コレクターの正常性情報の取得の試行中に発生したエラーのコレクション。

11.5.7.21. StorageCompleteClusterConfig

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

フィールド名	必須	Null 許容型	型	説明	形式
dynamicConfig			StorageDynamicClusterConfig
staticConfig			StorageStaticClusterConfig
configFingerprint			String
clusterLabels			`文字列`のマップ

11.5.7.22. StorageDynamicClusterConfig

フィールド名	必須	Null 許容型	型	説明	形式
admissionControllerConfig			StorageAdmissionControllerConfig
registryOverride			String
disableAuditLogs			Boolean

11.5.7.23. StorageGoogleProviderMetadata

フィールド名	必須	Null 許容型	型	説明	形式
project			String
clusterName			String	providerMetadata.cluster.name が導入されたため非推奨になりました。

11.5.7.24. StorageManagerType

Enum 値
MANAGER_TYPE_UNKNOWN
MANAGER_TYPE_MANUAL
MANAGER_TYPE_HELM_CHART
MANAGER_TYPE_KUBERNETES_OPERATOR

11.5.7.25. StorageOrchestratorMetadata

フィールド名	型	形式
version	String
openshiftVersion	String
buildDate	Date	date-time
apiVersions	`string` のリスト

11.5.7.26. StorageProviderMetadata

フィールド名	必須	Null 許容型	型	説明	形式
region			String
zone			String
google			StorageGoogleProviderMetadata
aws			StorageAWSProviderMetadata
azure			StorageAzureProviderMetadata
verified			Boolean
cluster			StorageClusterMetadata

11.5.7.27. StorageScannerHealthInfo

フィールド名	型	説明	形式
totalDesiredAnalyzerPods	Integer		int32
totalReadyAnalyzerPods	Integer		int32
totalDesiredDbPods	Integer		int32
totalReadyDbPods	Integer		int32
statusErrors	`string` のリスト	スキャナーの正常性情報の取得の試行中に発生したエラーのコレクション。

11.5.7.28. StorageSensorDeploymentIdentification

フィールド名	必須	Null 許容型	型	説明	形式
systemNamespaceId			String
defaultNamespaceId			String
appNamespace			String
appNamespaceId			String
appServiceaccountId			String
k8sNodeName			String

11.5.7.29. StorageStaticClusterConfig

フィールド名	型	形式
type	StorageClusterType	GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,
mainImage	String
centralApiEndpoint	String
collectionMethod	StorageCollectionMethod	UNSET_COLLECTION、NO_COLLECTION、KERNEL_MODULE、EBPF、CORE_BPF
collectorImage	String
admissionController	Boolean
admissionControllerUpdates	Boolean
tolerationsConfig	StorageTolerationsConfig
slimCollector	Boolean
admissionControllerEvents	Boolean

11.5.7.30. StorageTolerationsConfig

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

11.5.7.31. StorageUpgradeProgress

フィールド名	型	形式
upgradeState	UpgradeProgressUpgradeState	UPGRADE_INITIALIZING、UPGRADER_LAUNCHING、UPGRADER_LAUNCHED、PRE_FLIGHT_CHECKS_COMPLETE、UPGRADE_OPERATIONS_DONE、UPGRADE_COMPLETE、UPGRADE_INITIALIZATION_ERROR、PRE_FLIGHT_CHECKS_FAILED、UPGRADE_ERROR_ROLLING_BACK、UPGRA_ERROR_ROLLED_BACK、UPGRADE_ERROR_ROLLBACK_FAILED、UPGRADE_ERROR_UNKNOWN、UPGRADE_TIMED_OUT
upgradeStatusDetail	String
次以降	Date	date-time

11.5.7.32. UpgradeProcessStatusUpgradeProcessType

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

Enum 値
アップグレード
CERT_ROTATION

11.5.7.33. UpgradeProgressUpgradeState

UPGRADER_LAUNCHING: 進行中の状態。
UPGRADE_COMPLETE: 成功状態。こちら以下のすべてのエラー状態とすべてのエラー状態を確認してください。
UPGRADE_INITIALIZATION_ERROR: エラーの状態。

Enum 値
UPGRADE_INITIALIZING
UPGRADER_LAUNCHING
UPGRADER_LAUNCHED
PRE_FLIGHT_CHECKS_COMPLETE
UPGRADE_OPERATIONS_DONE
UPGRADE_COMPLETE
UPGRADE_INITIALIZATION_ERROR
PRE_FLIGHT_CHECKS_FAILED
UPGRADE_ERROR_ROLLING_BACK
UPGRADE_ERROR_ROLLED_BACK
UPGRADE_ERROR_ROLLBACK_FAILED
UPGRADE_ERROR_UNKNOWN
UPGRADE_TIMED_OUT

11.5.7.34. V1ClusterResponse

フィールド名	必須	Null 許容型	型	説明	形式
cluster			StorageCluster
clusterRetentionInfo			V1DecommissionedClusterRetentionInfo

11.5.7.35. V1DecommissionedClusterRetentionInfo

next available tag: 3

フィールド名	必須	Null 許容型	型	説明	形式
isExcluded			Boolean
daysUntilDeletion			Integer		int32

11.6. PutCluster

PUT /v1/clusters/{id}

11.6.1. 説明

11.6.2. パラメーター

11.6.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

11.6.2.2. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	StorageCluster	X

11.6.3. 戻り値のタイプ

V1ClusterResponse

11.6.4. コンテンツタイプ

application/json

11.6.5. レスポンス

表11.6 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1ClusterResponse
0	予期しないエラーの応答です。	RuntimeError

11.6.6. サンプル

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

11.6.7.1. ClusterHealthStatusHealthStatusLabel

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

Enum 値
UNINITIALIZED
利用できません
UNHEALTHY
DEGRADED
HEALTHY

11.6.7.2. ClusterUpgradeStatusUpgradability

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

Enum 値
UNSET
UP_TO_DATE
MANUAL_UPGRADE_REQUIRED
AUTO_UPGRADE_POSSIBLE
SENSOR_VERSION_HIGHER

11.6.7.3. ClusterUpgradeStatusUpgradeProcessStatus

フィールド名	型	形式
active	Boolean
id	String
targetVersion	String
upgraderImage	String
initiatedAt	Date	date-time
progress	StorageUpgradeProgress
type	UpgradeProcessStatusUpgradeProcessType	UPGRADE、CERT_ROTATION、

11.6.7.4. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

11.6.7.4.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

11.6.7.5. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

11.6.7.6. StorageAWSProviderMetadata

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

11.6.7.7. StorageAdmissionControlHealthInfo

フィールド名	型	説明	形式
totalDesiredPods	Integer		int32
totalReadyPods	Integer		int32
statusErrors	`string` のリスト	アドミッションコントロールのヘルス情報を取得する際に発生したエラーのコレクション。

11.6.7.8. StorageAdmissionControllerConfig

フィールド名	型	形式
enabled	Boolean
timeoutSeconds	Integer	int32
scanInline	Boolean
disableBypass	Boolean
enforceOnUpdates	Boolean

11.6.7.9. StorageAuditLogFileState

AuditLogFileState tracks the last audit log event timestamp and ID that was collected by Compliance For internal use only

フィールド名	必須	Null 許容型	型	説明	形式
collectLogsSince			Date		date-time
lastAuditId			String

11.6.7.10. StorageAzureProviderMetadata

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

11.6.7.11. StorageCluster

フィールド名	型	説明	形式
id	String
name	String
type	StorageClusterType		GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,
labels	`文字列`のマップ
mainImage	String
collectorImage	String
centralApiEndpoint	String
runtimeSupport	Boolean
collectionMethod	StorageCollectionMethod		UNSET_COLLECTION、NO_COLLECTION、KERNEL_MODULE、EBPF、CORE_BPF
admissionController	Boolean
admissionControllerUpdates	Boolean
admissionControllerEvents	Boolean
status	StorageClusterStatus
dynamicConfig	StorageDynamicClusterConfig
tolerationsConfig	StorageTolerationsConfig
priority	String		int64
healthStatus	StorageClusterHealthStatus
slimCollector	Boolean
helmConfig	StorageCompleteClusterConfig
mostRecentSensorId	StorageSensorDeploymentIdentification
auditLogState	Map of StorageAuditLogFileState	内部使用のみ。
initBundleId	String
managedBy	StorageManagerType		MANAGER_TYPE_UNKNOWN、MANAGER_TYPE_MANUAL、MANAGER_TYPE_HELM_CHART、MANAGER_TYPE_KUBERNETES_OPERATOR、

11.6.7.12. StorageClusterCertExpiryStatus

フィールド名	必須	Null 許容型	型	説明	形式
sensorCertExpiry			Date		date-time
sensorCertNotBefore			Date		date-time

11.6.7.13. StorageClusterHealthStatus

フィールド名	型	形式
id	String
collectorHealthInfo	StorageCollectorHealthInfo
admissionControlHealthInfo	StorageAdmissionControlHealthInfo
scannerHealthInfo	StorageScannerHealthInfo
sensorHealthStatus	ClusterHealthStatusHealthStatusLabel	UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY
collectorHealthStatus	ClusterHealthStatusHealthStatusLabel	UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY
overallHealthStatus	ClusterHealthStatusHealthStatusLabel	UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY
admissionControlHealthStatus	ClusterHealthStatusHealthStatusLabel	UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY
scannerHealthStatus	ClusterHealthStatusHealthStatusLabel	UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY
lastContact	Date	date-time
healthInfoComplete	Boolean

11.6.7.14. StorageClusterMetadata

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

フィールド名	型	説明	形式
type	StorageClusterMetadataType		UNSPECIFIED、AKS、ARO、EKS、GKE、OCP、OSD、ROSA、
name	String	name は、クラスターがクラウドプロバイダーに登録されている名前を表します。自己管理の OpenShift の場合、これは OpenShift インストーラーによって選択される名前です。
id	String	id は、クラスターがクラウドプロバイダーに登録されている一意の ID を表します。すべてのクラスタータイプに ID が割り当てられているわけではありません。すべての OpenShift クラスターの場合、これは OCM に登録された Red Hat `cluster_id` です。

11.6.7.15. StorageClusterMetadataType

Enum 値
指定なし
AKS
ARO
EKS
GKE
OCP
OSD
ROSA

11.6.7.16. StorageClusterStatus

フィールド名	型	説明	形式
sensorVersion	String
DEPRECATEDLastContact	Date	このフィールドは、リリース 49.0 以降非推奨になりました。代わりに healthStatus.lastContact を使用してください。	date-time
providerMetadata	StorageProviderMetadata
orchestratorMetadata	StorageOrchestratorMetadata
upgradeStatus	StorageClusterUpgradeStatus
certExpiryStatus	StorageClusterCertExpiryStatus

11.6.7.17. StorageClusterType

Enum 値
GENERIC_CLUSTER
KUBERNETES_CLUSTER
OPENSHIFT_CLUSTER
OPENSHIFT4_CLUSTER

11.6.7.18. StorageClusterUpgradeStatus

フィールド名	型	形式
アップグレード可能性	ClusterUpgradeStatusUpgradability	UNSET, UP_TO_DATE, MANUAL_UPGRADE_REQUIRED, AUTO_UPGRADE_POSSIBLE, SENSOR_VERSION_HIGHER,
upgradabilityStatusReason	String
mostRecentProcess	ClusterUpgradeStatusUpgradeProcessStatus

11.6.7.19. StorageCollectionMethod

Enum 値
UNSET_COLLECTION
NO_COLLECTION
KERNEL_MODULE
EBPF
CORE_BPF

11.6.7.20. StorageCollectorHealthInfo

フィールド名	型	説明	形式
version	String
totalDesiredPods	Integer		int32
totalReadyPods	Integer		int32
totalRegisteredNodes	Integer		int32
statusErrors	`string` のリスト	コレクターの正常性情報の取得の試行中に発生したエラーのコレクション。

11.6.7.21. StorageCompleteClusterConfig

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

フィールド名	必須	Null 許容型	型	説明	形式
dynamicConfig			StorageDynamicClusterConfig
staticConfig			StorageStaticClusterConfig
configFingerprint			String
clusterLabels			`文字列`のマップ

11.6.7.22. StorageDynamicClusterConfig

フィールド名	必須	Null 許容型	型	説明	形式
admissionControllerConfig			StorageAdmissionControllerConfig
registryOverride			String
disableAuditLogs			Boolean

11.6.7.23. StorageGoogleProviderMetadata

フィールド名	必須	Null 許容型	型	説明	形式
project			String
clusterName			String	providerMetadata.cluster.name が導入されたため非推奨になりました。

11.6.7.24. StorageManagerType

Enum 値
MANAGER_TYPE_UNKNOWN
MANAGER_TYPE_MANUAL
MANAGER_TYPE_HELM_CHART
MANAGER_TYPE_KUBERNETES_OPERATOR

11.6.7.25. StorageOrchestratorMetadata

フィールド名	型	形式
version	String
openshiftVersion	String
buildDate	Date	date-time
apiVersions	`string` のリスト

11.6.7.26. StorageProviderMetadata

フィールド名	必須	Null 許容型	型	説明	形式
region			String
zone			String
google			StorageGoogleProviderMetadata
aws			StorageAWSProviderMetadata
azure			StorageAzureProviderMetadata
verified			Boolean
cluster			StorageClusterMetadata

11.6.7.27. StorageScannerHealthInfo

フィールド名	型	説明	形式
totalDesiredAnalyzerPods	Integer		int32
totalReadyAnalyzerPods	Integer		int32
totalDesiredDbPods	Integer		int32
totalReadyDbPods	Integer		int32
statusErrors	`string` のリスト	スキャナーの正常性情報の取得の試行中に発生したエラーのコレクション。

11.6.7.28. StorageSensorDeploymentIdentification

フィールド名	必須	Null 許容型	型	説明	形式
systemNamespaceId			String
defaultNamespaceId			String
appNamespace			String
appNamespaceId			String
appServiceaccountId			String
k8sNodeName			String

11.6.7.29. StorageStaticClusterConfig

フィールド名	型	形式
type	StorageClusterType	GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,
mainImage	String
centralApiEndpoint	String
collectionMethod	StorageCollectionMethod	UNSET_COLLECTION、NO_COLLECTION、KERNEL_MODULE、EBPF、CORE_BPF
collectorImage	String
admissionController	Boolean
admissionControllerUpdates	Boolean
tolerationsConfig	StorageTolerationsConfig
slimCollector	Boolean
admissionControllerEvents	Boolean

11.6.7.30. StorageTolerationsConfig

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

11.6.7.31. StorageUpgradeProgress

フィールド名	型	形式
upgradeState	UpgradeProgressUpgradeState	UPGRADE_INITIALIZING、UPGRADER_LAUNCHING、UPGRADER_LAUNCHED、PRE_FLIGHT_CHECKS_COMPLETE、UPGRADE_OPERATIONS_DONE、UPGRADE_COMPLETE、UPGRADE_INITIALIZATION_ERROR、PRE_FLIGHT_CHECKS_FAILED、UPGRADE_ERROR_ROLLING_BACK、UPGRA_ERROR_ROLLED_BACK、UPGRADE_ERROR_ROLLBACK_FAILED、UPGRADE_ERROR_UNKNOWN、UPGRADE_TIMED_OUT
upgradeStatusDetail	String
次以降	Date	date-time

11.6.7.32. UpgradeProcessStatusUpgradeProcessType

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

Enum 値
アップグレード
CERT_ROTATION

11.6.7.33. UpgradeProgressUpgradeState

UPGRADER_LAUNCHING: 進行中の状態。
UPGRADE_COMPLETE: 成功状態。こちら以下のすべてのエラー状態とすべてのエラー状態を確認してください。
UPGRADE_INITIALIZATION_ERROR: エラーの状態。

Enum 値
UPGRADE_INITIALIZING
UPGRADER_LAUNCHING
UPGRADER_LAUNCHED
PRE_FLIGHT_CHECKS_COMPLETE
UPGRADE_OPERATIONS_DONE
UPGRADE_COMPLETE
UPGRADE_INITIALIZATION_ERROR
PRE_FLIGHT_CHECKS_FAILED
UPGRADE_ERROR_ROLLING_BACK
UPGRADE_ERROR_ROLLED_BACK
UPGRADE_ERROR_ROLLBACK_FAILED
UPGRADE_ERROR_UNKNOWN
UPGRADE_TIMED_OUT

11.6.7.34. V1ClusterResponse

フィールド名	必須	Null 許容型	型	説明	形式
cluster			StorageCluster
clusterRetentionInfo			V1DecommissionedClusterRetentionInfo

11.6.7.35. V1DecommissionedClusterRetentionInfo

next available tag: 3

フィールド名	必須	Null 許容型	型	説明	形式
isExcluded			Boolean
daysUntilDeletion			Integer		int32

11.7. PostCluster

POST /v1/clusters

11.7.1. 説明

11.7.2. パラメーター

11.7.2.1. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	StorageCluster	X

11.7.3. 戻り値のタイプ

V1ClusterResponse

11.7.4. コンテンツタイプ

application/json

11.7.5. レスポンス

表11.7 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1ClusterResponse
0	予期しないエラーの応答です。	RuntimeError

11.7.6. サンプル

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

11.7.7.1. ClusterHealthStatusHealthStatusLabel

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

Enum 値
UNINITIALIZED
利用できません
UNHEALTHY
DEGRADED
HEALTHY

11.7.7.2. ClusterUpgradeStatusUpgradability

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

Enum 値
UNSET
UP_TO_DATE
MANUAL_UPGRADE_REQUIRED
AUTO_UPGRADE_POSSIBLE
SENSOR_VERSION_HIGHER

11.7.7.3. ClusterUpgradeStatusUpgradeProcessStatus

フィールド名	型	形式
active	Boolean
id	String
targetVersion	String
upgraderImage	String
initiatedAt	Date	date-time
progress	StorageUpgradeProgress
type	UpgradeProcessStatusUpgradeProcessType	UPGRADE、CERT_ROTATION、

11.7.7.4. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

11.7.7.4.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

11.7.7.5. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

11.7.7.6. StorageAWSProviderMetadata

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

11.7.7.7. StorageAdmissionControlHealthInfo

フィールド名	型	説明	形式
totalDesiredPods	Integer		int32
totalReadyPods	Integer		int32
statusErrors	`string` のリスト	アドミッションコントロールのヘルス情報を取得する際に発生したエラーのコレクション。

11.7.7.8. StorageAdmissionControllerConfig

フィールド名	型	形式
enabled	Boolean
timeoutSeconds	Integer	int32
scanInline	Boolean
disableBypass	Boolean
enforceOnUpdates	Boolean

11.7.7.9. StorageAuditLogFileState

AuditLogFileState tracks the last audit log event timestamp and ID that was collected by Compliance For internal use only

フィールド名	必須	Null 許容型	型	説明	形式
collectLogsSince			Date		date-time
lastAuditId			String

11.7.7.10. StorageAzureProviderMetadata

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

11.7.7.11. StorageCluster

フィールド名	型	説明	形式
id	String
name	String
type	StorageClusterType		GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,
labels	`文字列`のマップ
mainImage	String
collectorImage	String
centralApiEndpoint	String
runtimeSupport	Boolean
collectionMethod	StorageCollectionMethod		UNSET_COLLECTION、NO_COLLECTION、KERNEL_MODULE、EBPF、CORE_BPF
admissionController	Boolean
admissionControllerUpdates	Boolean
admissionControllerEvents	Boolean
status	StorageClusterStatus
dynamicConfig	StorageDynamicClusterConfig
tolerationsConfig	StorageTolerationsConfig
priority	String		int64
healthStatus	StorageClusterHealthStatus
slimCollector	Boolean
helmConfig	StorageCompleteClusterConfig
mostRecentSensorId	StorageSensorDeploymentIdentification
auditLogState	Map of StorageAuditLogFileState	内部使用のみ。
initBundleId	String
managedBy	StorageManagerType		MANAGER_TYPE_UNKNOWN、MANAGER_TYPE_MANUAL、MANAGER_TYPE_HELM_CHART、MANAGER_TYPE_KUBERNETES_OPERATOR、

11.7.7.12. StorageClusterCertExpiryStatus

フィールド名	必須	Null 許容型	型	説明	形式
sensorCertExpiry			Date		date-time
sensorCertNotBefore			Date		date-time

11.7.7.13. StorageClusterHealthStatus

フィールド名	型	形式
id	String
collectorHealthInfo	StorageCollectorHealthInfo
admissionControlHealthInfo	StorageAdmissionControlHealthInfo
scannerHealthInfo	StorageScannerHealthInfo
sensorHealthStatus	ClusterHealthStatusHealthStatusLabel	UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY
collectorHealthStatus	ClusterHealthStatusHealthStatusLabel	UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY
overallHealthStatus	ClusterHealthStatusHealthStatusLabel	UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY
admissionControlHealthStatus	ClusterHealthStatusHealthStatusLabel	UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY
scannerHealthStatus	ClusterHealthStatusHealthStatusLabel	UNINITIALIZED、UNAVAILABLE、UNHEALTHY、DEGRADED、HEALTHY
lastContact	Date	date-time
healthInfoComplete	Boolean

11.7.7.14. StorageClusterMetadata

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

フィールド名	型	説明	形式
type	StorageClusterMetadataType		UNSPECIFIED、AKS、ARO、EKS、GKE、OCP、OSD、ROSA、
name	String	name は、クラスターがクラウドプロバイダーに登録されている名前を表します。自己管理の OpenShift の場合、これは OpenShift インストーラーによって選択される名前です。
id	String	id は、クラスターがクラウドプロバイダーに登録されている一意の ID を表します。すべてのクラスタータイプに ID が割り当てられているわけではありません。すべての OpenShift クラスターの場合、これは OCM に登録された Red Hat `cluster_id` です。

11.7.7.15. StorageClusterMetadataType

Enum 値
指定なし
AKS
ARO
EKS
GKE
OCP
OSD
ROSA

11.7.7.16. StorageClusterStatus

フィールド名	型	説明	形式
sensorVersion	String
DEPRECATEDLastContact	Date	このフィールドは、リリース 49.0 以降非推奨になりました。代わりに healthStatus.lastContact を使用してください。	date-time
providerMetadata	StorageProviderMetadata
orchestratorMetadata	StorageOrchestratorMetadata
upgradeStatus	StorageClusterUpgradeStatus
certExpiryStatus	StorageClusterCertExpiryStatus

11.7.7.17. StorageClusterType

Enum 値
GENERIC_CLUSTER
KUBERNETES_CLUSTER
OPENSHIFT_CLUSTER
OPENSHIFT4_CLUSTER

11.7.7.18. StorageClusterUpgradeStatus

フィールド名	型	形式
アップグレード可能性	ClusterUpgradeStatusUpgradability	UNSET, UP_TO_DATE, MANUAL_UPGRADE_REQUIRED, AUTO_UPGRADE_POSSIBLE, SENSOR_VERSION_HIGHER,
upgradabilityStatusReason	String
mostRecentProcess	ClusterUpgradeStatusUpgradeProcessStatus

11.7.7.19. StorageCollectionMethod

Enum 値
UNSET_COLLECTION
NO_COLLECTION
KERNEL_MODULE
EBPF
CORE_BPF

11.7.7.20. StorageCollectorHealthInfo

フィールド名	型	説明	形式
version	String
totalDesiredPods	Integer		int32
totalReadyPods	Integer		int32
totalRegisteredNodes	Integer		int32
statusErrors	`string` のリスト	コレクターの正常性情報の取得の試行中に発生したエラーのコレクション。

11.7.7.21. StorageCompleteClusterConfig

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

フィールド名	必須	Null 許容型	型	説明	形式
dynamicConfig			StorageDynamicClusterConfig
staticConfig			StorageStaticClusterConfig
configFingerprint			String
clusterLabels			`文字列`のマップ

11.7.7.22. StorageDynamicClusterConfig

フィールド名	必須	Null 許容型	型	説明	形式
admissionControllerConfig			StorageAdmissionControllerConfig
registryOverride			String
disableAuditLogs			Boolean

11.7.7.23. StorageGoogleProviderMetadata

フィールド名	必須	Null 許容型	型	説明	形式
project			String
clusterName			String	providerMetadata.cluster.name が導入されたため非推奨になりました。

11.7.7.24. StorageManagerType

Enum 値
MANAGER_TYPE_UNKNOWN
MANAGER_TYPE_MANUAL
MANAGER_TYPE_HELM_CHART
MANAGER_TYPE_KUBERNETES_OPERATOR

11.7.7.25. StorageOrchestratorMetadata

フィールド名	型	形式
version	String
openshiftVersion	String
buildDate	Date	date-time
apiVersions	`string` のリスト

11.7.7.26. StorageProviderMetadata

フィールド名	必須	Null 許容型	型	説明	形式
region			String
zone			String
google			StorageGoogleProviderMetadata
aws			StorageAWSProviderMetadata
azure			StorageAzureProviderMetadata
verified			Boolean
cluster			StorageClusterMetadata

11.7.7.27. StorageScannerHealthInfo

フィールド名	型	説明	形式
totalDesiredAnalyzerPods	Integer		int32
totalReadyAnalyzerPods	Integer		int32
totalDesiredDbPods	Integer		int32
totalReadyDbPods	Integer		int32
statusErrors	`string` のリスト	スキャナーの正常性情報の取得の試行中に発生したエラーのコレクション。

11.7.7.28. StorageSensorDeploymentIdentification

フィールド名	必須	Null 許容型	型	説明	形式
systemNamespaceId			String
defaultNamespaceId			String
appNamespace			String
appNamespaceId			String
appServiceaccountId			String
k8sNodeName			String

11.7.7.29. StorageStaticClusterConfig

フィールド名	型	形式
type	StorageClusterType	GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,
mainImage	String
centralApiEndpoint	String
collectionMethod	StorageCollectionMethod	UNSET_COLLECTION、NO_COLLECTION、KERNEL_MODULE、EBPF、CORE_BPF
collectorImage	String
admissionController	Boolean
admissionControllerUpdates	Boolean
tolerationsConfig	StorageTolerationsConfig
slimCollector	Boolean
admissionControllerEvents	Boolean

11.7.7.30. StorageTolerationsConfig

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

11.7.7.31. StorageUpgradeProgress

フィールド名	型	形式
upgradeState	UpgradeProgressUpgradeState	UPGRADE_INITIALIZING、UPGRADER_LAUNCHING、UPGRADER_LAUNCHED、PRE_FLIGHT_CHECKS_COMPLETE、UPGRADE_OPERATIONS_DONE、UPGRADE_COMPLETE、UPGRADE_INITIALIZATION_ERROR、PRE_FLIGHT_CHECKS_FAILED、UPGRADE_ERROR_ROLLING_BACK、UPGRA_ERROR_ROLLED_BACK、UPGRADE_ERROR_ROLLBACK_FAILED、UPGRADE_ERROR_UNKNOWN、UPGRADE_TIMED_OUT
upgradeStatusDetail	String
次以降	Date	date-time

11.7.7.32. UpgradeProcessStatusUpgradeProcessType

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

Enum 値
アップグレード
CERT_ROTATION

11.7.7.33. UpgradeProgressUpgradeState

UPGRADER_LAUNCHING: 進行中の状態。
UPGRADE_COMPLETE: 成功状態。こちら以下のすべてのエラー状態とすべてのエラー状態を確認してください。
UPGRADE_INITIALIZATION_ERROR: エラーの状態。

Enum 値
UPGRADE_INITIALIZING
UPGRADER_LAUNCHING
UPGRADER_LAUNCHED
PRE_FLIGHT_CHECKS_COMPLETE
UPGRADE_OPERATIONS_DONE
UPGRADE_COMPLETE
UPGRADE_INITIALIZATION_ERROR
PRE_FLIGHT_CHECKS_FAILED
UPGRADE_ERROR_ROLLING_BACK
UPGRADE_ERROR_ROLLED_BACK
UPGRADE_ERROR_ROLLBACK_FAILED
UPGRADE_ERROR_UNKNOWN
UPGRADE_TIMED_OUT

11.7.7.34. V1ClusterResponse

フィールド名	必須	Null 許容型	型	説明	形式
cluster			StorageCluster
clusterRetentionInfo			V1DecommissionedClusterRetentionInfo

11.7.7.35. V1DecommissionedClusterRetentionInfo

next available tag: 3

フィールド名	必須	Null 許容型	型	説明	形式
isExcluded			Boolean
daysUntilDeletion			Integer		int32

第12章 CollectionService

12.1. GetCollectionCount

GET /v1/collectionscount

12.1.1. 説明

12.1.2. パラメーター

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	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

12.1.3. 戻り値のタイプ

V1GetCollectionCountResponse

12.1.4. コンテンツタイプ

application/json

12.1.5. レスポンス

表12.1 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GetCollectionCountResponse
0	予期しないエラーの応答です。	RuntimeError

12.1.6. サンプル

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

12.1.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

12.1.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

12.1.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

12.1.7.3. V1GetCollectionCountResponse

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

12.2. DryRunCollection

POST /v1/collections/dryrun

12.2.1. 説明

12.2.2. パラメーター

12.2.2.1. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1DryRunCollectionRequest	X

12.2.3. 戻り値のタイプ

V1DryRunCollectionResponse

12.2.4. コンテンツタイプ

application/json

12.2.5. レスポンス

表12.2 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1DryRunCollectionResponse
0	予期しないエラーの応答です。	RuntimeError

12.2.6. サンプル

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

12.2.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

12.2.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

12.2.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

12.2.7.3. StorageBooleanOperator

Enum 値
OR
AND

12.2.7.4. StorageListDeployment

Next available tag: 9

フィールド名	型	形式
id	String
ハッシュ	String	uint64
name	String
cluster	String
clusterId	String
namespace	String
created	Date	date-time
priority	String	int64

12.2.7.5. StorageMatchType

Enum 値
EXACT
REGEX

12.2.7.6. StorageResourceSelector

フィールド名	必須	Null 許容型	型	説明	形式
rules			StorageSelectorRuleの一覧	`ルール` は接続詞(AND)として解決されます。

12.2.7.7. StorageRuleValue

フィールド名	必須	Null 許容型	型	説明	形式
value			String
matchType			StorageMatchType		EXACT, REGEX,

12.2.7.8. StorageSelectorRule

フィールド名	型	説明	形式
fieldName	String
operator	StorageBooleanOperator		または、AND
values	StorageRuleValueの一覧	`値` は、演算子に応じて結合(AND)またはアンジェット(OR)として解決されます。MVP の場合、OR のみが UX の観点からサポートされています。

12.2.7.9. V1AggregateBy

フィールド名	必須	Null 許容型	型	説明	形式
aggrFunc			V1Aggregation		UNSET、COUNT、MIN、MAX
一意			Boolean

12.2.7.10. V1Aggregation

Enum 値
UNSET
カウント
最小
最大

12.2.7.11. V1CollectionDeploymentMatchOptions

フィールド名	必須	Null 許容型	型	説明	形式
withMatches			Boolean
filterQuery			V1RawQuery

12.2.7.12. V1DryRunCollectionRequest

フィールド名	必須	Null 許容型	型	説明	形式
name			String
id			String
description			String
resourceSelectors			StorageResourceSelectorの一覧
embeddedCollectionIds			`string` のリスト
options			V1CollectionDeploymentMatchOptions

12.2.7.13. V1DryRunCollectionResponse

フィールド名	必須	Null 許容型	型	説明	形式
デプロイメント			StorageListDeploymentのリスト

12.2.7.14. V1Pagination

フィールド名	型	説明	形式
limit	Integer		int32
offset	Integer		int32
sortOption	V1SortOption
sortOptions	V1SortOptionのリスト	このフィールドは開発中です。REST API ではサポートされていません。

12.2.7.15. V1RawQuery

RawQuery は検索クエリー文字列を表します。クエリー文字列の形式は "<field name>:<value,value,…><field name>:<value, value,..>…" です。例：namespace "stackrox" で "central" および "sensor" という名前のデプロイメントを検索するには、クエリー文字列は "Deployment:central,sensor+Namespace:stackrox" RawQuery is be Listapis で特定のオブジェクトを検索します。

フィールド名	必須	Null 許容型	型	説明	形式
query			String
ページネーション			V1Pagination

12.2.7.16. V1SortOption

フィールド名	必須	Null 許容型	型	説明	形式
field			String
reversed			Boolean
aggregateBy			V1AggregateBy

12.3. ListCollections

GET /v1/collections

12.3.1. 説明

12.3.2. パラメーター

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	-	UNSET
query.pagination.sortOption.aggregateBy.distinct	-	null

12.3.3. 戻り値のタイプ

V1ListCollectionsResponse

12.3.4. コンテンツタイプ

application/json

12.3.5. レスポンス

表12.3 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1ListCollectionsResponse
0	予期しないエラーの応答です。	RuntimeError

12.3.6. サンプル

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

12.3.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

12.3.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

12.3.7.2. ResourceCollectionEmbeddedResourceCollection

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

12.3.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

12.3.7.4. StorageBooleanOperator

Enum 値
OR
AND

12.3.7.5. StorageMatchType

Enum 値
EXACT
REGEX

12.3.7.6. StorageResourceCollection

フィールド名	型	説明	形式
id	String
name	String
description	String
createdAt	Date		date-time
lastUpdated	Date		date-time
createdBy	StorageSlimUser
updatedBy	StorageSlimUser
resourceSelectors	StorageResourceSelectorの一覧	`resource_selectors` は、各個人および `embedded_collections` のセレクターを使用して破棄(OR)として解決されます。MVP の場合、resource_selectors のサイズは UX の観点から最大 1 になります。
embeddedCollections	ResourceCollectionEmbeddedResourceCollectionのリスト

12.3.7.7. StorageResourceSelector

フィールド名	必須	Null 許容型	型	説明	形式
rules			StorageSelectorRuleの一覧	`ルール` は接続詞(AND)として解決されます。

12.3.7.8. StorageRuleValue

フィールド名	必須	Null 許容型	型	説明	形式
value			String
matchType			StorageMatchType		EXACT, REGEX,

12.3.7.9. StorageSelectorRule

フィールド名	型	説明	形式
fieldName	String
operator	StorageBooleanOperator		または、AND
values	StorageRuleValueの一覧	`値` は、演算子に応じて結合(AND)またはアンジェット(OR)として解決されます。MVP の場合、OR のみが UX の観点からサポートされています。

12.3.7.10. StorageSlimUser

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

12.3.7.11. V1ListCollectionsResponse

フィールド名	必須	Null 許容型	型	説明	形式
コレクション			StorageResourceCollectionのリスト

12.4. DeleteCollection

DELETE /v1/collections/{id}

12.4.1. 説明

12.4.2. パラメーター

12.4.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

12.4.3. 戻り値のタイプ

Object

12.4.4. コンテンツタイプ

application/json

12.4.5. レスポンス

表12.4 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	`Object`
0	予期しないエラーの応答です。	RuntimeError

12.4.6. サンプル

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

12.4.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

12.4.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

12.4.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

12.5. GetCollection

GET /v1/collections/{id}

12.5.1. 説明

12.5.2. パラメーター

12.5.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

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

名前	必須	デフォルト
options.withMatches	-	null
options.filterQuery.query	-	null
options.filterQuery.pagination.limit	-	null
options.filterQuery.pagination.offset	-	null
options.filterQuery.pagination.sortOption.field	-	null
options.filterQuery.pagination.sortOption.reversed	-	null
options.filterQuery.pagination.sortOption.aggregateBy.aggrFunc	-	UNSET
options.filterQuery.pagination.sortOption.aggregateBy.distinct	-	null

12.5.3. 戻り値のタイプ

V1GetCollectionResponse

12.5.4. コンテンツタイプ

application/json

12.5.5. レスポンス

表12.5 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GetCollectionResponse
0	予期しないエラーの応答です。	RuntimeError

12.5.6. サンプル

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

12.5.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

12.5.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

12.5.7.2. ResourceCollectionEmbeddedResourceCollection

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

12.5.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

12.5.7.4. StorageBooleanOperator

Enum 値
OR
AND

12.5.7.5. StorageListDeployment

Next available tag: 9

フィールド名	型	形式
id	String
ハッシュ	String	uint64
name	String
cluster	String
clusterId	String
namespace	String
created	Date	date-time
priority	String	int64

12.5.7.6. StorageMatchType

Enum 値
EXACT
REGEX

12.5.7.7. StorageResourceCollection

フィールド名	型	説明	形式
id	String
name	String
description	String
createdAt	Date		date-time
lastUpdated	Date		date-time
createdBy	StorageSlimUser
updatedBy	StorageSlimUser
resourceSelectors	StorageResourceSelectorの一覧	`resource_selectors` は、各個人および `embedded_collections` のセレクターを使用して破棄(OR)として解決されます。MVP の場合、resource_selectors のサイズは UX の観点から最大 1 になります。
embeddedCollections	ResourceCollectionEmbeddedResourceCollectionのリスト

12.5.7.8. StorageResourceSelector

フィールド名	必須	Null 許容型	型	説明	形式
rules			StorageSelectorRuleの一覧	`ルール` は接続詞(AND)として解決されます。

12.5.7.9. StorageRuleValue

フィールド名	必須	Null 許容型	型	説明	形式
value			String
matchType			StorageMatchType		EXACT, REGEX,

12.5.7.10. StorageSelectorRule

フィールド名	型	説明	形式
fieldName	String
operator	StorageBooleanOperator		または、AND
values	StorageRuleValueの一覧	`値` は、演算子に応じて結合(AND)またはアンジェット(OR)として解決されます。MVP の場合、OR のみが UX の観点からサポートされています。

12.5.7.11. StorageSlimUser

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

12.5.7.12. V1GetCollectionResponse

フィールド名	必須	Null 許容型	型	説明	形式
コレクション			StorageResourceCollection
デプロイメント			StorageListDeploymentのリスト

12.6. UpdateCollection

PATCH /v1/collections/{id}

12.6.1. 説明

12.6.2. パラメーター

12.6.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

12.6.2.2. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1UpdateCollectionRequest	X

12.6.3. 戻り値のタイプ

V1UpdateCollectionResponse

12.6.4. コンテンツタイプ

application/json

12.6.5. レスポンス

表12.6 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1UpdateCollectionResponse
0	予期しないエラーの応答です。	RuntimeError

12.6.6. サンプル

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

12.6.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

12.6.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

12.6.7.2. ResourceCollectionEmbeddedResourceCollection

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

12.6.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

12.6.7.4. StorageBooleanOperator

Enum 値
OR
AND

12.6.7.5. StorageMatchType

Enum 値
EXACT
REGEX

12.6.7.6. StorageResourceCollection

フィールド名	型	説明	形式
id	String
name	String
description	String
createdAt	Date		date-time
lastUpdated	Date		date-time
createdBy	StorageSlimUser
updatedBy	StorageSlimUser
resourceSelectors	StorageResourceSelectorの一覧	`resource_selectors` は、各個人および `embedded_collections` のセレクターを使用して破棄(OR)として解決されます。MVP の場合、resource_selectors のサイズは UX の観点から最大 1 になります。
embeddedCollections	ResourceCollectionEmbeddedResourceCollectionのリスト

12.6.7.7. StorageResourceSelector

フィールド名	必須	Null 許容型	型	説明	形式
rules			StorageSelectorRuleの一覧	`ルール` は接続詞(AND)として解決されます。

12.6.7.8. StorageRuleValue

フィールド名	必須	Null 許容型	型	説明	形式
value			String
matchType			StorageMatchType		EXACT, REGEX,

12.6.7.9. StorageSelectorRule

フィールド名	型	説明	形式
fieldName	String
operator	StorageBooleanOperator		または、AND
values	StorageRuleValueの一覧	`値` は、演算子に応じて結合(AND)またはアンジェット(OR)として解決されます。MVP の場合、OR のみが UX の観点からサポートされています。

12.6.7.10. StorageSlimUser

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

12.6.7.11. V1UpdateCollectionRequest

フィールド名	必須	Null 許容型	型	説明	形式
id			String
name			String
description			String
resourceSelectors			StorageResourceSelectorの一覧
embeddedCollectionIds			`string` のリスト

12.6.7.12. V1UpdateCollectionResponse

フィールド名	必須	Null 許容型	型	説明	形式
コレクション			StorageResourceCollection

12.7. CreateCollection

POST /v1/collections

12.7.1. 説明

12.7.2. パラメーター

12.7.2.1. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1CreateCollectionRequest	X

12.7.3. 戻り値のタイプ

V1CreateCollectionResponse

12.7.4. コンテンツタイプ

application/json

12.7.5. レスポンス

表12.7 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1CreateCollectionResponse
0	予期しないエラーの応答です。	RuntimeError

12.7.6. サンプル

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

12.7.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

12.7.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

12.7.7.2. ResourceCollectionEmbeddedResourceCollection

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

12.7.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

12.7.7.4. StorageBooleanOperator

Enum 値
OR
AND

12.7.7.5. StorageMatchType

Enum 値
EXACT
REGEX

12.7.7.6. StorageResourceCollection

フィールド名	型	説明	形式
id	String
name	String
description	String
createdAt	Date		date-time
lastUpdated	Date		date-time
createdBy	StorageSlimUser
updatedBy	StorageSlimUser
resourceSelectors	StorageResourceSelectorの一覧	`resource_selectors` は、各個人および `embedded_collections` のセレクターを使用して破棄(OR)として解決されます。MVP の場合、resource_selectors のサイズは UX の観点から最大 1 になります。
embeddedCollections	ResourceCollectionEmbeddedResourceCollectionのリスト

12.7.7.7. StorageResourceSelector

フィールド名	必須	Null 許容型	型	説明	形式
rules			StorageSelectorRuleの一覧	`ルール` は接続詞(AND)として解決されます。

12.7.7.8. StorageRuleValue

フィールド名	必須	Null 許容型	型	説明	形式
value			String
matchType			StorageMatchType		EXACT, REGEX,

12.7.7.9. StorageSelectorRule

フィールド名	型	説明	形式
fieldName	String
operator	StorageBooleanOperator		または、AND
values	StorageRuleValueの一覧	`値` は、演算子に応じて結合(AND)またはアンジェット(OR)として解決されます。MVP の場合、OR のみが UX の観点からサポートされています。

12.7.7.10. StorageSlimUser

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

12.7.7.11. V1CreateCollectionRequest

フィールド名	必須	Null 許容型	型	説明	形式
name			String
description			String
resourceSelectors			StorageResourceSelectorの一覧
embeddedCollectionIds			`string` のリスト

12.7.7.12. V1CreateCollectionResponse

フィールド名	必須	Null 許容型	型	説明	形式
コレクション			StorageResourceCollection

12.8. ListCollectionSelectors

GET /v1/collections/selectors

12.8.1. 説明

12.8.2. パラメーター

12.8.3. 戻り値のタイプ

V1ListCollectionSelectorsResponse

12.8.4. コンテンツタイプ

application/json

12.8.5. レスポンス

表12.8 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1ListCollectionSelectorsResponse
0	予期しないエラーの応答です。	RuntimeError

12.8.6. サンプル

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

12.8.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

12.8.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

12.8.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

12.8.7.3. V1ListCollectionSelectorsResponse

フィールド名	必須	Null 許容型	型	説明	形式
selectors			`string` のリスト

第13章 ComplianceManagementService

13.1. GetRecentRuns

GET /v1/complianceManagement/runs

13.1.1. 説明

13.1.2. パラメーター

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

名前	必須	デフォルト
clusterId	-	null
standardId	-	null
次以降	-	null

13.1.3. 戻り値のタイプ

V1GetRecentComplianceRunsResponse

13.1.4. コンテンツタイプ

application/json

13.1.5. レスポンス

表13.1 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GetRecentComplianceRunsResponse
0	予期しないエラーの応答です。	RuntimeError

13.1.6. サンプル

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

13.1.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

13.1.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

13.1.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

13.1.7.3. V1ComplianceRun

フィールド名	型	形式
id	String
clusterId	String
standardId	String
startTime	Date	date-time
finishTime	Date	date-time
state	V1ComplianceRunState	INVALID, READY, STARTED, WAIT_FOR_DATA, EVALUTING_CHECKS, FINISHED,
errorMessage	String

13.1.7.4. V1ComplianceRunState

Enum 値
INVALID
READY
開始
WAIT_FOR_DATA
EVALUTING_CHECKS
FINISHED

13.1.7.5. V1GetRecentComplianceRunsResponse

フィールド名	必須	Null 許容型	型	説明	形式
complianceRuns			V1ComplianceRunのリスト

13.2. TriggerRuns

POST /v1/compliancemanagement/runs

13.2.1. 説明

13.2.2. パラメーター

13.2.2.1. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1TriggerComplianceRunsRequest	X

13.2.3. 戻り値のタイプ

V1TriggerComplianceRunsResponse

13.2.4. コンテンツタイプ

application/json

13.2.5. レスポンス

表13.2 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1TriggerComplianceRunsResponse
0	予期しないエラーの応答です。	RuntimeError

13.2.6. サンプル

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

13.2.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

13.2.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

13.2.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

13.2.7.3. V1ComplianceRun

フィールド名	型	形式
id	String
clusterId	String
standardId	String
startTime	Date	date-time
finishTime	Date	date-time
state	V1ComplianceRunState	INVALID, READY, STARTED, WAIT_FOR_DATA, EVALUTING_CHECKS, FINISHED,
errorMessage	String

13.2.7.4. V1ComplianceRunSelection

フィールド名	必須	Null 許容型	型	説明	形式
clusterId			String	クラスターの ID。\"*\" は \"all clusters\" を意味します。
standardId			String	コンプライアンス標準の ID です。\"*\" は、\"all standards\" を意味します。

13.2.7.5. V1ComplianceRunState

Enum 値
INVALID
READY
開始
WAIT_FOR_DATA
EVALUTING_CHECKS
FINISHED

13.2.7.6. V1TriggerComplianceRunsRequest

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

13.2.7.7. V1TriggerComplianceRunsResponse

フィールド名	必須	Null 許容型	型	説明	形式
startedRuns			V1ComplianceRunのリスト

13.3. GetRunStatuses

GET /v1/compliancemanagement/runstatuses

13.3.1. 説明

13.3.2. パラメーター

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

名前	説明	必須	デフォルト	Pattern
runIds	`String`	-	null
latest		-	null

13.3.3. 戻り値のタイプ

V1GetComplianceRunStatusesResponse

13.3.4. コンテンツタイプ

application/json

13.3.5. レスポンス

表13.3 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GetComplianceRunStatusesResponse
0	予期しないエラーの応答です。	RuntimeError

13.3.6. サンプル

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

13.3.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

13.3.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

13.3.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

13.3.7.3. V1ComplianceRun

フィールド名	型	形式
id	String
clusterId	String
standardId	String
startTime	Date	date-time
finishTime	Date	date-time
state	V1ComplianceRunState	INVALID, READY, STARTED, WAIT_FOR_DATA, EVALUTING_CHECKS, FINISHED,
errorMessage	String

13.3.7.4. V1ComplianceRunState

Enum 値
INVALID
READY
開始
WAIT_FOR_DATA
EVALUTING_CHECKS
FINISHED

13.3.7.5. V1GetComplianceRunStatusesResponse

フィールド名	必須	Null 許容型	型	説明	形式
invalidRunIds			`string` のリスト
実行			V1ComplianceRunのリスト

第14章 ComplianceService

14.1. GetAggregatedResults

GET /v1/compliance/aggregatedresults

14.1.1. 説明

14.1.2. パラメーター

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

名前	説明	必須	デフォルト
groupBy	`String`	-	null
unit		-	UNKNOWN
where.query		-	null
where.pagination.limit		-	null
where.pagination.offset		-	null
where.pagination.sortOption.field		-	null
where.pagination.sortOption.reversed		-	null
where.pagination.sortOption.aggregateBy.aggrFunc		-	UNSET
where.pagination.sortOption.aggregateBy.distinct		-	null

14.1.3. 戻り値のタイプ

StorageComplianceAggregationResponse

14.1.4. コンテンツタイプ

application/json

14.1.5. レスポンス

表14.1 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	StorageComplianceAggregationResponse
0	予期しないエラーの応答です。	RuntimeError

14.1.6. サンプル

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

14.1.7.1. ComplianceAggregationAggregationKey

Next available tag: 3

フィールド名	必須	Null 許容型	型	説明	形式
scope			StorageComplianceAggregationScope		UNKNOWN、STANDARD、CLUSTER、CATEGORY、CONTROL、NAMESPACE、NODE、DEPLOYMENT、CHECK
id			String

14.1.7.2. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

14.1.7.2.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

14.1.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

14.1.7.4. StorageComplianceAggregationResponse

Next available tag: 3

フィールド名	必須	Null 許容型	型	説明	形式
results			StorageComplianceAggregationResultのリスト
sources			StorageComplianceAggregationSourceのリスト
errorMessage			String

14.1.7.5. StorageComplianceAggregationResult

Next available tag: 5

フィールド名	型	形式
aggregationKeys	ComplianceAggregationAggregationKeyのリスト
unit	StorageComplianceAggregationScope	UNKNOWN、STANDARD、CLUSTER、CATEGORY、CONTROL、NAMESPACE、NODE、DEPLOYMENT、CHECK
numPassing	Integer	int32
numFailing	Integer	int32
numSkipped	Integer	int32

14.1.7.6. StorageComplianceAggregationScope

Enum 値
UNKNOWN
STANDARD （標準）
CLUSTER
CATEGORY
CONTROL
NAMESPACE
NODE
DEPLOYMENT
チェック

14.1.7.7. StorageComplianceAggregationSource

Next available tag: 5

フィールド名	必須	Null 許容型	型	説明	形式
clusterId			String
standardId			String
successfulRun			StorageComplianceRunMetadata
failedRuns			StorageComplianceRunMetadataの一覧

14.1.7.8. StorageComplianceRunMetadata

Next available tag: 5

フィールド名	型	形式
runId	String
standardId	String
clusterId	String
startTimestamp	Date	date-time
finishTimestamp	Date	date-time
success	Boolean
errorMessage	String
domainId	String

14.2. GetRunResults

GET /v1/compliance/runresults

14.2.1. 説明

14.2.2. パラメーター

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

名前	説明	必須	デフォルト
clusterId		-	null
standardId		-	null
runId	結果を返す実行 ID を指定します。空の場合は、最新の実行が返されます。CAVEAT: このフィールドを設定すると、サーバー側で結果キャッシュが回避されます。これにより、メモリー不足が大幅に増大し、パフォーマンスが低下する可能性があります。	-	null

14.2.3. 戻り値のタイプ

V1GetComplianceRunResultsResponse

14.2.4. コンテンツタイプ

application/json

14.2.5. レスポンス

表14.2 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GetComplianceRunResultsResponse
0	予期しないエラーの応答です。	RuntimeError

14.2.6. サンプル

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

14.2.7.1. ComplianceResultValueEvidence

フィールド名	型	形式
state	StorageComplianceState	COMPLIANCE_STATE_UNKNOWN、COMPLIANCE_STATE_SKIP、COMPLIANCE_STATE_NOTE、COMPLIANCE_STATE_SUCCESS、COMPLIANCE_STATE_FAILURE、COMPLIANCE_STATE_ERROR、
message	String
messageId	Integer	int32

14.2.7.2. ComplianceRunResultsEntityResults

フィールド名	必須	Null 許容型	型	説明	形式
controlResults			StorageComplianceResultValueのマップ

14.2.7.3. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

14.2.7.3.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

14.2.7.4. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

14.2.7.5. StorageComplianceDomain

Next available tag: 5

フィールド名	必須	Null 許容型	型	説明	形式
id			String
cluster			StorageComplianceDomainCluster
nodes			StorageComplianceDomainNodeのマップ
デプロイメント			StorageComplianceDomainDeploymentのマップ

14.2.7.6. StorageComplianceDomainCluster

These must mirror the tags _exactly_ in cluster.proto for backwards compatibility

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

14.2.7.7. StorageComplianceDomainDeployment

This must mirror the tags _exactly_ in deployment.proto for backwards compatibility

フィールド名	必須	Null 許容型	型	説明	形式
id			String
name			String
type			String
namespace			String
namespaceId			String
clusterId			String
clusterName			String

14.2.7.8. StorageComplianceDomainNode

These must mirror the tags _exactly_ in node.proto for backwards compatibility

フィールド名	必須	Null 許容型	型	説明	形式
id			String
name			String
clusterId			String
clusterName			String

14.2.7.9. StorageComplianceResultValue

フィールド名	必須	Null 許容型	型	説明	形式
エビデンス			ComplianceResultValueEvidenceのリスト
overallState			StorageComplianceState		COMPLIANCE_STATE_UNKNOWN、COMPLIANCE_STATE_SKIP、COMPLIANCE_STATE_NOTE、COMPLIANCE_STATE_SUCCESS、COMPLIANCE_STATE_FAILURE、COMPLIANCE_STATE_ERROR、

14.2.7.10. StorageComplianceRunMetadata

Next available tag: 5

フィールド名	型	形式
runId	String
standardId	String
clusterId	String
startTimestamp	Date	date-time
finishTimestamp	Date	date-time
success	Boolean
errorMessage	String
domainId	String

14.2.7.11. StorageComplianceRunResults

Next available tag: 6

フィールド名	必須	Null 許容型	型	説明	形式
domain			StorageComplianceDomain
runMetadata			StorageComplianceRunMetadata
clusterResults			ComplianceRunResultsEntityResults
nodeResults			ComplianceRunResultsEntityResultsのマップ
deploymentResults			ComplianceRunResultsEntityResultsのマップ
machineConfigResults			ComplianceRunResultsEntityResultsのマップ

14.2.7.12. StorageComplianceState

Enum 値
COMPLIANCE_STATE_UNKNOWN
COMPLIANCE_STATE_SKIP
COMPLIANCE_STATE_NOTE
COMPLIANCE_STATE_SUCCESS
COMPLIANCE_STATE_FAILURE
COMPLIANCE_STATE_ERROR

14.2.7.13. V1GetComplianceRunResultsResponse

フィールド名	必須	Null 許容型	型	説明	形式
results			StorageComplianceRunResults
failedRuns			StorageComplianceRunMetadataの一覧

14.3. GetStandards

GET /v1/compliance/standards

14.3.1. 説明

14.3.2. パラメーター

14.3.3. 戻り値のタイプ

V1GetComplianceStandardsResponse

14.3.4. コンテンツタイプ

application/json

14.3.5. レスポンス

表14.3 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GetComplianceStandardsResponse
0	予期しないエラーの応答です。	RuntimeError

14.3.6. サンプル

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

14.3.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

14.3.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

14.3.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

14.3.7.3. V1ComplianceStandardMetadata

フィールド名	型	形式
id	String
name	String
description	String
numImplementedChecks	Integer	int32
scopes	V1ComplianceStandardMetadataScopeのリスト
dynamic	Boolean
hideScanResults	Boolean

14.3.7.4. V1ComplianceStandardMetadataScope

Enum 値
UNSET
CLUSTER
NAMESPACE
DEPLOYMENT
NODE

14.3.7.5. V1GetComplianceStandardsResponse

フィールド名	必須	Null 許容型	型	説明	形式
standards			V1ComplianceStandardMetadataのリスト

14.4. GetStandard

GET /v1/compliance/standards/{id}

14.4.1. 説明

14.4.2. パラメーター

14.4.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

14.4.3. 戻り値のタイプ

V1GetComplianceStandardResponse

14.4.4. コンテンツタイプ

application/json

14.4.5. レスポンス

表14.4 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GetComplianceStandardResponse
0	予期しないエラーの応答です。	RuntimeError

14.4.6. サンプル

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

14.4.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

14.4.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

14.4.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

14.4.7.3. V1ComplianceControl

フィールド名	必須	Null 許容型	型	説明	形式
id			String
standardId			String
groupId			String
name			String
description			String
implemented			Boolean
interpretationText			String

14.4.7.4. V1ComplianceControlGroup

フィールド名	型	形式
id	String
standardId	String
name	String
description	String
numImplementedChecks	Integer	int32

14.4.7.5. V1ComplianceStandard

フィールド名	必須	Null 許容型	型	説明	形式
metadata			V1ComplianceStandardMetadata
groups			V1ComplianceControlGroupのリスト
controls			V1ComplianceControlのリスト

14.4.7.6. V1ComplianceStandardMetadata

フィールド名	型	形式
id	String
name	String
description	String
numImplementedChecks	Integer	int32
scopes	V1ComplianceStandardMetadataScopeのリスト
dynamic	Boolean
hideScanResults	Boolean

14.4.7.7. V1ComplianceStandardMetadataScope

Enum 値
UNSET
CLUSTER
NAMESPACE
DEPLOYMENT
NODE

14.4.7.8. V1GetComplianceStandardResponse

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

14.5. UpdateComplianceStandardConfig

PATCH /v1/compliance/standards/{id}

14.5.1. 説明

14.5.2. パラメーター

14.5.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

14.5.2.2. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1UpdateComplianceRequest	X

14.5.3. 戻り値のタイプ

Object

14.5.4. コンテンツタイプ

application/json

14.5.5. レスポンス

表14.5 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	`Object`
0	予期しないエラーの応答です。	RuntimeError

14.5.6. サンプル

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

14.5.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

14.5.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

14.5.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

14.5.7.3. V1UpdateComplianceRequest

フィールド名	必須	Null 許容型	型	説明	形式
id			String
hideScanResults			Boolean

第15章 ConfigService

15.1. GetConfig

GET /v1/config

15.1.1. 説明

15.1.2. パラメーター

15.1.3. 戻り値のタイプ

StorageConfig

15.1.4. コンテンツタイプ

application/json

15.1.5. レスポンス

表15.1 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	StorageConfig
0	予期しないエラーの応答です。	RuntimeError

15.1.6. サンプル

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

15.1.7.1. BannerConfigSize

Enum 値
UNSET
SMALL
MEDIUM
LARGE

15.1.7.2. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

15.1.7.2.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

15.1.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

15.1.7.4. StorageAdministrationEventsConfig

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

15.1.7.5. StorageAlertRetentionConfig

フィールド名	型	説明	形式
resolvedDeployRetentionDurationDays	Integer		int32
deletedRuntimeRetentionDurationDays	Integer	このランタイムアラートの保持設定は、`allRuntimeRetentionDurationDays` の後に優先されます。	int32
allRuntimeRetentionDurationDays	Integer	このランタイムアラートの保持設定は、優先度が最も高くなります。試行されたアラートや削除されたデプロイメントアラートを含むすべてのランタイムアラートは、それぞれの保持期間が長い場合でも削除されます。	int32
attemptedDeployRetentionDurationDays	Integer		int32
attemptedRuntimeRetentionDurationDays	Integer	このランタイムアラートの保持設定は最優先されています。	int32

15.1.7.6. StorageBannerConfig

フィールド名	型	形式
enabled	Boolean
text	String
size	BannerConfigSize	UNSET、MALL、MEDIUM、LARGE
color	String
backgroundColor	String

15.1.7.7. StorageConfig

フィールド名	必須	Null 許容型	型	説明	形式
publicConfig			StoragePublicConfig
privateConfig			StoragePrivateConfig

15.1.7.8. StorageDayOption

フィールド名	必須	Null 許容型	型	説明	形式
numDays			Long		int64
enabled			Boolean

15.1.7.9. StorageDecommissionedClusterRetentionConfig

next available tag: 5

フィールド名	型	形式
retentionDurationDays	Integer	int32
ignoreClusterLabels	`文字列`のマップ
lastUpdated	Date	date-time
createdAt	Date	date-time

15.1.7.10. StorageLoginNotice

フィールド名	必須	Null 許容型	型	説明	形式
enabled			Boolean
text			String

15.1.7.11. StoragePrivateConfig

next available tag:9

フィールド名	型	形式
DEPRECATEDAlertRetentionDurationDays	Integer	int32
alertConfig	StorageAlertRetentionConfig
imageRetentionDurationDays	Integer	int32
expiredVulnReqRetentionDurationDays	Integer	int32
decommissionedClusterRetention	StorageDecommissionedClusterRetentionConfig
reportRetentionConfig	StorageReportRetentionConfig
vulnerabilityExceptionConfig	StorageVulnerabilityExceptionConfig
administrationEventsConfig	StorageAdministrationEventsConfig

15.1.7.12. StoragePublicConfig

フィールド名	必須	Null 許容型	型	説明	形式
loginNotice			StorageLoginNotice
header			StorageBannerConfig
footer			StorageBannerConfig
telemetry			StorageTelemetryConfiguration

15.1.7.13. StorageReportRetentionConfig

next available tag: 4

フィールド名	型	形式
historyRetentionDurationDays	Long	int64
downloadableReportRetentionDays	Long	int64
downloadableReportGlobalRetentionBytes	Long	int64

15.1.7.14. StorageTelemetryConfiguration

フィールド名	必須	Null 許容型	型	説明	形式
enabled			Boolean
lastSetTime			Date		date-time

15.1.7.15. StorageVulnerabilityExceptionConfig

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

15.1.7.16. StorageVulnerabilityExceptionConfigExpiryOptions

フィールド名	必須	Null 許容型	型	説明	形式
dayOptions			StorageDayOptionの一覧
fixableCveOptions			StorageVulnerabilityExceptionConfigFixableCVEOptions
customDate			Boolean
indefinite			Boolean

15.1.7.17. StorageVulnerabilityExceptionConfigFixableCVEOptions

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

15.2. GetVulnerabilityExceptionConfig

GET /v1/config/private/exception/vulnerabilities

15.2.1. 説明

15.2.2. パラメーター

15.2.3. 戻り値のタイプ

V1GetVulnerabilityExceptionConfigResponse

15.2.4. コンテンツタイプ

application/json

15.2.5. レスポンス

表15.2 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GetVulnerabilityExceptionConfigResponse
0	予期しないエラーの応答です。	RuntimeError

15.2.6. サンプル

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

15.2.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

15.2.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

15.2.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

15.2.7.3. V1DayOption

フィールド名	必須	Null 許容型	型	説明	形式
numDays			Long		int64
enabled			Boolean

15.2.7.4. V1GetVulnerabilityExceptionConfigResponse

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

15.2.7.5. V1VulnerabilityExceptionConfig

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

15.2.7.6. V1VulnerabilityExceptionConfigExpiryOptions

フィールド名	型	説明
dayOptions	V1DayOptionのリスト	これにより、ユーザーは日数に基づいて有効期限を設定できます。
fixableCveOptions	V1VulnerabilityExceptionConfigFixableCVEOptions
customDate	Boolean	このオプションにより、true の場合、UI は有効期限を設定するためのカスタム日付の選択を表示できます。
indefinite	Boolean

15.2.7.7. V1VulnerabilityExceptionConfigFixableCVEOptions

フィールド名	必須	Null 許容型	型	説明	形式
allFixable			Boolean	このオプションを使用すると、リクエスト内のすべての脆弱性が修正可能な場合にのみ、脆弱性の延期要求を失効させることができます。
anyFixable			Boolean	このオプションを使用すると、リクエストの脆弱性が修正可能になった場合に、脆弱性の延期リクエストを失効させることができます。

15.3. UpdateVulnerabilityExceptionConfig

PUT /v1/config/private/exception/vulnerabilities

15.3.1. 説明

15.3.2. パラメーター

15.3.2.1. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1UpdateVulnerabilityExceptionConfigRequest	X

15.3.3. 戻り値のタイプ

V1UpdateVulnerabilityExceptionConfigResponse

15.3.4. コンテンツタイプ

application/json

15.3.5. レスポンス

表15.3 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1UpdateVulnerabilityExceptionConfigResponse
0	予期しないエラーの応答です。	RuntimeError

15.3.6. サンプル

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

15.3.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

15.3.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

15.3.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

15.3.7.3. V1DayOption

フィールド名	必須	Null 許容型	型	説明	形式
numDays			Long		int64
enabled			Boolean

15.3.7.4. V1UpdateVulnerabilityExceptionConfigRequest

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

15.3.7.5. V1UpdateVulnerabilityExceptionConfigResponse

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

15.3.7.6. V1VulnerabilityExceptionConfig

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

15.3.7.7. V1VulnerabilityExceptionConfigExpiryOptions

フィールド名	型	説明
dayOptions	V1DayOptionのリスト	これにより、ユーザーは日数に基づいて有効期限を設定できます。
fixableCveOptions	V1VulnerabilityExceptionConfigFixableCVEOptions
customDate	Boolean	このオプションにより、true の場合、UI は有効期限を設定するためのカスタム日付の選択を表示できます。
indefinite	Boolean

15.3.7.8. V1VulnerabilityExceptionConfigFixableCVEOptions

フィールド名	必須	Null 許容型	型	説明	形式
allFixable			Boolean	このオプションを使用すると、リクエスト内のすべての脆弱性が修正可能な場合にのみ、脆弱性の延期要求を失効させることができます。
anyFixable			Boolean	このオプションを使用すると、リクエストの脆弱性が修正可能になった場合に、脆弱性の延期リクエストを失効させることができます。

15.4. GetPrivateConfig

GET /v1/config/private

15.4.1. 説明

15.4.2. パラメーター

15.4.3. 戻り値のタイプ

StoragePrivateConfig

15.4.4. コンテンツタイプ

application/json

15.4.5. レスポンス

表15.4 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	StoragePrivateConfig
0	予期しないエラーの応答です。	RuntimeError

15.4.6. サンプル

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

15.4.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

15.4.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

15.4.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

15.4.7.3. StorageAdministrationEventsConfig

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

15.4.7.4. StorageAlertRetentionConfig

フィールド名	型	説明	形式
resolvedDeployRetentionDurationDays	Integer		int32
deletedRuntimeRetentionDurationDays	Integer	このランタイムアラートの保持設定は、`allRuntimeRetentionDurationDays` の後に優先されます。	int32
allRuntimeRetentionDurationDays	Integer	このランタイムアラートの保持設定は、優先度が最も高くなります。試行されたアラートや削除されたデプロイメントアラートを含むすべてのランタイムアラートは、それぞれの保持期間が長い場合でも削除されます。	int32
attemptedDeployRetentionDurationDays	Integer		int32
attemptedRuntimeRetentionDurationDays	Integer	このランタイムアラートの保持設定は最優先されています。	int32

15.4.7.5. StorageDayOption

フィールド名	必須	Null 許容型	型	説明	形式
numDays			Long		int64
enabled			Boolean

15.4.7.6. StorageDecommissionedClusterRetentionConfig

next available tag: 5

フィールド名	型	形式
retentionDurationDays	Integer	int32
ignoreClusterLabels	`文字列`のマップ
lastUpdated	Date	date-time
createdAt	Date	date-time

15.4.7.7. StoragePrivateConfig

next available tag:9

フィールド名	型	形式
DEPRECATEDAlertRetentionDurationDays	Integer	int32
alertConfig	StorageAlertRetentionConfig
imageRetentionDurationDays	Integer	int32
expiredVulnReqRetentionDurationDays	Integer	int32
decommissionedClusterRetention	StorageDecommissionedClusterRetentionConfig
reportRetentionConfig	StorageReportRetentionConfig
vulnerabilityExceptionConfig	StorageVulnerabilityExceptionConfig
administrationEventsConfig	StorageAdministrationEventsConfig

15.4.7.8. StorageReportRetentionConfig

next available tag: 4

フィールド名	型	形式
historyRetentionDurationDays	Long	int64
downloadableReportRetentionDays	Long	int64
downloadableReportGlobalRetentionBytes	Long	int64

15.4.7.9. StorageVulnerabilityExceptionConfig

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

15.4.7.10. StorageVulnerabilityExceptionConfigExpiryOptions

フィールド名	必須	Null 許容型	型	説明	形式
dayOptions			StorageDayOptionの一覧
fixableCveOptions			StorageVulnerabilityExceptionConfigFixableCVEOptions
customDate			Boolean
indefinite			Boolean

15.4.7.11. StorageVulnerabilityExceptionConfigFixableCVEOptions

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

15.5. GetPublicConfig

GET /v1/config/public

15.5.1. 説明

15.5.2. パラメーター

15.5.3. 戻り値のタイプ

StoragePublicConfig

15.5.4. コンテンツタイプ

application/json

15.5.5. レスポンス

表15.5 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	StoragePublicConfig
0	予期しないエラーの応答です。	RuntimeError

15.5.6. サンプル

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

15.5.7.1. BannerConfigSize

Enum 値
UNSET
SMALL
MEDIUM
LARGE

15.5.7.2. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

15.5.7.2.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

15.5.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

15.5.7.4. StorageBannerConfig

フィールド名	型	形式
enabled	Boolean
text	String
size	BannerConfigSize	UNSET、MALL、MEDIUM、LARGE
color	String
backgroundColor	String

15.5.7.5. StorageLoginNotice

フィールド名	必須	Null 許容型	型	説明	形式
enabled			Boolean
text			String

15.5.7.6. StoragePublicConfig

フィールド名	必須	Null 許容型	型	説明	形式
loginNotice			StorageLoginNotice
header			StorageBannerConfig
footer			StorageBannerConfig
telemetry			StorageTelemetryConfiguration

15.5.7.7. StorageTelemetryConfiguration

フィールド名	必須	Null 許容型	型	説明	形式
enabled			Boolean
lastSetTime			Date		date-time

15.6. PutConfig

PUT /v1/config

15.6.1. 説明

15.6.2. パラメーター

15.6.2.1. ボディパラメーター

名前	説明	必須	デフォルト	Pattern
body	V1PutConfigRequest	X

15.6.3. 戻り値のタイプ

StorageConfig

15.6.4. コンテンツタイプ

application/json

15.6.5. レスポンス

表15.6 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	StorageConfig
0	予期しないエラーの応答です。	RuntimeError

15.6.6. サンプル

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

15.6.7.1. BannerConfigSize

Enum 値
UNSET
SMALL
MEDIUM
LARGE

15.6.7.2. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

15.6.7.2.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

15.6.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

15.6.7.4. StorageAdministrationEventsConfig

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

15.6.7.5. StorageAlertRetentionConfig

フィールド名	型	説明	形式
resolvedDeployRetentionDurationDays	Integer		int32
deletedRuntimeRetentionDurationDays	Integer	このランタイムアラートの保持設定は、`allRuntimeRetentionDurationDays` の後に優先されます。	int32
allRuntimeRetentionDurationDays	Integer	このランタイムアラートの保持設定は、優先度が最も高くなります。試行されたアラートや削除されたデプロイメントアラートを含むすべてのランタイムアラートは、それぞれの保持期間が長い場合でも削除されます。	int32
attemptedDeployRetentionDurationDays	Integer		int32
attemptedRuntimeRetentionDurationDays	Integer	このランタイムアラートの保持設定は最優先されています。	int32

15.6.7.6. StorageBannerConfig

フィールド名	型	形式
enabled	Boolean
text	String
size	BannerConfigSize	UNSET、MALL、MEDIUM、LARGE
color	String
backgroundColor	String

15.6.7.7. StorageConfig

フィールド名	必須	Null 許容型	型	説明	形式
publicConfig			StoragePublicConfig
privateConfig			StoragePrivateConfig

15.6.7.8. StorageDayOption

フィールド名	必須	Null 許容型	型	説明	形式
numDays			Long		int64
enabled			Boolean

15.6.7.9. StorageDecommissionedClusterRetentionConfig

next available tag: 5

フィールド名	型	形式
retentionDurationDays	Integer	int32
ignoreClusterLabels	`文字列`のマップ
lastUpdated	Date	date-time
createdAt	Date	date-time

15.6.7.10. StorageLoginNotice

フィールド名	必須	Null 許容型	型	説明	形式
enabled			Boolean
text			String

15.6.7.11. StoragePrivateConfig

next available tag:9

フィールド名	型	形式
DEPRECATEDAlertRetentionDurationDays	Integer	int32
alertConfig	StorageAlertRetentionConfig
imageRetentionDurationDays	Integer	int32
expiredVulnReqRetentionDurationDays	Integer	int32
decommissionedClusterRetention	StorageDecommissionedClusterRetentionConfig
reportRetentionConfig	StorageReportRetentionConfig
vulnerabilityExceptionConfig	StorageVulnerabilityExceptionConfig
administrationEventsConfig	StorageAdministrationEventsConfig

15.6.7.12. StoragePublicConfig

フィールド名	必須	Null 許容型	型	説明	形式
loginNotice			StorageLoginNotice
header			StorageBannerConfig
footer			StorageBannerConfig
telemetry			StorageTelemetryConfiguration

15.6.7.13. StorageReportRetentionConfig

next available tag: 4

フィールド名	型	形式
historyRetentionDurationDays	Long	int64
downloadableReportRetentionDays	Long	int64
downloadableReportGlobalRetentionBytes	Long	int64

15.6.7.14. StorageTelemetryConfiguration

フィールド名	必須	Null 許容型	型	説明	形式
enabled			Boolean
lastSetTime			Date		date-time

15.6.7.15. StorageVulnerabilityExceptionConfig

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

15.6.7.16. StorageVulnerabilityExceptionConfigExpiryOptions

フィールド名	必須	Null 許容型	型	説明	形式
dayOptions			StorageDayOptionの一覧
fixableCveOptions			StorageVulnerabilityExceptionConfigFixableCVEOptions
customDate			Boolean
indefinite			Boolean

15.6.7.17. StorageVulnerabilityExceptionConfigFixableCVEOptions

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

15.6.7.18. V1PutConfigRequest

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

第16章 CredentialExpiryService

16.1. GetCertExpiry

GET /v1/credentialexpiry

GetCertExpiry は、期限切れコンポーネントの mTLS 証明書に関連する情報を返します。

16.1.1. 説明

16.1.2. パラメーター

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

名前	説明	必須	デフォルト	Pattern
component		-	UNKNOWN

16.1.3. 戻り値のタイプ

V1GetCertExpiryResponse

16.1.4. コンテンツタイプ

application/json

16.1.5. レスポンス

表16.1 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GetCertExpiryResponse
0	予期しないエラーの応答です。	RuntimeError

16.1.6. サンプル

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

16.1.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

16.1.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

16.1.7.2. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

16.1.7.3. V1GetCertExpiryResponse

フィールド名	必須	Null 許容型	型	説明	形式
expiry			Date		date-time

第17章 DBService

17.1. GetExportCapabilities

GET /v1/db/exportcaps

17.1.1. 説明

17.1.2. パラメーター

17.1.3. 戻り値のタイプ

V1GetDBExportCapabilitiesResponse

17.1.4. コンテンツタイプ

application/json

17.1.5. レスポンス

表17.1 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GetDBExportCapabilitiesResponse
0	予期しないエラーの応答です。	RuntimeError

17.1.6. サンプル

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

17.1.7.1. DBExportManifestEncodingType

復元本文内のファイルデータのエンコード。通常は圧縮目的で使用されます。

Enum 値
UNKNOWN
UNCOMPREESSED
DEFLATED

17.1.7.2. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

17.1.7.2.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

17.1.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

17.1.7.4. V1DBExportFormat

DBExportFormat は、データベースエクスポートの形式(= ファイルのコレクション)を説明します。

フィールド名	必須	Null 許容型	型	説明	形式
formatName			String
files			V1DBExportFormatFileのリスト

17.1.7.5. V1DBExportFormatFile

フィールド名	必須	Null 許容型	型	説明	形式
name			String
optional			Boolean

17.1.7.6. V1GetDBExportCapabilitiesResponse

フィールド名	必須	Null 許容型	型	説明	形式
形式			V1DBExportFormatのリスト
supportedEncodings			DBExportManifestEncodingTypeのリスト

17.2. InterruptRestoreProcess

POST /v1/db/interruptrestore/{processId}/{attemptId}

17.2.1. 説明

17.2.2. パラメーター

17.2.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
processId		X	null
attemptId		X	null

17.2.3. 戻り値のタイプ

V1InterruptDBRestoreProcessResponse

17.2.4. コンテンツタイプ

application/json

17.2.5. レスポンス

表17.2 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1InterruptDBRestoreProcessResponse
0	予期しないエラーの応答です。	RuntimeError

17.2.6. サンプル

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

17.2.7.1. DBRestoreProcessStatusResumeInfo

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

17.2.7.2. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

17.2.7.2.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

17.2.7.3. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

17.2.7.4. V1InterruptDBRestoreProcessResponse

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

17.3. GetActiveRestoreProcess

GET /v1/db/restore

17.3.1. 説明

17.3.2. パラメーター

17.3.3. 戻り値のタイプ

V1GetActiveDBRestoreProcessResponse

17.3.4. コンテンツタイプ

application/json

17.3.5. レスポンス

表17.3 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	V1GetActiveDBRestoreProcessResponse
0	予期しないエラーの応答です。	RuntimeError

17.3.6. サンプル

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

17.3.7.1. DBExportManifestEncodingType

復元本文内のファイルデータのエンコード。通常は圧縮目的で使用されます。

Enum 値
UNKNOWN
UNCOMPREESSED
DEFLATED

17.3.7.2. DBRestoreProcessStatusResumeInfo

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

17.3.7.3. DBRestoreRequestHeaderLocalFileInfo

LocalFileInfo は、進行中の復元プロセスに関する情報を他のユーザーに提供するために、復元プロセスを開始するユーザーのローカルマシン上のファイルに関する情報を提供します。

フィールド名	必須	Null 許容型	型	説明	形式
path			String	ファイルの完全パス。
bytesSize			String	ファイルのサイズ（バイト単位）。不明な場合は 0。	int64

17.3.7.4. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

17.3.7.4.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

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

17.3.7.5. RuntimeError

フィールド名	型	形式
error	String
code	Integer	int32
message	String
details	ProtobufAnyのリスト

17.3.7.6. V1DBExportManifest

DB エクスポートマニフェストは、復元リクエストのファイルの内容を説明します。データの損失を防ぐために、マニフェストは常にバインディングとして解釈されます。つまり、サーバーはマニフェストにリストされているすべてのファイルを読み取り、使用するようにする必要があります。そうでない場合は、要求を拒否する必要があります。

フィールド名	必須	Null 許容型	型	説明	形式
files			V1DBExportManifestFileのリスト

17.3.7.7. V1DBExportManifestFile

復元本文の 1 つのファイル。

フィールド名	型	説明	形式
name	String	ファイルの名前。これは、（相対）ファイルパスであり、解釈するサーバーまでの場合とそうでない場合があります。ZIP ファイルとしてエクスポートされるデータベースの場合、これはアーカイブのルートに対する相対パスです。
encoding	DBExportManifestEncodingType		UNKNOWN、UNCOMPREESSED、DEFLATED、
encodedSize	String		int64
decodedSize	String		int64
decodedCrc32	Long	デコードされた(!)データの CRC32 (IEEE)チェックサム。	int64

17.3.7.8. V1DBRestoreProcessMetadata

進行中の復元プロセスまたは完了した復元プロセスのメタデータ。これは静的なメタデータで、変更されません（つまりステータスではありません）。

フィールド名	型	説明	形式
id	String	復元プロセスを識別する ID。Auto-assigned。
header	V1DBRestoreRequestHeader
startTime	Date	復元プロセスが開始された時間。	date-time
initiatingUserName	String	データベースの復元プロセスを開始したユーザー。

17.3.7.9. V1DBRestoreProcessStatus

フィールド名	型	形式
metadata	V1DBRestoreProcessMetadata
attemptId	String
state	V1DBRestoreProcessStatusState	UNKNOWN, NOT_STARTED, IN_PROGRESS, PAUSED, COMPLETED,
resumeInfo	DBRestoreProcessStatusResumeInfo
error	String
bytesRead	String	int64
filesProcessed	String	int64

17.3.7.10. V1DBRestoreProcessStatusState

Enum 値
UNKNOWN
NOT_STARTED
IN_PROGRESS
PAUSED
COMPLETED

17.3.7.11. V1DBRestoreRequestHeader

フィールド名	型	説明
formatName	String	データベースエクスポート形式の名前。必須。
マニフェスト	V1DBExportManifest
localFile	DBRestoreRequestHeaderLocalFileInfo

17.3.7.12. V1GetActiveDBRestoreProcessResponse

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

17.4. CancelRestoreProcess

DELETE /v1/db/restore/{id}

17.4.1. 説明

17.4.2. パラメーター

17.4.2.1. パスパラメーター

名前	説明	必須	デフォルト	Pattern
id		X	null

17.4.3. 戻り値のタイプ

Object

17.4.4. コンテンツタイプ

application/json

17.4.5. レスポンス

表17.4 HTTP 応答コード
コード	メッセージ	データタイプ
200	正常な応答。	`Object`
0	予期しないエラーの応答です。	RuntimeError

17.4.6. サンプル

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

17.4.7.1. ProtobufAny

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

例 1: C++ のメッセージをパックして展開します。

Foo foo = ...;
Any any;
any.PackFrom(foo);
...
if (any.UnpackTo(&foo)) {
  ...
}

例 2: Java でメッセージをパックして解凍します。

Foo foo = ...;
Any any = Any.pack(foo);
...
if (any.is(Foo.class)) {
  foo = any.unpack(Foo.class);
}
// or ...
if (any.isSameTypeAs(Foo.getDefaultInstance())) {
  foo = any.unpack(Foo.getDefaultInstance());
}

Example 3: Pack and unpack a message in Python.

foo = Foo(...)
any = Any()
any.Pack(foo)
...
if any.Is(Foo.DESCRIPTOR):
  any.Unpack(foo)
  ...

Example 4: Pack and unpack a message in Go

foo := &pb.Foo{...}
any, err := anypb.New(foo)
if err != nil {
  ...
}
...
foo := &pb.Foo{}
if err := any.UnmarshalTo(foo); err != nil {
  ...
}

17.4.7.1.1. JSON 表現

package google.profile;
message Person {
  string first_name = 1;
  string last_name = 2;
}

{
  "@type": "type.googleapis.com/google.profile.Person",
  "firstName": <string>,
  "lastName": <string>
}

{
  "@type": "type.googleapis.com/google.protobuf.Duration",
  "value": "1.212s"
}

フィールド名	必須	Null 許容型	型	説明	形式
typeUrl			String	シリアライズされたプロトコルバッファーメッセージのタイプを一意に識別する URL/リソース名。この文字列には最低でも 1 つの \"/\" 文字を含める必要があります。URL のパスの最後のセグメントは、タイプの完全修飾名( `path/google.protobuf.Duration`にあるように)を表す必要があります。名前は正規の形式である必要があります（たとえば、先頭 \".\" は受け入れられません）。実際には、チームは通常、バイナリーにプリコンパイルして、任意のコンテキストで使用することを期待しているすべてのタイプにプレコンパイルします。ただし、スキーム `http`、`https`、またはスキームを使用しない URL の場合、以下のようにタイプ UR