API リファレンス

Red Hat Advanced Cluster Security for Kubernetes 4.7

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

Red Hat OpenShift Documentation Team

法律上の通知

概要

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

第1章バージョン v1

1.1. AdministrationEventService

1.1.1. ListAdministrationEvents

GET /v1/administration/events

ListAdministrationEvents は、要求されたフィールドに基づいてフィルタリングした後のイベントのリストを返します。

1.1.1.1. 説明

1.1.1.2. パラメーター

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

名前	説明	必須	デフォルト
pagination.limit		-	null
pagination.offset		-	null
pagination.sortOption.field		-	null
pagination.sortOption.reversed		-	null
pagination.sortOption.aggregateBy.aggrFunc		-	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.1.3. 戻り値のタイプ

V1ListAdministrationEventsResponse

1.1.1.4. コンテンツタイプ

application/json

1.1.1.5. レスポンス

表1.1 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListAdministrationEventsResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.1.1.6. サンプル

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

1.1.1.7.1. GooglerpcStatus

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

1.1.1.7.2. ProtobufAny

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

Protobuf ライブラリーは、ユーティリティー関数または Any 型の追加の生成メソッドといった形式で 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 ライブラリーによって提供される pack メソッドは、デフォルトで型 URL として 'type.googleapis.com/full.type.name' を使用し、unpack メソッドは型 URL の最後の '/' の後の完全修飾型名のみを使用します。たとえば、"foo.bar.com/x/y.z" は型名 "y.z" を生成します。

1.1.1.7.2.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.1.1.7.3. V1AdministrationEvent

AdministrationEvents は、Central によって出力される管理イベントです。これらは、非同期のバックグラウンドタスクについてユーザーに対して透明性を提供するために使用されます。イベントは、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.1.7.4. V1AdministrationEventLevel

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

列挙値
ADMINISTRATION_EVENT_LEVEL_UNKNOWN
ADMINISTRATION_EVENT_LEVEL_INFO
ADMINISTRATION_EVENT_LEVEL_SUCCESS
ADMINISTRATION_EVENT_LEVEL_WARNING
ADMINISTRATION_EVENT_LEVEL_ERROR

1.1.1.7.5. V1AdministrationEventResource

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

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

1.1.1.7.6. V1AdministrationEventType

AdministrationEventType はさまざまな種類のイベントを公開します。

列挙値
ADMINISTRATION_EVENT_TYPE_UNKNOWN
ADMINISTRATION_EVENT_TYPE_GENERIC
ADMINISTRATION_EVENT_TYPE_LOG_MESSAGE

1.1.1.7.7. V1ListAdministrationEventsResponse

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

1.1.2. GetAdministrationEvent

GET /v1/administration/events/{id}

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

1.1.2.1. 説明

1.1.2.2. パラメーター

1.1.2.2.1. パスパラメーター

名前	説明	必須	デフォルト	パターン
id		X	null

1.1.2.3. 戻り値のタイプ

V1GetAdministrationEventResponse

1.1.2.4. コンテンツタイプ

application/json

1.1.2.5. レスポンス

表1.2 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetAdministrationEventResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.1.2.6. サンプル

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

1.1.2.7.1. GooglerpcStatus

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

1.1.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 {
  ...
}

1.1.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.1.2.7.3. V1AdministrationEvent

フィールド名	型	説明	形式
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.2.7.4. V1AdministrationEventLevel

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

列挙値
ADMINISTRATION_EVENT_LEVEL_UNKNOWN
ADMINISTRATION_EVENT_LEVEL_INFO
ADMINISTRATION_EVENT_LEVEL_SUCCESS
ADMINISTRATION_EVENT_LEVEL_WARNING
ADMINISTRATION_EVENT_LEVEL_ERROR

1.1.2.7.5. V1AdministrationEventResource

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

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

1.1.2.7.6. V1AdministrationEventType

AdministrationEventType はさまざまな種類のイベントを公開します。

列挙値
ADMINISTRATION_EVENT_TYPE_UNKNOWN
ADMINISTRATION_EVENT_TYPE_GENERIC
ADMINISTRATION_EVENT_TYPE_LOG_MESSAGE

1.1.2.7.7. V1GetAdministrationEventResponse

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

1.1.3. CountAdministrationEvents

GET /v1/count/administration/events

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

1.1.3.1. 説明

1.1.3.2. パラメーター

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

名前	説明	必須	デフォルト
filter.from	特定のタイムスタンプ (下限) より後の last_occurred_at が含まれるイベントを特定します。	-	null
filter.until	特定のタイムスタンプ (上限) より前の last_occurred_at が含まれるイベントを特定します。	-	null
filter.domain	特定のドメインからのイベントを特定します。`String`	-	null
filter.resourceType	特定のリソース型に関連するイベントを特定します。`String`	-	null
filter.type	それらの型に基づいてイベントを特定します。`String`	-	null
filter.level	レベルに基づいてイベントを特定します。`String`	-	null

1.1.3.3. 戻り値のタイプ

V1CountAdministrationEventsResponse

1.1.3.4. コンテンツタイプ

application/json

1.1.3.5. レスポンス

表1.3 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CountAdministrationEventsResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.1.3.6. サンプル

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

1.1.3.7.1. GooglerpcStatus

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

1.1.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 {
  ...
}

1.1.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.1.3.7.3. V1CountAdministrationEventsResponse

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

1.2. AdministrationUsageService

1.2.1. GetCurrentSecuredUnitsUsage

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

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

1.2.1.1. 説明

セキュアなユニットのメトリクスは、5 分間隔ですべての接続クラスターから収集されるため、返される結果には、その 5 分間においては正確な接続クラスターのデータが含まれます。ただし、古くなった非接続クラスターのデータも含まれる可能性があります。

1.2.1.2. パラメーター

1.2.1.3. 戻り値のタイプ

V1SecuredUnitsUsageResponse

1.2.1.4. コンテンツタイプ

application/json

1.2.1.5. レスポンス

表1.4 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1SecuredUnitsUsageResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.2.1.6. サンプル

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

1.2.1.7.1. GooglerpcStatus

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

1.2.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 {
  ...
}

1.2.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.2.1.7.3. V1SecuredUnitsUsageResponse

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

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

1.2.2. GetMaxSecuredUnitsUsage

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

GetMaxSecuredUnitsUsage は、指定された時間範囲内で確認されたセキュアなユニットの最大値 (つまりピーク) と、この最大値が集計、保存された時刻を返します。

1.2.2.1. 説明

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

1.2.2.2. パラメーター

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

名前	説明	必須	デフォルト	パターン
from		-	null
to		-	null

1.2.2.3. 戻り値のタイプ

V1MaxSecuredUnitsUsageResponse

1.2.2.4. コンテンツタイプ

application/json

1.2.2.5. レスポンス

表1.5 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1MaxSecuredUnitsUsageResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.2.2.6. サンプル

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

1.2.2.7.1. GooglerpcStatus

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

1.2.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 {
  ...
}

1.2.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.2.2.7.3. V1MaxSecuredUnitsUsageResponse

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

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

1.3. AlertService

1.3.1. CountAlerts

GET /v1/alertscount

CountAlerts は、get リクエストに一致するアラートの数をカウントします。

1.3.1.1. 説明

1.3.1.2. パラメーター

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

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

1.3.1.3. 戻り値のタイプ

V1CountAlertsResponse

1.3.1.4. コンテンツタイプ

application/json

1.3.1.5. レスポンス

表1.6 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CountAlertsResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.3.1.6. サンプル

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

1.3.1.7.1. GooglerpcStatus

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

1.3.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 {
  ...
}

1.3.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.3.1.7.3. V1CountAlertsResponse

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

1.3.2. DeleteAlerts

DELETE /v1/alerts

1.3.2.1. 説明

1.3.2.2. パラメーター

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

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

1.3.2.3. 戻り値のタイプ

V1DeleteAlertsResponse

1.3.2.4. コンテンツタイプ

application/json

1.3.2.5. レスポンス

表1.7 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1DeleteAlertsResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.3.2.6. サンプル

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

1.3.2.7.1. GooglerpcStatus

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

1.3.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 {
  ...
}

1.3.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.3.2.7.3. V1DeleteAlertsResponse

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

1.3.3. ListAlerts

GET /v1/alerts

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

1.3.3.1. 説明

1.3.3.2. パラメーター

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

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

1.3.3.3. 戻り値のタイプ

V1ListAlertsResponse

1.3.3.4. コンテンツタイプ

application/json

1.3.3.5. レスポンス

表1.8 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListAlertsResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.3.3.6. サンプル

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

1.3.3.7.1. GooglerpcStatus

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

1.3.3.7.2. ListAlertCommonEntityInfo

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

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

1.3.3.7.3. ListAlertPolicyDevFields

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

1.3.3.7.4. ListAlertResourceEntity

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

1.3.3.7.5. 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.3.7.5.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.3.3.7.6. StorageEnforcementAction

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

列挙値
UNSET_ENFORCEMENT
SCALE_TO_ZERO_ENFORCEMENT
UNSATISFIABLE_NODE_CONSTRAINT_ENFORCEMENT
KILL_POD_ENFORCEMENT
FAIL_BUILD_ENFORCEMENT
FAIL_KUBE_REQUEST_ENFORCEMENT
FAIL_DEPLOYMENT_CREATE_ENFORCEMENT
FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT

1.3.3.7.7. StorageLifecycleStage

列挙値
DEPLOY
BUILD
RUNTIME

1.3.3.7.8. StorageListAlert

フィールド名	型	形式
id	String
lifecycleStage	StorageLifecycleStage	DEPLOY, BUILD, RUNTIME,
time	Date	date-time
policy	StorageListAlertPolicy
state	StorageViolationState	ACTIVE、RESOLVED、ATTEMPTED
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,
commonEntityInfo	ListAlertCommonEntityInfo
deployment	StorageListAlertDeployment
resource	ListAlertResourceEntity

1.3.3.7.9. StorageListAlertDeployment

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

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

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

列挙値
DEPLOYMENT
SECRETS
CONFIGMAPS
CLUSTER_ROLES
CLUSTER_ROLE_BINDINGS
NETWORK_POLICIES
SECURITY_CONTEXT_CONSTRAINTS
EGRESS_FIREWALLS

1.3.3.7.12. StorageSeverity

列挙値
UNSET_SEVERITY
LOW_SEVERITY
MEDIUM_SEVERITY
HIGH_SEVERITY
CRITICAL_SEVERITY

1.3.3.7.13. StorageViolationState

列挙値
ACTIVE
RESOLVED
ATTEMPTED

1.3.3.7.14. V1ListAlertsResponse

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

1.3.4. GetAlert

GET /v1/alerts/{id}

GetAlert は、id が指定されたアラートを返します。

1.3.4.1. 説明

1.3.4.2. パラメーター

1.3.4.2.1. パスパラメーター

名前	説明	必須	デフォルト	パターン
id		X	null

1.3.4.3. 戻り値のタイプ

StorageAlert

1.3.4.4. コンテンツタイプ

application/json

1.3.4.5. レスポンス

表1.9 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageAlert
0	予期しないエラーの応答。	GooglerpcStatus

1.3.4.6. サンプル

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

1.3.4.7.1. AlertDeploymentContainer

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

1.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,
message			String

1.3.4.7.3. AlertEntityType

列挙値
UNSET
DEPLOYMENT
CONTAINER_IMAGE
RESOURCE

1.3.4.7.4. AlertProcessViolation

フィールド名	必須	Null 許容型	型	説明	形式
message			String
processes			StorageProcessIndicator のリスト

1.3.4.7.5. AlertResourceResourceType

列挙値
UNKNOWN
SECRETS
CONFIGMAPS
CLUSTER_ROLES
CLUSTER_ROLE_BINDINGS
NETWORK_POLICIES
SECURITY_CONTEXT_CONSTRAINTS
EGRESS_FIREWALLS

1.3.4.7.6. AlertViolation

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

1.3.4.7.7. AlertViolationType

列挙値
GENERIC
K8S_EVENT
NETWORK_FLOW
NETWORK_POLICY

1.3.4.7.8. GooglerpcStatus

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

1.3.4.7.9. KeyValueAttrsKeyValueAttr

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

1.3.4.7.10. NetworkFlowInfoEntity

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

1.3.4.7.11. PolicyMitreAttackVectors

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

1.3.4.7.12. ProcessSignalLineageInfo

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

1.3.4.7.13. 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.4.7.13.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.3.4.7.14. StorageAlert

Next available tag: 24

フィールド名	型	説明	形式
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、RESOLVED、ATTEMPTED
platformComponent	Boolean
entityType	AlertEntityType		UNSET, DEPLOYMENT, CONTAINER_IMAGE, RESOURCE,

1.3.4.7.15. StorageAlertDeployment

フィールド名	型	説明
id	String
name	String
type	String
namespace	String	スコープ管理と検索ができるように、このフィールドをアラートで複製する必要があります。
namespaceId	String	スコープ管理と検索ができるように、このフィールドをアラートで複製する必要があります。
labels	`string` のマップ
clusterId	String	スコープ管理と検索ができるように、このフィールドをアラートで複製する必要があります。
clusterName	String	スコープ管理と検索ができるように、このフィールドをアラートで複製する必要があります。
containers	AlertDeploymentContainer のリスト
annotations	`string` のマップ
inactive	Boolean

1.3.4.7.16. StorageAlertResource

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

フィールド名	型	説明	形式
resourceType	AlertResourceResourceType		UNKNOWN, SECRETS, CONFIGMAPS, CLUSTER_ROLES, CLUSTER_ROLE_BINDINGS, NETWORK_POLICIES, SECURITY_CONTEXT_CONSTRAINTS, EGRESS_FIREWALLS,
name	String
clusterId	String	スコープ管理と検索ができるように、このフィールドをアラートで複製する必要があります。
clusterName	String	スコープ管理と検索ができるように、このフィールドをアラートで複製する必要があります。
namespace	String	スコープ管理と検索ができるように、このフィールドをアラートで複製する必要があります。
namespaceId	String	スコープ管理と検索ができるように、このフィールドをアラートで複製する必要があります。

1.3.4.7.17. StorageBooleanOperator

列挙値
OR
AND

1.3.4.7.18. StorageContainerImage

Next tag: 12

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

1.3.4.7.19. 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 が設定されている場合にのみ有効になります。

列挙値
UNSET_ENFORCEMENT
SCALE_TO_ZERO_ENFORCEMENT
UNSATISFIABLE_NODE_CONSTRAINT_ENFORCEMENT
KILL_POD_ENFORCEMENT
FAIL_BUILD_ENFORCEMENT
FAIL_KUBE_REQUEST_ENFORCEMENT
FAIL_DEPLOYMENT_CREATE_ENFORCEMENT
FAIL_DEPLOYMENT_UPDATE_ENFORCEMENT

1.3.4.7.20. StorageEventSource

列挙値
NOT_APPLICABLE
DEPLOYMENT_EVENT
AUDIT_LOG_EVENT

1.3.4.7.21. StorageExclusion

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

1.3.4.7.22. StorageExclusionDeployment

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

1.3.4.7.23. StorageExclusionImage

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

1.3.4.7.24. StorageImageName

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

1.3.4.7.25. StorageL4Protocol

列挙値
L4_PROTOCOL_UNKNOWN
L4_PROTOCOL_TCP
L4_PROTOCOL_UDP
L4_PROTOCOL_ICMP
L4_PROTOCOL_RAW
L4_PROTOCOL_SCTP
L4_PROTOCOL_ANY

1.3.4.7.26. StorageLifecycleStage

列挙値
DEPLOY
BUILD
RUNTIME

1.3.4.7.27. StorageNetworkEntityInfoType

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

列挙値
UNKNOWN_TYPE
DEPLOYMENT
INTERNET
LISTEN_ENDPOINT
EXTERNAL_SOURCE
INTERNAL_ENTITIES

1.3.4.7.28. StoragePolicy

Next tag: 28

フィールド名	型	説明	形式
id	String
name	String	ポリシーの名前。一意である必要があります。
description	String	このポリシーの Free-form のテキストでの説明。
理由	String
remediation	String	このポリシー違反を修正する方法を説明します。
disabled	Boolean	このポリシーが実行され、アラートの通知をすぐに行うように切り替えます。
categories	`string` のリスト	このポリシーが該当するカテゴリーのリスト。カテゴリー名は Central にすでに存在している必要があります。
lifecycleStages	StorageLifecycleStage のリスト	このポリシーが適用されるポリシーライフサイクルステージを説明します。選択肢は DEPLOY、BUILD、および RUNTIME です。
eventSource	StorageEventSource		NOT_APPLICABLE, DEPLOYMENT_EVENT, AUDIT_LOG_EVENT,
exclusions	StorageExclusion のリスト	このポリシーから除外するデプロイメントまたはイメージを定義します。
scope	StorageScope のリスト	このポリシーに含める必要があるクラスター、namespace、およびデプロイメントを定義します。スコープが定義されていない場合はすべてが含まれます。
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 がオブジェクトを強制的に更新するように設定されている場合にのみ有効です。このポリシー違反が特定された場合に実行する強制措置を表示します。使用可能な値は UNSET_ENFORCEMENT, SCALE_TO_ZERO_ENFORCEMENT, UNSATISFIABLE_NODE_CONSTRAINT_ENFORCEMENT, KILL_POD_ENFORCEMENT, FAIL_BUILD_ENFORCEMENT, FAIL_KUBE_REQUEST_ENFORCEMENT, FAIL_DEPLOYMENT_CREATE_ENFORCEMENT および FAILURE_DEPLOYMENT_UPDATE_ENFORCEMENT です。
notifiers	`string` のリスト	このポリシー違反が識別されたときにトリガーされる通知の ID リスト。ID は UUID の形式である必要があり、Central API 経由で検出されます。
lastUpdated	Date		date-time
SORTName	String	内部での使用のみ。
SORTLifecycleStage	String	内部での使用のみ。
SORTEnforcement	Boolean	内部での使用のみ。
policyVersion	String
policySections	StoragePolicySection のリスト	PolicySections は、このポリシーの違反基準を定義します。
mitreAttackVectors	PolicyMitreAttackVectors のリスト
criteriaLocked	Boolean	読み取り専用フィールド。true の場合、ポリシーの基準フィールドは読み取り専用になります。
mitreVectorsLocked	Boolean	読み取り専用フィールド。true の場合、ポリシーの MITRE ATT&CK フィールドは読み取り専用になります。
isDefault	Boolean	読み取り専用フィールド。true の場合はポリシーがデフォルトポリシーであり、false の場合はカスタムポリシーであることを示します。
source	StoragePolicySource		IMPERATIVE, DECLARATIVE,

1.3.4.7.29. StoragePolicyGroup

フィールド名	型	説明	形式
fieldName	String	この PolicyGroup が評価するデプロイメントまたはイメージのフィールドを定義します。使用できる値の完全なリストは、https://docs.openshift.com/acs/operating/manage-security-policies.html#policy-criteria_manage-security-policies を参照してください。
booleanOperator	StorageBooleanOperator		OR, AND,
negate	Boolean	この PolicyGroup の評価が否定されるかどうかを決定します。デフォルトは false です。
values	StoragePolicyValue のリスト

1.3.4.7.30. StoragePolicySection

フィールド名	必須	Null 許容型	型	説明	形式
sectionName			String
policyGroups			StoragePolicyGroup のリスト	このセクションを設定するポリシーグループのセット。各グループは個別の基準とみなすことができます。

1.3.4.7.31. StoragePolicySource

列挙値
IMPERATIVE
DECLARATIVE

1.3.4.7.32. StoragePolicyValue

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

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

1.3.4.7.34. 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	ProcessSignalLineageInfo のリスト

1.3.4.7.35. StorageScope

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

1.3.4.7.36. StorageScopeLabel

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

1.3.4.7.37. StorageSeverity

列挙値
UNSET_SEVERITY
LOW_SEVERITY
MEDIUM_SEVERITY
HIGH_SEVERITY
CRITICAL_SEVERITY

1.3.4.7.38. StorageViolationState

列挙値
ACTIVE
RESOLVED
ATTEMPTED

1.3.4.7.39. ViolationKeyValueAttrs

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

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

1.3.5. ResolveAlert

PATCH /v1/alerts/{id}/resolve

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

1.3.5.1. 説明

1.3.5.2. パラメーター

1.3.5.2.1. パスパラメーター

名前	説明	必須	デフォルト	パターン
id		X	null

1.3.5.2.2. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	AlertServiceResolveAlertBody	X

1.3.5.3. 戻り値のタイプ

Object

1.3.5.4. コンテンツタイプ

application/json

1.3.5.5. レスポンス

表1.10 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

1.3.5.6. サンプル

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

1.3.5.7.1. AlertServiceResolveAlertBody

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

1.3.5.7.2. GooglerpcStatus

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

1.3.5.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 {
  ...
}

1.3.5.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.3.6. ResolveAlerts

PATCH /v1/alerts/resolve

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

1.3.6.1. 説明

1.3.6.2. パラメーター

1.3.6.2.1. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	V1ResolveAlertsRequest	X

1.3.6.3. 戻り値のタイプ

Object

1.3.6.4. コンテンツタイプ

application/json

1.3.6.5. レスポンス

表1.11 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

1.3.6.6. サンプル

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

1.3.6.7.1. GooglerpcStatus

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

1.3.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 {
  ...
}

1.3.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.3.6.7.3. V1ResolveAlertsRequest

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

1.3.7. GetAlertsCounts

GET /v1/alerts/summary/counts

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

1.3.7.1. 説明

1.3.7.2. パラメーター

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

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

1.3.7.3. 戻り値のタイプ

V1GetAlertsCountsResponse

1.3.7.4. コンテンツタイプ

application/json

1.3.7.5. レスポンス

表1.12 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetAlertsCountsResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.3.7.6. サンプル

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

1.3.7.7.1. AlertGroupAlertCounts

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

1.3.7.7.2. GetAlertsCountsResponseAlertGroup

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

1.3.7.7.3. GooglerpcStatus

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

1.3.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 {
  ...
}

1.3.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.3.7.7.5. StorageSeverity

列挙値
UNSET_SEVERITY
LOW_SEVERITY
MEDIUM_SEVERITY
HIGH_SEVERITY
CRITICAL_SEVERITY

1.3.7.7.6. V1GetAlertsCountsResponse

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

1.3.8. GetAlertsGroup

GET /v1/alerts/summary/groups

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

1.3.8.1. 説明

1.3.8.2. パラメーター

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

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

1.3.8.3. 戻り値のタイプ

V1GetAlertsGroupResponse

1.3.8.4. コンテンツタイプ

application/json

1.3.8.5. レスポンス

表1.13 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetAlertsGroupResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.3.8.6. サンプル

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

1.3.8.7.1. GooglerpcStatus

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

1.3.8.7.2. ListAlertPolicyDevFields

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

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

1.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.3.8.7.4. StorageListAlertPolicy

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

1.3.8.7.5. StorageSeverity

列挙値
UNSET_SEVERITY
LOW_SEVERITY
MEDIUM_SEVERITY
HIGH_SEVERITY
CRITICAL_SEVERITY

1.3.8.7.6. V1GetAlertsGroupResponse

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

1.3.8.7.7. V1GetAlertsGroupResponsePolicyGroup

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

1.3.9. GetAlertTimeseries

GET /v1/alerts/summary/timeseries

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

1.3.9.1. 説明

1.3.9.2. パラメーター

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

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

1.3.9.3. 戻り値のタイプ

V1GetAlertTimeseriesResponse

1.3.9.4. コンテンツタイプ

application/json

1.3.9.5. レスポンス

表1.14 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetAlertTimeseriesResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.3.9.6. サンプル

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

1.3.9.7.1. ClusterAlertsAlertEvents

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

1.3.9.7.2. GetAlertTimeseriesResponseClusterAlerts

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

1.3.9.7.3. GooglerpcStatus

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

1.3.9.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 {
  ...
}

1.3.9.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.3.9.7.5. StorageSeverity

列挙値
UNSET_SEVERITY
LOW_SEVERITY
MEDIUM_SEVERITY
HIGH_SEVERITY
CRITICAL_SEVERITY

1.3.9.7.6. V1AlertEvent

フィールド名	型	形式
time	String	int64
type	V1Type	CREATED, REMOVED,
id	String

1.3.9.7.7. V1GetAlertTimeseriesResponse

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

1.3.9.7.8. V1Type

列挙値
CREATED
REMOVED

1.4. APITokenService

1.4.1. ListAllowedTokenRoles

GET /v1/apitokens/generate/allowed-roles

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

1.4.1.1. 説明

1.4.1.2. パラメーター

1.4.1.3. 戻り値のタイプ

V1ListAllowedTokenRolesResponse

1.4.1.4. コンテンツタイプ

application/json

1.4.1.5. レスポンス

表1.15 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListAllowedTokenRolesResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.4.1.6. サンプル

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

1.4.1.7.1. GooglerpcStatus

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

1.4.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 {
  ...
}

1.4.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.4.1.7.3. V1ListAllowedTokenRolesResponse

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

1.4.2. GenerateToken

POST /v1/apitokens/generate

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

1.4.2.1. 説明

1.4.2.2. パラメーター

1.4.2.2.1. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	V1GenerateTokenRequest	X

1.4.2.3. 戻り値のタイプ

V1GenerateTokenResponse

1.4.2.4. コンテンツタイプ

application/json

1.4.2.5. レスポンス

表1.16 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GenerateTokenResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.4.2.6. サンプル

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

1.4.2.7.1. GooglerpcStatus

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

1.4.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 {
  ...
}

1.4.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.4.2.7.3. StorageTokenMetadata

Next available tag: 8

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

1.4.2.7.4. V1GenerateTokenRequest

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

1.4.2.7.5. V1GenerateTokenResponse

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

1.4.3. GetAPITokens

GET /v1/apitokens

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

1.4.3.1. 説明

1.4.3.2. パラメーター

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

名前	説明	必須	デフォルト	パターン
revoked		-	null

1.4.3.3. 戻り値のタイプ

V1GetAPITokensResponse

1.4.3.4. コンテンツタイプ

application/json

1.4.3.5. レスポンス

表1.17 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetAPITokensResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.4.3.6. サンプル

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

1.4.3.7.1. GooglerpcStatus

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

1.4.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 {
  ...
}

1.4.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.4.3.7.3. StorageTokenMetadata

Next available tag: 8

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

1.4.3.7.4. V1GetAPITokensResponse

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

1.4.4. GetAPIToken

GET /v1/apitokens/{id}

GetAPIToken は、指定された id の API トークンメタデータを返します。

1.4.4.1. 説明

1.4.4.2. パラメーター

1.4.4.2.1. パスパラメーター

名前	説明	必須	デフォルト	パターン
id		X	null

1.4.4.3. 戻り値のタイプ

StorageTokenMetadata

1.4.4.4. コンテンツタイプ

application/json

1.4.4.5. レスポンス

表1.18 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageTokenMetadata
0	予期しないエラーの応答。	GooglerpcStatus

1.4.4.6. サンプル

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

1.4.4.7.1. GooglerpcStatus

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

1.4.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 {
  ...
}

1.4.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.4.4.7.3. StorageTokenMetadata

Next available tag: 8

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

1.4.5. RevokeToken

PATCH /v1/apitokens/revoke/{id}

RevokeToken は、指定された id の API トークンを削除します。

1.4.5.1. 説明

1.4.5.2. パラメーター

1.4.5.2.1. パスパラメーター

名前	説明	必須	デフォルト	パターン
id		X	null

1.4.5.3. 戻り値のタイプ

Object

1.4.5.4. コンテンツタイプ

application/json

1.4.5.5. レスポンス

表1.19 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

1.4.5.6. サンプル

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

1.4.5.7.1. GooglerpcStatus

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

1.4.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 {
  ...
}

1.4.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.5. AuthProviderService

1.5.1. ExchangeToken

POST /v1/authProviders/exchangeToken

1.5.1.1. 説明

1.5.1.2. パラメーター

1.5.1.2.1. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	V1ExchangeTokenRequest	X

1.5.1.3. 戻り値のタイプ

V1ExchangeTokenResponse

1.5.1.4. コンテンツタイプ

application/json

1.5.1.5. レスポンス

表1.20 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ExchangeTokenResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.5.1.6. サンプル

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

1.5.1.7.1. AuthProviderRequiredAttribute

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

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

1.5.1.7.2. GooglerpcStatus

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

1.5.1.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 {
  ...
}

1.5.1.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.5.1.7.4. StorageAccess

列挙値
NO_ACCESS
READ_ACCESS
READ_WRITE_ACCESS

1.5.1.7.5. StorageAuthProvider

次のタグ: 15。

フィールド名	型	説明	形式
id	String
name	String
type	String
uiEndpoint	String
enabled	Boolean
config	`string` のマップ	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 コールバックモード。\"fragment\"、\"post\"、または \"query\" から選択します。- \"disable_offline_access_scope\": オフライントークンを発行しない場合は \"true\" に設定します。- \"extra_scopes\": https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 に従って、\"openid profile email\" に加えて要求する追加のスコープのスペース区切り文字列。OpenShift Auth: 追加の設定オプションはサポートされません。User 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 エンドポイント。つまり、ログイン要求がこれらのいずれかから送信される場合、認証要求は ui_endpoint ではなくこれらをコールバック URL に使用します。
active	Boolean
requiredAttributes	AuthProviderRequiredAttribute のリスト
traits	StorageTraits
claimMappings	`string` のマップ	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.\") We do NOT support the following types of claims: * complex claims(path \"a\") * float/integer claims(path \"a.g\") * float/integer array claims(path \"a.h\") の型の要求がサポートされています。このマップの各値には、要求を追加する Rox トークン属性名が含まれています。たとえば、値が \"groups\" の場合、要求はトークンの \"external_user.Attributes.groups\" にあります。注記: この機能は OIDC 認証プロバイダーに対してのみサポートされます。
lastUpdated	Date	最終更新日は、認証プロバイダーが最後に更新された日時を示します。このタイムスタンプより前に、認証プロバイダーによって発行されたトークンがある場合、無効とみなされます。その後、すべてのクライアントは、(更新するか、追加のログイン試行によって) トークンを再発行する必要があります。	date-time

1.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, BENCHMARK_SERVICE, SCANNER_SERVICE, SCANNER_DB_SERVICE, ADMISSION_CONTROL_SERVICE, SCANNER_V4_INDEXER_SERVICE, SCANNER_V4_MATCHER_SERVICE, SCANNER_V4_DB_SERVICE, SCANNER_V4_SERVICE, REGISTRANT_SERVICE
initBundleId	String

1.5.1.7.7. StorageServiceType

Next available tag: 18

SCANNER_V4_SERVICE: これは、Scanner V4 がコンボモードで実行されるときに使用されます。

列挙値
UNKNOWN_SERVICE
SENSOR_SERVICE
CENTRAL_SERVICE
CENTRAL_DB_SERVICE
REMOTE_SERVICE
COLLECTOR_SERVICE
MONITORING_UI_SERVICE
MONITORING_DB_SERVICE
MONITORING_CLIENT_SERVICE
BENCHMARK_SERVICE
SCANNER_SERVICE
SCANNER_DB_SERVICE
ADMISSION_CONTROL_SERVICE
SCANNER_V4_INDEXER_SERVICE
SCANNER_V4_MATCHER_SERVICE
SCANNER_V4_DB_SERVICE
SCANNER_V4_SERVICE
REGISTRANT_SERVICE

1.5.1.7.8. StorageTraits

フィールド名	型	形式
mutabilityMode	TraitsMutabilityMode	ALLOW_MUTATE, ALLOW_MUTATE_FORCED,
visibility	TraitsVisibility	VISIBLE, HIDDEN,
origin	TraitsOrigin	IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED,

1.5.1.7.9. StorageUserInfo

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

1.5.1.7.10. StorageUserInfoRole

ロールは、storage.Role の古い形式と互換性があるため、ロール名と関連する権限のみが含まれます。

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

1.5.1.7.11. TraitsMutabilityMode

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

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

列挙値
ALLOW_MUTATE
ALLOW_MUTATE_FORCED

1.5.1.7.12. TraitsOrigin

Origin はオブジェクトの原点を指定します。オブジェクトには、異なるオリジンが 4 つあります: - IMPERATIVE: オブジェクトは API 経由で作成されました。これはデフォルトで想定されている動作です。- DEFAULT: オブジェクトは、デフォルトのロール、アクセススコープなどのデフォルトのオブジェクトです。- DECLARATIVE: オブジェクトは宣言型設定によって作成されます。- DECLARATIVE_ORPHANED: オブジェクトは宣言型設定によって作成され、その後、正常に削除されませんでした (例: 別のオブジェクトによって参照されているため)。発生元に基づいて、オブジェクトには異なるルールが適用されます。DECLARATIVE オリジンを持つオブジェクトは、宣言的設定を介してのみ API 経由で変更できません。さらに、IMPERATIVE オリジンを持つオブジェクトを参照できません。DEFAULT オリジンを持つオブジェクトは、API または宣言的設定を介して変更できません。これらは他のすべてのオブジェクトから参照される可能性があります。IMPERATIVE オリジンを持つオブジェクトは、宣言的な設定ではなく、API 経由で変更できます。他のすべてのオブジェクトを参照する場合があります。DECLARATIVE_ORPHANED オリジンを持つオブジェクトは、API または宣言的設定を介して変更できません。DECLARATIVE_ORPHANED リソースは、宣言型設定で再定義されると、再び DECLARATIVE になることがあります。このオリジンを持つオブジェクトは、他のリソースによって参照されなくなるとすぐにシステムからクリーンアップされます。これらは他のすべてのオブジェクトから参照される可能性があります。

列挙値
IMPERATIVE
DEFAULT
DECLARATIVE
DECLARATIVE_ORPHANED

1.5.1.7.13. TraitsVisibility

EXPERIMENTAL。visibility を使用すると、特定の API に対してオブジェクトを表示するかどうかを指定できます。

列挙値
VISIBLE
HIDDEN

1.5.1.7.14. UserInfoResourceToAccess

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

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

1.5.1.7.15. V1AuthStatus

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

1.5.1.7.16. V1ExchangeTokenRequest

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

1.5.1.7.17. V1ExchangeTokenResponse

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

1.5.1.7.18. V1UserAttribute

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

1.5.2. GetAuthProviders

GET /v1/authProviders

1.5.2.1. 説明

1.5.2.2. パラメーター

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

名前	説明	必須	デフォルト	パターン
name		-	null
type		-	null

1.5.2.3. 戻り値のタイプ

V1GetAuthProvidersResponse

1.5.2.4. コンテンツタイプ

application/json

1.5.2.5. レスポンス

表1.21 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetAuthProvidersResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.5.2.6. サンプル

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

1.5.2.7.1. AuthProviderRequiredAttribute

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

1.5.2.7.2. GooglerpcStatus

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

1.5.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 {
  ...
}

1.5.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.5.2.7.4. StorageAuthProvider

次のタグ: 15。

フィールド名	型	説明	形式
id	String
name	String
type	String
uiEndpoint	String
enabled	Boolean
config	`string` のマップ	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 コールバックモード。\"fragment\"、\"post\"、または \"query\" から選択します。- \"disable_offline_access_scope\": オフライントークンを発行しない場合は \"true\" に設定します。- \"extra_scopes\": https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 に従って、\"openid profile email\" に加えて要求する追加のスコープのスペース区切り文字列。OpenShift Auth: 追加の設定オプションはサポートされません。User 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 エンドポイント。つまり、ログイン要求がこれらのいずれかから送信される場合、認証要求は ui_endpoint ではなくこれらをコールバック URL に使用します。
active	Boolean
requiredAttributes	AuthProviderRequiredAttribute のリスト
traits	StorageTraits
claimMappings	`string` のマップ	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.\") We do NOT support the following types of claims: * complex claims(path \"a\") * float/integer claims(path \"a.g\") * float/integer array claims(path \"a.h\") の型の要求がサポートされています。このマップの各値には、要求を追加する Rox トークン属性名が含まれています。たとえば、値が \"groups\" の場合、要求はトークンの \"external_user.Attributes.groups\" にあります。注記: この機能は OIDC 認証プロバイダーに対してのみサポートされます。
lastUpdated	Date	最終更新日は、認証プロバイダーが最後に更新された日時を示します。このタイムスタンプより前に、認証プロバイダーによって発行されたトークンがある場合、無効とみなされます。その後、すべてのクライアントは、(更新するか、追加のログイン試行によって) トークンを再発行する必要があります。	date-time

1.5.2.7.5. StorageTraits

フィールド名	型	形式
mutabilityMode	TraitsMutabilityMode	ALLOW_MUTATE, ALLOW_MUTATE_FORCED,
visibility	TraitsVisibility	VISIBLE, HIDDEN,
origin	TraitsOrigin	IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED,

1.5.2.7.6. TraitsMutabilityMode

列挙値
ALLOW_MUTATE
ALLOW_MUTATE_FORCED

1.5.2.7.7. TraitsOrigin

列挙値
IMPERATIVE
DEFAULT
DECLARATIVE
DECLARATIVE_ORPHANED

1.5.2.7.8. TraitsVisibility

EXPERIMENTAL。visibility を使用すると、特定の API に対してオブジェクトを表示するかどうかを指定できます。

列挙値
VISIBLE
HIDDEN

1.5.2.7.9. V1GetAuthProvidersResponse

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

1.5.3. DeleteAuthProvider

DELETE /v1/authProviders/{id}

1.5.3.1. 説明

1.5.3.2. パラメーター

1.5.3.2.1. パスパラメーター

名前	説明	必須	デフォルト	パターン
id		X	null

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

名前	説明	必須	デフォルト	パターン
force		-	null

1.5.3.3. 戻り値のタイプ

Object

1.5.3.4. コンテンツタイプ

application/json

1.5.3.5. レスポンス

表1.22 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

1.5.3.6. サンプル

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

1.5.3.7.1. GooglerpcStatus

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

1.5.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 {
  ...
}

1.5.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.5.4. GetAuthProvider

GET /v1/authProviders/{id}

1.5.4.1. 説明

1.5.4.2. パラメーター

1.5.4.2.1. パスパラメーター

名前	説明	必須	デフォルト	パターン
id		X	null

1.5.4.3. 戻り値のタイプ

StorageAuthProvider

1.5.4.4. コンテンツタイプ

application/json

1.5.4.5. レスポンス

表1.23 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageAuthProvider
0	予期しないエラーの応答。	GooglerpcStatus

1.5.4.6. サンプル

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

1.5.4.7.1. AuthProviderRequiredAttribute

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

1.5.4.7.2. GooglerpcStatus

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

1.5.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 {
  ...
}

1.5.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.5.4.7.4. StorageAuthProvider

次のタグ: 15。

フィールド名	型	説明	形式
id	String
name	String
type	String
uiEndpoint	String
enabled	Boolean
config	`string` のマップ	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 コールバックモード。\"fragment\"、\"post\"、または \"query\" から選択します。- \"disable_offline_access_scope\": オフライントークンを発行しない場合は \"true\" に設定します。- \"extra_scopes\": https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 に従って、\"openid profile email\" に加えて要求する追加のスコープのスペース区切り文字列。OpenShift Auth: 追加の設定オプションはサポートされません。User 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 エンドポイント。つまり、ログイン要求がこれらのいずれかから送信される場合、認証要求は ui_endpoint ではなくこれらをコールバック URL に使用します。
active	Boolean
requiredAttributes	AuthProviderRequiredAttribute のリスト
traits	StorageTraits
claimMappings	`string` のマップ	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.\") We do NOT support the following types of claims: * complex claims(path \"a\") * float/integer claims(path \"a.g\") * float/integer array claims(path \"a.h\") の型の要求がサポートされています。このマップの各値には、要求を追加する Rox トークン属性名が含まれています。たとえば、値が \"groups\" の場合、要求はトークンの \"external_user.Attributes.groups\" にあります。注記: この機能は OIDC 認証プロバイダーに対してのみサポートされます。
lastUpdated	Date	最終更新日は、認証プロバイダーが最後に更新された日時を示します。このタイムスタンプより前に、認証プロバイダーによって発行されたトークンがある場合、無効とみなされます。その後、すべてのクライアントは、(更新するか、追加のログイン試行によって) トークンを再発行する必要があります。	date-time

1.5.4.7.5. StorageTraits

フィールド名	型	形式
mutabilityMode	TraitsMutabilityMode	ALLOW_MUTATE, ALLOW_MUTATE_FORCED,
visibility	TraitsVisibility	VISIBLE, HIDDEN,
origin	TraitsOrigin	IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED,

1.5.4.7.6. TraitsMutabilityMode

列挙値
ALLOW_MUTATE
ALLOW_MUTATE_FORCED

1.5.4.7.7. TraitsOrigin

列挙値
IMPERATIVE
DEFAULT
DECLARATIVE
DECLARATIVE_ORPHANED

1.5.4.7.8. TraitsVisibility

EXPERIMENTAL。visibility を使用すると、特定の API に対してオブジェクトを表示するかどうかを指定できます。

列挙値
VISIBLE
HIDDEN

1.5.5. UpdateAuthProvider

PATCH /v1/authProviders/{id}

1.5.5.1. 説明

1.5.5.2. パラメーター

1.5.5.2.1. パスパラメーター

名前	説明	必須	デフォルト	パターン
id		X	null

1.5.5.2.2. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	AuthProviderServiceUpdateAuthProviderBody	X

1.5.5.3. 戻り値のタイプ

StorageAuthProvider

1.5.5.4. コンテンツタイプ

application/json

1.5.5.5. レスポンス

表1.24 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageAuthProvider
0	予期しないエラーの応答。	GooglerpcStatus

1.5.5.6. サンプル

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

1.5.5.7.1. AuthProviderRequiredAttribute

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

1.5.5.7.2. AuthProviderServiceUpdateAuthProviderBody

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

1.5.5.7.3. GooglerpcStatus

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

1.5.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 {
  ...
}

1.5.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.5.5.7.5. StorageAuthProvider

次のタグ: 15。

フィールド名	型	説明	形式
id	String
name	String
type	String
uiEndpoint	String
enabled	Boolean
config	`string` のマップ	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 コールバックモード。\"fragment\"、\"post\"、または \"query\" から選択します。- \"disable_offline_access_scope\": オフライントークンを発行しない場合は \"true\" に設定します。- \"extra_scopes\": https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 に従って、\"openid profile email\" に加えて要求する追加のスコープのスペース区切り文字列。OpenShift Auth: 追加の設定オプションはサポートされません。User 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 エンドポイント。つまり、ログイン要求がこれらのいずれかから送信される場合、認証要求は ui_endpoint ではなくこれらをコールバック URL に使用します。
active	Boolean
requiredAttributes	AuthProviderRequiredAttribute のリスト
traits	StorageTraits
claimMappings	`string` のマップ	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.\") We do NOT support the following types of claims: * complex claims(path \"a\") * float/integer claims(path \"a.g\") * float/integer array claims(path \"a.h\") の型の要求がサポートされています。このマップの各値には、要求を追加する Rox トークン属性名が含まれています。たとえば、値が \"groups\" の場合、要求はトークンの \"external_user.Attributes.groups\" にあります。注記: この機能は OIDC 認証プロバイダーに対してのみサポートされます。
lastUpdated	Date	最終更新日は、認証プロバイダーが最後に更新された日時を示します。このタイムスタンプより前に、認証プロバイダーによって発行されたトークンがある場合、無効とみなされます。その後、すべてのクライアントは、(更新するか、追加のログイン試行によって) トークンを再発行する必要があります。	date-time

1.5.5.7.6. StorageTraits

フィールド名	型	形式
mutabilityMode	TraitsMutabilityMode	ALLOW_MUTATE, ALLOW_MUTATE_FORCED,
visibility	TraitsVisibility	VISIBLE, HIDDEN,
origin	TraitsOrigin	IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED,

1.5.5.7.7. TraitsMutabilityMode

列挙値
ALLOW_MUTATE
ALLOW_MUTATE_FORCED

1.5.5.7.8. TraitsOrigin

列挙値
IMPERATIVE
DEFAULT
DECLARATIVE
DECLARATIVE_ORPHANED

1.5.5.7.9. TraitsVisibility

EXPERIMENTAL。visibility を使用すると、特定の API に対してオブジェクトを表示するかどうかを指定できます。

列挙値
VISIBLE
HIDDEN

1.5.6. PutAuthProvider

PUT /v1/authProviders/{id}

1.5.6.1. 説明

1.5.6.2. パラメーター

1.5.6.2.1. パスパラメーター

名前	説明	必須	デフォルト	パターン
id		X	null

1.5.6.2.2. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	AuthProviderServicePutAuthProviderBody	X

1.5.6.3. 戻り値のタイプ

StorageAuthProvider

1.5.6.4. コンテンツタイプ

application/json

1.5.6.5. レスポンス

表1.25 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageAuthProvider
0	予期しないエラーの応答。	GooglerpcStatus

1.5.6.6. サンプル

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

1.5.6.7.1. AuthProviderRequiredAttribute

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

1.5.6.7.2. AuthProviderServicePutAuthProviderBody

次のタグ: 15。

フィールド名	型	説明	形式
name	String
type	String
uiEndpoint	String
enabled	Boolean
config	`string` のマップ	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 コールバックモード。\"fragment\"、\"post\"、または \"query\" から選択します。- \"disable_offline_access_scope\": オフライントークンを発行しない場合は \"true\" に設定します。- \"extra_scopes\": https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 に従って、\"openid profile email\" に加えて要求する追加のスコープのスペース区切り文字列。OpenShift Auth: 追加の設定オプションはサポートされません。User 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 エンドポイント。つまり、ログイン要求がこれらのいずれかから送信される場合、認証要求は ui_endpoint ではなくこれらをコールバック URL に使用します。
active	Boolean
requiredAttributes	AuthProviderRequiredAttribute のリスト
traits	StorageTraits
claimMappings	`string` のマップ	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.\") We do NOT support the following types of claims: * complex claims(path \"a\") * float/integer claims(path \"a.g\") * float/integer array claims(path \"a.h\") の型の要求がサポートされています。このマップの各値には、要求を追加する Rox トークン属性名が含まれています。たとえば、値が \"groups\" の場合、要求はトークンの \"external_user.Attributes.groups\" にあります。注記: この機能は OIDC 認証プロバイダーに対してのみサポートされます。
lastUpdated	Date	最終更新日は、認証プロバイダーが最後に更新された日時を示します。このタイムスタンプより前に、認証プロバイダーによって発行されたトークンがある場合、無効とみなされます。その後、すべてのクライアントは、(更新するか、追加のログイン試行によって) トークンを再発行する必要があります。	date-time

1.5.6.7.3. GooglerpcStatus

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

1.5.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 {
  ...
}

1.5.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.5.6.7.5. StorageAuthProvider

次のタグ: 15。

フィールド名	型	説明	形式
id	String
name	String
type	String
uiEndpoint	String
enabled	Boolean
config	`string` のマップ	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 コールバックモード。\"fragment\"、\"post\"、または \"query\" から選択します。- \"disable_offline_access_scope\": オフライントークンを発行しない場合は \"true\" に設定します。- \"extra_scopes\": https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 に従って、\"openid profile email\" に加えて要求する追加のスコープのスペース区切り文字列。OpenShift Auth: 追加の設定オプションはサポートされません。User 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 エンドポイント。つまり、ログイン要求がこれらのいずれかから送信される場合、認証要求は ui_endpoint ではなくこれらをコールバック URL に使用します。
active	Boolean
requiredAttributes	AuthProviderRequiredAttribute のリスト
traits	StorageTraits
claimMappings	`string` のマップ	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.\") We do NOT support the following types of claims: * complex claims(path \"a\") * float/integer claims(path \"a.g\") * float/integer array claims(path \"a.h\") の型の要求がサポートされています。このマップの各値には、要求を追加する Rox トークン属性名が含まれています。たとえば、値が \"groups\" の場合、要求はトークンの \"external_user.Attributes.groups\" にあります。注記: この機能は OIDC 認証プロバイダーに対してのみサポートされます。
lastUpdated	Date	最終更新日は、認証プロバイダーが最後に更新された日時を示します。このタイムスタンプより前に、認証プロバイダーによって発行されたトークンがある場合、無効とみなされます。その後、すべてのクライアントは、(更新するか、追加のログイン試行によって) トークンを再発行する必要があります。	date-time

1.5.6.7.6. StorageTraits

フィールド名	型	形式
mutabilityMode	TraitsMutabilityMode	ALLOW_MUTATE, ALLOW_MUTATE_FORCED,
visibility	TraitsVisibility	VISIBLE, HIDDEN,
origin	TraitsOrigin	IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED,

1.5.6.7.7. TraitsMutabilityMode

列挙値
ALLOW_MUTATE
ALLOW_MUTATE_FORCED

1.5.6.7.8. TraitsOrigin

列挙値
IMPERATIVE
DEFAULT
DECLARATIVE
DECLARATIVE_ORPHANED

1.5.6.7.9. TraitsVisibility

EXPERIMENTAL。visibility を使用すると、特定の API に対してオブジェクトを表示するかどうかを指定できます。

列挙値
VISIBLE
HIDDEN

1.5.7. PostAuthProvider

POST /v1/authProviders

1.5.7.1. 説明

1.5.7.2. パラメーター

1.5.7.2.1. 本文パラメーター

名前	説明	必須	デフォルト	パターン
provider	StorageAuthProvider	X

1.5.7.3. 戻り値のタイプ

StorageAuthProvider

1.5.7.4. コンテンツタイプ

application/json

1.5.7.5. レスポンス

表1.26 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageAuthProvider
0	予期しないエラーの応答。	GooglerpcStatus

1.5.7.6. サンプル

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

1.5.7.7.1. AuthProviderRequiredAttribute

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

1.5.7.7.2. GooglerpcStatus

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

1.5.7.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 {
  ...
}

1.5.7.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.5.7.7.4. StorageAuthProvider

次のタグ: 15。

フィールド名	型	説明	形式
id	String
name	String
type	String
uiEndpoint	String
enabled	Boolean
config	`string` のマップ	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 コールバックモード。\"fragment\"、\"post\"、または \"query\" から選択します。- \"disable_offline_access_scope\": オフライントークンを発行しない場合は \"true\" に設定します。- \"extra_scopes\": https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 に従って、\"openid profile email\" に加えて要求する追加のスコープのスペース区切り文字列。OpenShift Auth: 追加の設定オプションはサポートされません。User 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 エンドポイント。つまり、ログイン要求がこれらのいずれかから送信される場合、認証要求は ui_endpoint ではなくこれらをコールバック URL に使用します。
active	Boolean
requiredAttributes	AuthProviderRequiredAttribute のリスト
traits	StorageTraits
claimMappings	`string` のマップ	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.\") We do NOT support the following types of claims: * complex claims(path \"a\") * float/integer claims(path \"a.g\") * float/integer array claims(path \"a.h\") の型の要求がサポートされています。このマップの各値には、要求を追加する Rox トークン属性名が含まれています。たとえば、値が \"groups\" の場合、要求はトークンの \"external_user.Attributes.groups\" にあります。注記: この機能は OIDC 認証プロバイダーに対してのみサポートされます。
lastUpdated	Date	最終更新日は、認証プロバイダーが最後に更新された日時を示します。このタイムスタンプより前に、認証プロバイダーによって発行されたトークンがある場合、無効とみなされます。その後、すべてのクライアントは、(更新するか、追加のログイン試行によって) トークンを再発行する必要があります。	date-time

1.5.7.7.5. StorageTraits

フィールド名	型	形式
mutabilityMode	TraitsMutabilityMode	ALLOW_MUTATE, ALLOW_MUTATE_FORCED,
visibility	TraitsVisibility	VISIBLE, HIDDEN,
origin	TraitsOrigin	IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED,

1.5.7.7.6. TraitsMutabilityMode

列挙値
ALLOW_MUTATE
ALLOW_MUTATE_FORCED

1.5.7.7.7. TraitsOrigin

列挙値
IMPERATIVE
DEFAULT
DECLARATIVE
DECLARATIVE_ORPHANED

1.5.7.7.8. TraitsVisibility

EXPERIMENTAL。visibility を使用すると、特定の API に対してオブジェクトを表示するかどうかを指定できます。

列挙値
VISIBLE
HIDDEN

1.5.8. ListAvailableProviderTypes

GET /v1/availableAuthProviders

1.5.8.1. 説明

1.5.8.2. パラメーター

1.5.8.3. 戻り値のタイプ

V1AvailableProviderTypesResponse

1.5.8.4. コンテンツタイプ

application/json

1.5.8.5. レスポンス

表1.27 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1AvailableProviderTypesResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.5.8.6. サンプル

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

1.5.8.7.1. AvailableProviderTypesResponseAuthProviderType

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

1.5.8.7.2. GooglerpcStatus

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

1.5.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 {
  ...
}

1.5.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.5.8.7.4. V1AvailableProviderTypesResponse

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

1.5.9. GetLoginAuthProviders

GET /v1/login/authproviders

1.5.9.1. 説明

1.5.9.2. パラメーター

1.5.9.3. 戻り値のタイプ

V1GetLoginAuthProvidersResponse

1.5.9.4. コンテンツタイプ

application/json

1.5.9.5. レスポンス

表1.28 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetLoginAuthProvidersResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.5.9.6. サンプル

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

1.5.9.7.1. GetLoginAuthProvidersResponseLoginAuthProvider

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

1.5.9.7.2. GooglerpcStatus

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

1.5.9.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 {
  ...
}

1.5.9.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.5.9.7.4. V1GetLoginAuthProvidersResponse

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

1.6. AuthService

1.6.1. UpdateAuthMachineToMachineConfig

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

UpdateAuthMachineToMachineConfig は、既存の machine-to-machine (M2M) 認証設定を更新します。machine-to-machine (M2M) 認証設定が存在しない場合は、新しい設定が作成されます。

1.6.1.1. 説明

1.6.1.2. パラメーター

1.6.1.2.1. パスパラメーター

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

1.6.1.2.2. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	AuthServiceUpdateAuthMachineToMachineConfigBody	X

1.6.1.3. 戻り値のタイプ

Object

1.6.1.4. コンテンツタイプ

application/json

1.6.1.5. レスポンス

表1.29 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

1.6.1.6. サンプル

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

1.6.1.7.1. AuthMachineToMachineConfigMapping

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

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

1.6.1.7.2. AuthServiceUpdateAuthMachineToMachineConfigBody

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

1.6.1.7.3. AuthServiceUpdateAuthMachineToMachineConfigBodyConfig

AuthMachineToMachineConfig は、サードパーティーからのアイデンティティートークンを Central アクセストークンと交換するためのルールを決定します。M2M はマシンツーマシンの略で、これがこの設定の意図された使用例です。

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

1.6.1.7.4. GooglerpcStatus

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

1.6.1.7.5. 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.6.1.7.5.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.6.1.7.6. V1AuthMachineToMachineConfigType

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

列挙値
GENERIC
GITHUB_ACTIONS
KUBE_SERVICE_ACCOUNT

1.6.2. ExchangeAuthMachineToMachineToken

POST /v1/auth/m2m/exchange

ExchangeAuthMachineToMachineToken は、machine to machine 認証設定に基づいて、指定されたアイデンティティートークンを Central のアクセストークンと交換します。

1.6.2.1. 説明

1.6.2.2. パラメーター

1.6.2.2.1. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	V1ExchangeAuthMachineToMachineTokenRequest	X

1.6.2.3. 戻り値のタイプ

V1ExchangeAuthMachineToMachineTokenResponse

1.6.2.4. コンテンツタイプ

application/json

1.6.2.5. レスポンス

表1.30 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ExchangeAuthMachineToMachineTokenResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.6.2.6. サンプル

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

1.6.2.7.1. GooglerpcStatus

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

1.6.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 {
  ...
}

1.6.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.6.2.7.3. V1ExchangeAuthMachineToMachineTokenRequest

フィールド名	必須	Null 許容型	型	説明	形式
idToken			String	交換されることになっているアイデンティティートークン。

1.6.2.7.4. V1ExchangeAuthMachineToMachineTokenResponse

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

1.6.3. ListAuthMachineToMachineConfigs

GET /v1/auth/m2m

ListAuthMachineToMachineConfigs は、使用可能な machine to machine の認証設定を表示します。

1.6.3.1. 説明

1.6.3.2. パラメーター

1.6.3.3. 戻り値のタイプ

V1ListAuthMachineToMachineConfigResponse

1.6.3.4. コンテンツタイプ

application/json

1.6.3.5. レスポンス

表1.31 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListAuthMachineToMachineConfigResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.6.3.6. サンプル

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

1.6.3.7.1. AuthMachineToMachineConfigMapping

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

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

1.6.3.7.2. GooglerpcStatus

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

1.6.3.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 {
  ...
}

1.6.3.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.6.3.7.4. V1AuthMachineToMachineConfig

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

1.6.3.7.5. V1AuthMachineToMachineConfigType

列挙値
GENERIC
GITHUB_ACTIONS
KUBE_SERVICE_ACCOUNT

1.6.3.7.6. V1ListAuthMachineToMachineConfigResponse

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

1.6.4. DeleteAuthMachineToMachineConfig

DELETE /v1/auth/m2m/{id}

DeleteAuthMachineToMachineConfig は、特定の machine to machine 認証設定を削除します。指定された machine to machine 認証設定が存在しない場合に削除すると、エラーは返されません。

1.6.4.1. 説明

1.6.4.2. パラメーター

1.6.4.2.1. パスパラメーター

名前	説明	必須	デフォルト	パターン
id		X	null

1.6.4.3. 戻り値のタイプ

Object

1.6.4.4. コンテンツタイプ

application/json

1.6.4.5. レスポンス

表1.32 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

1.6.4.6. サンプル

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

1.6.4.7.1. GooglerpcStatus

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

1.6.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 {
  ...
}

1.6.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.6.5. GetAuthMachineToMachineConfig

GET /v1/auth/m2m/{id}

GetAuthMachineToMachineConfig は、特定の machine to machine 認証設定を取得します。

1.6.5.1. 説明

1.6.5.2. パラメーター

1.6.5.2.1. パスパラメーター

名前	説明	必須	デフォルト	パターン
id		X	null

1.6.5.3. 戻り値のタイプ

V1GetAuthMachineToMachineConfigResponse

1.6.5.4. コンテンツタイプ

application/json

1.6.5.5. レスポンス

表1.33 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetAuthMachineToMachineConfigResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.6.5.6. サンプル

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

1.6.5.7.1. AuthMachineToMachineConfigMapping

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

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

1.6.5.7.2. GooglerpcStatus

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

1.6.5.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 {
  ...
}

1.6.5.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.6.5.7.4. V1AuthMachineToMachineConfig

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

1.6.5.7.5. V1AuthMachineToMachineConfigType

列挙値
GENERIC
GITHUB_ACTIONS
KUBE_SERVICE_ACCOUNT

1.6.5.7.6. V1GetAuthMachineToMachineConfigResponse

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

1.6.6. AddAuthMachineToMachineConfig

POST /v1/auth/m2m

AddAuthMachineToMachineConfig は、machine to machine 認証を新規作成します。

1.6.6.1. 説明

1.6.6.2. パラメーター

1.6.6.2.1. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	V1AddAuthMachineToMachineConfigRequest	X

1.6.6.3. 戻り値のタイプ

V1AddAuthMachineToMachineConfigResponse

1.6.6.4. コンテンツタイプ

application/json

1.6.6.5. レスポンス

表1.34 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1AddAuthMachineToMachineConfigResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.6.6.6. サンプル

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

1.6.6.7.1. AuthMachineToMachineConfigMapping

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

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

1.6.6.7.2. GooglerpcStatus

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

1.6.6.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 {
  ...
}

1.6.6.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.6.6.7.4. V1AddAuthMachineToMachineConfigRequest

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

1.6.6.7.5. V1AddAuthMachineToMachineConfigResponse

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

1.6.6.7.6. V1AuthMachineToMachineConfig

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

1.6.6.7.7. V1AuthMachineToMachineConfigType

列挙値
GENERIC
GITHUB_ACTIONS
KUBE_SERVICE_ACCOUNT

1.6.7. GetAuthStatus

GET /v1/auth/status

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

1.6.7.1. 説明

1.6.7.2. パラメーター

1.6.7.3. 戻り値のタイプ

V1AuthStatus

1.6.7.4. コンテンツタイプ

application/json

1.6.7.5. レスポンス

表1.35 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1AuthStatus
0	予期しないエラーの応答。	GooglerpcStatus

1.6.7.6. サンプル

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

1.6.7.7.1. AuthProviderRequiredAttribute

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

1.6.7.7.2. GooglerpcStatus

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

1.6.7.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 {
  ...
}

1.6.7.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.6.7.7.4. StorageAccess

列挙値
NO_ACCESS
READ_ACCESS
READ_WRITE_ACCESS

1.6.7.7.5. StorageAuthProvider

次のタグ: 15。

フィールド名	型	説明	形式
id	String
name	String
type	String
uiEndpoint	String
enabled	Boolean
config	`string` のマップ	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 コールバックモード。\"fragment\"、\"post\"、または \"query\" から選択します。- \"disable_offline_access_scope\": オフライントークンを発行しない場合は \"true\" に設定します。- \"extra_scopes\": https://www.rfc-editor.org/rfc/rfc6749.html#section-3.3 に従って、\"openid profile email\" に加えて要求する追加のスコープのスペース区切り文字列。OpenShift Auth: 追加の設定オプションはサポートされません。User 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 エンドポイント。つまり、ログイン要求がこれらのいずれかから送信される場合、認証要求は ui_endpoint ではなくこれらをコールバック URL に使用します。
active	Boolean
requiredAttributes	AuthProviderRequiredAttribute のリスト
traits	StorageTraits
claimMappings	`string` のマップ	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.\") We do NOT support the following types of claims: * complex claims(path \"a\") * float/integer claims(path \"a.g\") * float/integer array claims(path \"a.h\") の型の要求がサポートされています。このマップの各値には、要求を追加する Rox トークン属性名が含まれています。たとえば、値が \"groups\" の場合、要求はトークンの \"external_user.Attributes.groups\" にあります。注記: この機能は OIDC 認証プロバイダーに対してのみサポートされます。
lastUpdated	Date	最終更新日は、認証プロバイダーが最後に更新された日時を示します。このタイムスタンプより前に、認証プロバイダーによって発行されたトークンがある場合、無効とみなされます。その後、すべてのクライアントは、(更新するか、追加のログイン試行によって) トークンを再発行する必要があります。	date-time

1.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, BENCHMARK_SERVICE, SCANNER_SERVICE, SCANNER_DB_SERVICE, ADMISSION_CONTROL_SERVICE, SCANNER_V4_INDEXER_SERVICE, SCANNER_V4_MATCHER_SERVICE, SCANNER_V4_DB_SERVICE, SCANNER_V4_SERVICE, REGISTRANT_SERVICE
initBundleId	String

1.6.7.7.7. StorageServiceType

Next available tag: 18

SCANNER_V4_SERVICE: これは、Scanner V4 がコンボモードで実行されるときに使用されます。

列挙値
UNKNOWN_SERVICE
SENSOR_SERVICE
CENTRAL_SERVICE
CENTRAL_DB_SERVICE
REMOTE_SERVICE
COLLECTOR_SERVICE
MONITORING_UI_SERVICE
MONITORING_DB_SERVICE
MONITORING_CLIENT_SERVICE
BENCHMARK_SERVICE
SCANNER_SERVICE
SCANNER_DB_SERVICE
ADMISSION_CONTROL_SERVICE
SCANNER_V4_INDEXER_SERVICE
SCANNER_V4_MATCHER_SERVICE
SCANNER_V4_DB_SERVICE
SCANNER_V4_SERVICE
REGISTRANT_SERVICE

1.6.7.7.8. StorageTraits

フィールド名	型	形式
mutabilityMode	TraitsMutabilityMode	ALLOW_MUTATE, ALLOW_MUTATE_FORCED,
visibility	TraitsVisibility	VISIBLE, HIDDEN,
origin	TraitsOrigin	IMPERATIVE, DEFAULT, DECLARATIVE, DECLARATIVE_ORPHANED,

1.6.7.7.9. StorageUserInfo

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

1.6.7.7.10. StorageUserInfoRole

ロールは、storage.Role の古い形式と互換性があるため、ロール名と関連する権限のみが含まれます。

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

1.6.7.7.11. TraitsMutabilityMode

列挙値
ALLOW_MUTATE
ALLOW_MUTATE_FORCED

1.6.7.7.12. TraitsOrigin

列挙値
IMPERATIVE
DEFAULT
DECLARATIVE
DECLARATIVE_ORPHANED

1.6.7.7.13. TraitsVisibility

EXPERIMENTAL。visibility を使用すると、特定の API に対してオブジェクトを表示するかどうかを指定できます。

列挙値
VISIBLE
HIDDEN

1.6.7.7.14. UserInfoResourceToAccess

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

1.6.7.7.15. V1AuthStatus

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

1.6.7.7.16. V1UserAttribute

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

1.7. CentralHealthService

1.7.1. GetUpgradeStatus

GET /v1/centralhealth/upgradestatus

1.7.1.1. 説明

1.7.1.2. パラメーター

1.7.1.3. 戻り値のタイプ

V1GetUpgradeStatusResponse

1.7.1.4. コンテンツタイプ

application/json

1.7.1.5. レスポンス

表1.36 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetUpgradeStatusResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.7.1.6. サンプル

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

1.7.1.7.1. GooglerpcStatus

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

1.7.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 {
  ...
}

1.7.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.7.1.7.3. V1CentralUpgradeStatus

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

1.7.1.7.4. V1GetUpgradeStatusResponse

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

1.8. CloudSourcesService

1.8.1. UpdateCloudSource

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

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

1.8.1.1. 説明

1.8.1.2. パラメーター

1.8.1.2.1. パスパラメーター

名前	説明	必須	デフォルト	パターン
cloudSource.id		X	null

1.8.1.2.2. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	CloudSourcesServiceUpdateCloudSourceBody	X

1.8.1.3. 戻り値のタイプ

Object

1.8.1.4. コンテンツタイプ

application/json

1.8.1.5. レスポンス

表1.37 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

1.8.1.6. サンプル

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

1.8.1.7.1. CloudSourcesServiceUpdateCloudSourceBody

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

1.8.1.7.2. CloudSourcesServiceUpdateCloudSourceBodyCloudSource

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

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

1.8.1.7.3. GooglerpcStatus

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

1.8.1.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 {
  ...
}

1.8.1.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.8.1.7.5. V1CloudSourceCredentials

フィールド名	型	説明
secret	String	有効期間が長いトークンで単一値認証を行う場合に使用されます。
clientId	String	client_secret と組み合わせてクライアント認証に使用されます。
clientSecret	String	client_id と組み合わせてクライアント認証に使用されます。

1.8.1.7.6. V1CloudSourceType

列挙値
TYPE_UNSPECIFIED
TYPE_PALADIN_CLOUD
TYPE_OCM

1.8.1.7.7. V1OCMConfig

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

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

1.8.1.7.8. V1PaladinCloudConfig

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

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

1.8.2. ListCloudSources

GET /v1/cloud-sources

ListCloudSources は、要求されたフィールドに基づいてフィルタリングしたクラウドソースのリストを返します。

1.8.2.1. 説明

1.8.2.2. パラメーター

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

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

1.8.2.3. 戻り値のタイプ

V1ListCloudSourcesResponse

1.8.2.4. コンテンツタイプ

application/json

1.8.2.5. レスポンス

表1.38 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListCloudSourcesResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.8.2.6. サンプル

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

1.8.2.7.1. GooglerpcStatus

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

1.8.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 {
  ...
}

1.8.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.8.2.7.3. V1CloudSource

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

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

1.8.2.7.4. V1CloudSourceCredentials

フィールド名	型	説明
secret	String	有効期間が長いトークンで単一値認証を行う場合に使用されます。
clientId	String	client_secret と組み合わせてクライアント認証に使用されます。
clientSecret	String	client_id と組み合わせてクライアント認証に使用されます。

1.8.2.7.5. V1CloudSourceType

列挙値
TYPE_UNSPECIFIED
TYPE_PALADIN_CLOUD
TYPE_OCM

1.8.2.7.6. V1ListCloudSourcesResponse

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

1.8.2.7.7. V1OCMConfig

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

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

1.8.2.7.8. V1PaladinCloudConfig

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

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

1.8.3. DeleteCloudSource

DELETE /v1/cloud-sources/{id}

DeleteCloudSource はクラウドソースを削除します。

1.8.3.1. 説明

1.8.3.2. パラメーター

1.8.3.2.1. パスパラメーター

名前	説明	必須	デフォルト	パターン
id		X	null

1.8.3.3. 戻り値のタイプ

Object

1.8.3.4. コンテンツタイプ

application/json

1.8.3.5. レスポンス

表1.39 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

1.8.3.6. サンプル

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

1.8.3.7.1. GooglerpcStatus

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

1.8.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 {
  ...
}

1.8.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.8.4. GetCloudSource

GET /v1/cloud-sources/{id}

GetCloudSource は ID によってクラウドソースを取得します。

1.8.4.1. 説明

1.8.4.2. パラメーター

1.8.4.2.1. パスパラメーター

名前	説明	必須	デフォルト	パターン
id		X	null

1.8.4.3. 戻り値のタイプ

V1GetCloudSourceResponse

1.8.4.4. コンテンツタイプ

application/json

1.8.4.5. レスポンス

表1.40 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetCloudSourceResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.8.4.6. サンプル

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

1.8.4.7.1. GooglerpcStatus

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

1.8.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 {
  ...
}

1.8.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.8.4.7.3. V1CloudSource

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

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

1.8.4.7.4. V1CloudSourceCredentials

フィールド名	型	説明
secret	String	有効期間が長いトークンで単一値認証を行う場合に使用されます。
clientId	String	client_secret と組み合わせてクライアント認証に使用されます。
clientSecret	String	client_id と組み合わせてクライアント認証に使用されます。

1.8.4.7.5. V1CloudSourceType

列挙値
TYPE_UNSPECIFIED
TYPE_PALADIN_CLOUD
TYPE_OCM

1.8.4.7.6. V1GetCloudSourceResponse

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

1.8.4.7.7. V1OCMConfig

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

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

1.8.4.7.8. V1PaladinCloudConfig

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

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

1.8.5. CreateCloudSource

POST /v1/cloud-sources

CreateCloudSource はクラウドソースを作成します。

1.8.5.1. 説明

1.8.5.2. パラメーター

1.8.5.2.1. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	V1CreateCloudSourceRequest	X

1.8.5.3. 戻り値のタイプ

V1CreateCloudSourceResponse

1.8.5.4. コンテンツタイプ

application/json

1.8.5.5. レスポンス

表1.41 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CreateCloudSourceResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.8.5.6. サンプル

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

1.8.5.7.1. GooglerpcStatus

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

1.8.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 {
  ...
}

1.8.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.8.5.7.3. V1CloudSource

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

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

1.8.5.7.4. V1CloudSourceCredentials

フィールド名	型	説明
secret	String	有効期間が長いトークンで単一値認証を行う場合に使用されます。
clientId	String	client_secret と組み合わせてクライアント認証に使用されます。
clientSecret	String	client_id と組み合わせてクライアント認証に使用されます。

1.8.5.7.5. V1CloudSourceType

列挙値
TYPE_UNSPECIFIED
TYPE_PALADIN_CLOUD
TYPE_OCM

1.8.5.7.6. V1CreateCloudSourceRequest

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

1.8.5.7.7. V1CreateCloudSourceResponse

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

1.8.5.7.8. V1OCMConfig

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

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

1.8.5.7.9. V1PaladinCloudConfig

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

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

1.8.6. TestCloudSource

POST /v1/cloud-sources/test

TestCloudSource はクラウドソースをテストします。

1.8.6.1. 説明

1.8.6.2. パラメーター

1.8.6.2.1. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	V1TestCloudSourceRequest	X

1.8.6.3. 戻り値のタイプ

Object

1.8.6.4. コンテンツタイプ

application/json

1.8.6.5. レスポンス

表1.42 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

1.8.6.6. サンプル

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

1.8.6.7.1. GooglerpcStatus

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

1.8.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 {
  ...
}

1.8.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.8.6.7.3. V1CloudSource

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

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

1.8.6.7.4. V1CloudSourceCredentials

フィールド名	型	説明
secret	String	有効期間が長いトークンで単一値認証を行う場合に使用されます。
clientId	String	client_secret と組み合わせてクライアント認証に使用されます。
clientSecret	String	client_id と組み合わせてクライアント認証に使用されます。

1.8.6.7.5. V1CloudSourceType

列挙値
TYPE_UNSPECIFIED
TYPE_PALADIN_CLOUD
TYPE_OCM

1.8.6.7.6. V1OCMConfig

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

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

1.8.6.7.7. V1PaladinCloudConfig

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

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

1.8.6.7.8. V1TestCloudSourceRequest

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

1.8.7. CountCloudSources

GET /v1/count/cloud-sources

CountCloudSources は、要求されたフィールドでフィルタリングした後、クラウドソースの数を返します。

1.8.7.1. 説明

1.8.7.2. パラメーター

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

名前	説明	必須	デフォルト	パターン
filter.names	名前に基づいてクラウドソースを照合します。`String`	-	null
filter.types	クラウドソースをタイプに基づいて照合します。`String`	-	null

1.8.7.3. 戻り値のタイプ

V1CountCloudSourcesResponse

1.8.7.4. コンテンツタイプ

application/json

1.8.7.5. レスポンス

表1.43 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CountCloudSourcesResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.8.7.6. サンプル

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

1.8.7.7.1. GooglerpcStatus

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

1.8.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 {
  ...
}

1.8.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.8.7.7.3. V1CountCloudSourcesResponse

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

1.9. ClusterCVEService

1.9.1. SuppressCVEs

PATCH /v1/clustercves/suppress

SuppressCVE はクラスター CVE を抑制します。

1.9.1.1. 説明

1.9.1.2. パラメーター

1.9.1.2.1. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	V1SuppressCVERequest	X

1.9.1.3. 戻り値のタイプ

Object

1.9.1.4. コンテンツタイプ

application/json

1.9.1.5. レスポンス

表1.44 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

1.9.1.6. サンプル

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

1.9.1.7.1. GooglerpcStatus

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

1.9.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 {
  ...
}

1.9.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.9.1.7.3. V1SuppressCVERequest

フィールド名	必須	Null 許容型	型	説明	形式
cves			`string` のリスト	これらは (NVD) 脆弱性識別子であり、`storage.CVE` の `cve` フィールドで、`id` フィールドではありません。例: CVE-2021-44832。
duration			String	JSON 形式では、Duration 型はオブジェクトではなく文字列としてエンコードされます。文字列は接尾辞 \"s\" (秒を示す) で終わり、その前に秒数が付きます。ナノ秒は小数秒として表されます。たとえば、3 秒と 0 ナノ秒は JSON 形式で \"3s\" とエンコードする必要がありますが、3 秒と 1 ナノ秒は JSON 形式で \"3.000000001s\" と表現する必要があり、3 秒と 1 マイクロ秒は JSON 形式で \"3.000001s\" と表現する必要があります。

1.9.2. UnsuppressCVEs

PATCH /v1/clustercves/unsuppress

UnsuppressCVE はクラスター CVE を抑制解除します。

1.9.2.1. 説明

1.9.2.2. パラメーター

1.9.2.2.1. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	V1UnsuppressCVERequest	X

1.9.2.3. 戻り値のタイプ

Object

1.9.2.4. コンテンツタイプ

application/json

1.9.2.5. レスポンス

表1.45 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

1.9.2.6. サンプル

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

1.9.2.7.1. GooglerpcStatus

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

1.9.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 {
  ...
}

1.9.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.9.2.7.3. V1UnsuppressCVERequest

フィールド名	必須	Null 許容型	型	説明	形式
cves			`string` のリスト	これらは (NVD) 脆弱性識別子であり、`storage.CVE` の `cve` フィールドで、`id` フィールドではありません。例: CVE-2021-44832。

1.10. ClusterInitService

1.10.1. GetCAConfig

GET /v1/cluster-init/ca-config

1.10.1.1. 説明

1.10.1.2. パラメーター

1.10.1.3. 戻り値のタイプ

V1GetCAConfigResponse

1.10.1.4. コンテンツタイプ

application/json

1.10.1.5. レスポンス

表1.46 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetCAConfigResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.10.1.6. サンプル

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

1.10.1.7.1. GooglerpcStatus

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

1.10.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 {
  ...
}

1.10.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.10.1.7.3. V1GetCAConfigResponse

フィールド名	必須	Null 許容型	型	説明	形式
helmValuesBundle			byte[]		byte

1.10.2. GetCRSs

GET /v1/cluster-init/crs

1.10.2.1. 説明

1.10.2.2. パラメーター

1.10.2.3. 戻り値のタイプ

V1CRSMetasResponse

1.10.2.4. コンテンツタイプ

application/json

1.10.2.5. レスポンス

表1.47 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CRSMetasResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.10.2.6. サンプル

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

1.10.2.7.1. GooglerpcStatus

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

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

1.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.10.2.7.3. StorageUser

ユーザーは、ユーザーが関連付けられているロールと、ログイン方法を追跡できるオブジェクトです。

フィールド名	必須	Null 許容型	型	説明	形式
id			String
authProviderId			String
attributes			StorageUserAttribute のリスト
idpToken			String

1.10.2.7.4. StorageUserAttribute

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

1.10.2.7.5. V1CRSMeta

フィールド名	型	形式
id	String
name	String
createdAt	Date	date-time
createdBy	StorageUser
expiresAt	Date	date-time

1.10.2.7.6. V1CRSMetasResponse

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

1.10.3. GenerateCRS

POST /v1/cluster-init/crs

1.10.3.1. 説明

1.10.3.2. パラメーター

1.10.3.2.1. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	V1CRSGenRequest	X

1.10.3.3. 戻り値のタイプ

V1CRSGenResponse

1.10.3.4. コンテンツタイプ

application/json

1.10.3.5. レスポンス

表1.48 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CRSGenResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.10.3.6. サンプル

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

1.10.3.7.1. GooglerpcStatus

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

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

1.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.10.3.7.3. StorageUser

ユーザーは、ユーザーが関連付けられているロールと、ログイン方法を追跡できるオブジェクトです。

フィールド名	必須	Null 許容型	型	説明	形式
id			String
authProviderId			String
attributes			StorageUserAttribute のリスト
idpToken			String

1.10.3.7.4. StorageUserAttribute

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

1.10.3.7.5. V1CRSGenRequest

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

1.10.3.7.6. V1CRSGenResponse

フィールド名	必須	Null 許容型	型	説明	形式
meta			V1CRSMeta
crs			byte[]		byte

1.10.3.7.7. V1CRSMeta

フィールド名	型	形式
id	String
name	String
createdAt	Date	date-time
createdBy	StorageUser
expiresAt	Date	date-time

1.10.4. RevokeCRS

PATCH /v1/cluster-init/crs/revoke

RevokeCRSBundle はクラスター登録シークレットを削除します。

1.10.4.1. 説明

1.10.4.2. パラメーター

1.10.4.2.1. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	V1CRSRevokeRequest	X

1.10.4.3. 戻り値のタイプ

V1CRSRevokeResponse

1.10.4.4. コンテンツタイプ

application/json

1.10.4.5. レスポンス

表1.49 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CRSRevokeResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.10.4.6. サンプル

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

1.10.4.7.1. CRSRevokeResponseCRSRevocationError

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

1.10.4.7.2. GooglerpcStatus

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

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

1.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.10.4.7.4. V1CRSRevokeRequest

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

1.10.4.7.5. V1CRSRevokeResponse

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

1.10.5. GetInitBundles

GET /v1/cluster-init/init-bundles

1.10.5.1. 説明

1.10.5.2. パラメーター

1.10.5.3. 戻り値のタイプ

V1InitBundleMetasResponse

1.10.5.4. コンテンツタイプ

application/json

1.10.5.5. レスポンス

表1.50 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1InitBundleMetasResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.10.5.6. サンプル

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

1.10.5.7.1. GooglerpcStatus

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

1.10.5.7.2. InitBundleMetaImpactedCluster

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

1.10.5.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 {
  ...
}

1.10.5.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.10.5.7.4. StorageUser

ユーザーは、ユーザーが関連付けられているロールと、ログイン方法を追跡できるオブジェクトです。

フィールド名	必須	Null 許容型	型	説明	形式
id			String
authProviderId			String
attributes			StorageUserAttribute のリスト
idpToken			String

1.10.5.7.5. StorageUserAttribute

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

1.10.5.7.6. V1InitBundleMeta

フィールド名	型	形式
id	String
name	String
impactedClusters	InitBundleMetaImpactedCluster のリスト
createdAt	Date	date-time
createdBy	StorageUser
expiresAt	Date	date-time

1.10.5.7.7. V1InitBundleMetasResponse

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

1.10.6. GenerateInitBundle

POST /v1/cluster-init/init-bundles

1.10.6.1. 説明

1.10.6.2. パラメーター

1.10.6.2.1. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	V1InitBundleGenRequest	X

1.10.6.3. 戻り値のタイプ

V1InitBundleGenResponse

1.10.6.4. コンテンツタイプ

application/json

1.10.6.5. レスポンス

表1.51 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1InitBundleGenResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.10.6.6. サンプル

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

1.10.6.7.1. GooglerpcStatus

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

1.10.6.7.2. InitBundleMetaImpactedCluster

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

1.10.6.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 {
  ...
}

1.10.6.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.10.6.7.4. StorageUser

ユーザーは、ユーザーが関連付けられているロールと、ログイン方法を追跡できるオブジェクトです。

フィールド名	必須	Null 許容型	型	説明	形式
id			String
authProviderId			String
attributes			StorageUserAttribute のリスト
idpToken			String

1.10.6.7.5. StorageUserAttribute

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

1.10.6.7.6. V1InitBundleGenRequest

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

1.10.6.7.7. V1InitBundleGenResponse

フィールド名	型	形式
meta	V1InitBundleMeta
helmValuesBundle	byte[]	byte
kubectlBundle	byte[]	byte

1.10.6.7.8. V1InitBundleMeta

フィールド名	型	形式
id	String
name	String
impactedClusters	InitBundleMetaImpactedCluster のリスト
createdAt	Date	date-time
createdBy	StorageUser
expiresAt	Date	date-time

1.10.7. RevokeInitBundle

PATCH /v1/cluster-init/init-bundles/revoke

RevokeInitBundle はクラスターの初期化バンドルを削除します。この操作がいずれかのクラスターに影響する場合は、その ID をリクエストに含める必要があります。confirm_impacted_clusters_ids が現在影響を受けているクラスターと一致しない場合、影響を受けるすべてのクラスターを含むエラーでリクエストは失敗します。

1.10.7.1. 説明

1.10.7.2. パラメーター

1.10.7.2.1. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	V1InitBundleRevokeRequest	X

1.10.7.3. 戻り値のタイプ

V1InitBundleRevokeResponse

1.10.7.4. コンテンツタイプ

application/json

1.10.7.5. レスポンス

表1.52 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1InitBundleRevokeResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.10.7.6. サンプル

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

1.10.7.7.1. GooglerpcStatus

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

1.10.7.7.2. InitBundleMetaImpactedCluster

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

1.10.7.7.3. InitBundleRevokeResponseInitBundleRevocationError

フィールド名	必須	Null 許容型	型	説明	形式
id			String
error			String
impactedClusters			InitBundleMetaImpactedCluster のリスト

1.10.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 {
  ...
}

1.10.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.10.7.7.5. V1InitBundleRevokeRequest

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

1.10.7.7.6. V1InitBundleRevokeResponse

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

1.11. ClustersService

1.11.1. GetClusterDefaultValues

GET /v1/cluster-defaults

1.11.1.1. 説明

1.11.1.2. パラメーター

1.11.1.3. 戻り値のタイプ

V1ClusterDefaultsResponse

1.11.1.4. コンテンツタイプ

application/json

1.11.1.5. レスポンス

表1.53 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ClusterDefaultsResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.11.1.6. サンプル

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

1.11.1.7.1. GooglerpcStatus

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

1.11.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 {
  ...
}

1.11.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.11.1.7.3. V1ClusterDefaultsResponse

フィールド名	必須	Null 許容型	型	説明	形式
mainImageRepository			String
collectorImageRepository			String
kernelSupportAvailable			Boolean

1.11.2. GetKernelSupportAvailable

GET /v1/clusters-env/kernel-support-available

GetKernelSupportAvailable は非推奨になり、代わりに GetClusterDefaultValues が推奨されます。

1.11.2.1. 説明

1.11.2.2. パラメーター

1.11.2.3. 戻り値のタイプ

V1KernelSupportAvailableResponse

1.11.2.4. コンテンツタイプ

application/json

1.11.2.5. レスポンス

表1.54 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1KernelSupportAvailableResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.11.2.6. サンプル

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

1.11.2.7.1. GooglerpcStatus

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

1.11.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 {
  ...
}

1.11.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.11.2.7.3. V1KernelSupportAvailableResponse

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

1.11.3. GetClusters

GET /v1/clusters

1.11.3.1. 説明

1.11.3.2. パラメーター

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

名前	説明	必須	デフォルト	パターン
query		-	null

1.11.3.3. 戻り値のタイプ

V1ClustersList

1.11.3.4. コンテンツタイプ

application/json

1.11.3.5. レスポンス

表1.55 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ClustersList
0	予期しないエラーの応答。	GooglerpcStatus

1.11.3.6. サンプル

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

1.11.3.7.1. ClusterHealthStatusHealthStatusLabel

UNAVAILABLE: ステータスに unavailable を指定できるのはコレクターのみです

列挙値
UNINITIALIZED
UNAVAILABLE
UNHEALTHY
DEGRADED
HEALTHY

1.11.3.7.2. ClusterUpgradeStatusUpgradability

SENSOR_VERSION_HIGHER: SENSOR_VERSION_HIGHER は、sensor がこの Central よりも新しいバージョンを実行していることが検出された場合に発生します。これは予期しないエラーですが、顧客が行うパッチによっては発生する可能性があります。この場合、自動アップグレード設定がオンであっても、ダウングレードになるため、sensor が自動的に "アップグレード" されることはありません。ユーザーは手動でアップグレードをトリガーできますが、この設定はサポートされていないため、最初に Central をアップグレードせずに手動でアップグレードすることは推奨されません。

列挙値
UNSET
UP_TO_DATE
MANUAL_UPGRADE_REQUIRED
AUTO_UPGRADE_POSSIBLE
SENSOR_VERSION_HIGHER

1.11.3.7.3. ClusterUpgradeStatusUpgradeProcessStatus

フィールド名	型	形式
active	Boolean
id	String
targetVersion	String
upgraderImage	String
initiatedAt	Date	date-time
progress	StorageUpgradeProgress
type	UpgradeProcessStatusUpgradeProcessType	UPGRADE, CERT_ROTATION,

1.11.3.7.4. GooglerpcStatus

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

1.11.3.7.5. 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.11.3.7.5.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.11.3.7.6. StorageAWSProviderMetadata

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

1.11.3.7.7. StorageAdmissionControlHealthInfo

AdmissionControlHealthInfo は、アドミッションコントロールのデプロイメントに関するデータを保管しますが、このデータから派生したアドミッションコントロールヘルスステータスは含まれません。集約されたアドミッションコントロールのヘルスステータスは、AdmissionControlHealthInfo (sensor) を最初に報告するコンポーネントではなく、central から取得されるため、含まれません。

次のフィールドは、取得時にエラーが発生する可能性があり、デフォルト値 0 が実際の値 0 と混同される可能性があるため、任意または null 許容型になっています。特定のフィールドを取得しようとしたときにエラーが発生した場合、デフォルト値が割り当てられるのではなく、出力にそのフィールドが含まれません。

フィールド名	型	説明	形式
totalDesiredPods	Integer		int32
totalReadyPods	Integer		int32
statusErrors	`string` のリスト	アドミッションコントロールのヘルス情報を取得しようとしたときに発生したエラーのコレクション。

1.11.3.7.8. StorageAdmissionControllerConfig

フィールド名	型	形式
enabled	Boolean
timeoutSeconds	Integer	int32
scanInline	Boolean
disableBypass	Boolean
enforceOnUpdates	Boolean

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

1.11.3.7.10. StorageAzureProviderMetadata

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

1.11.3.7.11. StorageCluster

フィールド名	型	説明	形式
id	String
name	String
type	StorageClusterType		GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,
labels	`string` のマップ
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	StorageAuditLogFileState のマップ	内部での使用のみ。
initBundleId	String
managedBy	StorageManagerType		MANAGER_TYPE_UNKNOWN, MANAGER_TYPE_MANUAL, MANAGER_TYPE_HELM_CHART, MANAGER_TYPE_KUBERNETES_OPERATOR,
sensorCapabilities	`string` のリスト

1.11.3.7.12. StorageClusterCertExpiryStatus

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

1.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	ヘルス機能を持たないセンサーの場合、gRPC 接続ポーリングが使用されます。それ以外の場合、このタイムスタンプは、メッセージ処理時に中央パイプラインによって更新されます。注記: この設定は、CRS ベースのクラスター登録中に特定の攻撃ベクトルから保護するために使用します。CRS を使用してクラスター A を登録し、その CRS が漏洩したとしても、攻撃者が CRS フローを再実行してクラスター A に発行された証明書とキーを入手できることがあってはなりません。対抗策として、last_contact フィールドが空である場合にのみ CRS フローの再実行を許可します。これは、正当なクラスター A のセンサーが CRS が発行したサービス証明書にまだ接続されていないことを示します。	date-time
healthInfoComplete	Boolean

1.11.3.7.14. StorageClusterMetadata

ClusterMetadata には、クラスターインフラストラクチャーに関するメタデータ情報が含まれます。

フィールド名	型	説明	形式
type	StorageClusterMetadataType		UNSPECIFIED, AKS, ARO, EKS, GKE, OCP, OSD, ROSA,
name	String	name は、クラウドプロバイダーに登録したクラスターの名前を表します。self managed OpenShift の場合、これは OpenShift インストーラーによって選択された名前です。
id	String	id は、クラウドプロバイダーに登録したクラスターの一意の ID を表します。すべてのクラスタータイプに id があるわけではありません。すべての OpenShift クラスターの場合、これは OCM に登録された Red Hat `cluster_id` です。

1.11.3.7.15. StorageClusterMetadataType

列挙値
UNSPECIFIED
AKS
ARO
EKS
GKE
OCP
OSD
ROSA

1.11.3.7.16. StorageClusterStatus

フィールド名	型	説明	形式
sensorVersion	String
DEPRECATEDLastContact	Date	このフィールドはリリース 49.0 以降で非推奨になりました。代わりに healthStatus.lastContact を使用してください。	date-time
providerMetadata	StorageProviderMetadata
orchestratorMetadata	StorageOrchestratorMetadata
upgradeStatus	StorageClusterUpgradeStatus
certExpiryStatus	StorageClusterCertExpiryStatus

1.11.3.7.17. StorageClusterType

列挙値
GENERIC_CLUSTER
KUBERNETES_CLUSTER
OPENSHIFT_CLUSTER
OPENSHIFT4_CLUSTER

1.11.3.7.18. StorageClusterUpgradeStatus

フィールド名	型	形式
upgradability	ClusterUpgradeStatusUpgradability	UNSET, UP_TO_DATE, MANUAL_UPGRADE_REQUIRED, AUTO_UPGRADE_POSSIBLE, SENSOR_VERSION_HIGHER,
upgradabilityStatusReason	String
mostRecentProcess	ClusterUpgradeStatusUpgradeProcessStatus

1.11.3.7.19. StorageCollectionMethod

列挙値
UNSET_COLLECTION
NO_COLLECTION
KERNEL_MODULE
EBPF
CORE_BPF

1.11.3.7.20. StorageCollectorHealthInfo

CollectorHealthInfo にはコレクターのデプロイメントに関するデータが含まれますが、このデータから得られるコレクターのヘルスステータスは含まれません。集約されたコレクターのヘルスステータスは、CollectorHealthInfo (sensor) を最初に報告するコンポーネントではなく、central から取得されるため、含まれません。

フィールド名	型	説明	形式
version	String
totalDesiredPods	Integer		int32
totalReadyPods	Integer		int32
totalRegisteredNodes	Integer		int32
statusErrors	`string` のリスト	コレクターのヘルスの情報を取得しようとしたときに発生したエラーのコレクション。

1.11.3.7.21. StorageCompleteClusterConfig

静的および動的設定を含む ID/名前識別子を除いた完全なクラスター設定をエンコードします。

フィールド名	必須	Null 許容型	型	説明	形式
dynamicConfig			StorageDynamicClusterConfig
staticConfig			StorageStaticClusterConfig
configFingerprint			String
clusterLabels			`string` のマップ

1.11.3.7.22. StorageDynamicClusterConfig

静的クラスター設定と動的クラスター設定は、動的値が Central から Sensor への gRPC 接続を介して送信される点が異なります。これには、セキュアクラスターコンポーネントを再起動せずに値の "ホットリロード" を可能にするという利点があります。

フィールド名	必須	Null 許容型	型	説明	形式
admissionControllerConfig			StorageAdmissionControllerConfig
registryOverride			String
disableAuditLogs			Boolean

1.11.3.7.23. StorageGoogleProviderMetadata

フィールド名	必須	Null 許容型	型	説明	形式
project			String
clusterName			String	providerMetadata.cluster.name に置き換えられたため非推奨になりました。

1.11.3.7.24. StorageManagerType

列挙値
MANAGER_TYPE_UNKNOWN
MANAGER_TYPE_MANUAL
MANAGER_TYPE_HELM_CHART
MANAGER_TYPE_KUBERNETES_OPERATOR

1.11.3.7.25. StorageOrchestratorMetadata

フィールド名	型	形式
version	String
openshiftVersion	String
buildDate	Date	date-time
apiVersions	`string` のリスト

1.11.3.7.26. StorageProviderMetadata

フィールド名	必須	Null 許容型	型	説明	形式
region			String
zone			String
google			StorageGoogleProviderMetadata
aws			StorageAWSProviderMetadata
azure			StorageAzureProviderMetadata
verified			Boolean
cluster			StorageClusterMetadata

1.11.3.7.27. StorageScannerHealthInfo

ScannerHealthInfo は、セキュアクラスターにデプロイされたスキャナーインスタンス (いわゆる "ローカルスキャナー") のヘルス情報を表します。scanner が central クラスターにデプロイされている場合、次のメッセージは使用されません。ScannerHealthInfo にはコレクターのデプロイメントに関するデータが含まれますが、このデータから得られるコレクターのヘルスステータスは含まれません。集約された scanner のヘルスステータスは、ScannerHealthInfo (sensor) を最初に報告するコンポーネントではなく、central から取得されるため、含まれません。

フィールド名	型	説明	形式
totalDesiredAnalyzerPods	Integer		int32
totalReadyAnalyzerPods	Integer		int32
totalDesiredDbPods	Integer		int32
totalReadyDbPods	Integer		int32
statusErrors	`string` のリスト	スキャナーのヘルス情報を取得しようとしたときに発生したエラーのコレクション。

1.11.3.7.28. StorageSensorDeploymentIdentification

StackRoxDeploymentIdentification は、StackRox Sensor のデプロイメントを一意に識別することを目的としています。これは、sensor 接続が再起動または再作成された sensor Pod (ネットワークパーティションの後で発生する可能性あり) からのものか、別の namespace またはクラスター内のデプロイメントからのものかを判断するために使用されます。

フィールド名	必須	Null 許容型	型	説明	形式
systemNamespaceId			String
defaultNamespaceId			String
appNamespace			String
appNamespaceId			String
appServiceaccountId			String
k8sNodeName			String

1.11.3.7.29. StorageStaticClusterConfig

静的クラスター設定と動的クラスター設定の違いは、静的値が Central から Sensor への 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

1.11.3.7.30. StorageTolerationsConfig

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

1.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, UPGRADE_ERROR_ROLLED_BACK, UPGRADE_ERROR_ROLLBACK_FAILED, UPGRADE_ERROR_UNKNOWN, UPGRADE_TIMED_OUT,
upgradeStatusDetail	String
since	Date	date-time

1.11.3.7.32. UpgradeProcessStatusUpgradeProcessType

UPGRADE: UPGRADE は sensor のバージョンのアップグレードを表します。
CERT_ROTATION: CERT_ROTATION は、クラスターで使用される TLS 証明書のみをローテーションし、他のものは変更しないアップグレードプロセスを表します。

列挙値
UPGRADE
CERT_ROTATION

1.11.3.7.33. UpgradeProgressUpgradeState

UPGRADER_LAUNCHING: 進行中の状態。
UPGRADE_COMPLETE: 成功状態。すべてに番号をつけて、これより上に IN-PROGRESS の状態を、これより下に ERROR 状態のアップグレードプロセスを指定します。
UPGRADE_INITIALIZATION_ERROR: エラーの状態。

列挙値
UPGRADE_INITIALIZING
UPGRADE_LAUNCHING
UPGRADER_LAUNCHED
PRE_FLIGHT_CHECKS_COMPLETE
UPGRADE_OPERATIONS_DONE
UPGRADE_COMPLETE
UPGRADE_INITIALIZATION_ERROR
PRE_FLIGHT_CHECKS_FAILED
UPGRADE_ERROR_ROLLING_BACK
UPGRADE_ERROR_ROLLED_BACK
UPGRADE_ERROR_ROLLBACK_FAILED
UPGRADE_ERROR_UNKNOWN
UPGRADE_TIMED_OUT

1.11.3.7.34. V1ClustersList

フィールド名	必須	Null 許容型	型	説明	形式
clusters			StorageCluster のリスト
clusterIdToRetentionInfo			V1DecommissionedClusterRetentionInfo のマップ

1.11.3.7.35. V1DecommissionedClusterRetentionInfo

next available tag: 3

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

1.11.4. DeleteCluster

DELETE /v1/clusters/{id}

1.11.4.1. 説明

1.11.4.2. パラメーター

1.11.4.2.1. パスパラメーター

名前	説明	必須	デフォルト	パターン
id		X	null

1.11.4.3. 戻り値のタイプ

Object

1.11.4.4. コンテンツタイプ

application/json

1.11.4.5. レスポンス

表1.56 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

1.11.4.6. サンプル

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

1.11.4.7.1. GooglerpcStatus

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

1.11.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 {
  ...
}

1.11.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.11.5. GetCluster

GET /v1/clusters/{id}

1.11.5.1. 説明

1.11.5.2. パラメーター

1.11.5.2.1. パスパラメーター

名前	説明	必須	デフォルト	パターン
id		X	null

1.11.5.3. 戻り値のタイプ

V1ClusterResponse

1.11.5.4. コンテンツタイプ

application/json

1.11.5.5. レスポンス

表1.57 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ClusterResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.11.5.6. サンプル

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

1.11.5.7.1. ClusterHealthStatusHealthStatusLabel

UNAVAILABLE: ステータスに unavailable を指定できるのはコレクターのみです

列挙値
UNINITIALIZED
UNAVAILABLE
UNHEALTHY
DEGRADED
HEALTHY

1.11.5.7.2. ClusterUpgradeStatusUpgradability

SENSOR_VERSION_HIGHER: SENSOR_VERSION_HIGHER は、sensor がこの Central よりも新しいバージョンを実行していることが検出された場合に発生します。これは予期しないエラーですが、顧客が行うパッチによっては発生する可能性があります。この場合、自動アップグレード設定がオンであっても、ダウングレードになるため、sensor が自動的に "アップグレード" されることはありません。ユーザーは手動でアップグレードをトリガーできますが、この設定はサポートされていないため、最初に Central をアップグレードせずに手動でアップグレードすることは推奨されません。

列挙値
UNSET
UP_TO_DATE
MANUAL_UPGRADE_REQUIRED
AUTO_UPGRADE_POSSIBLE
SENSOR_VERSION_HIGHER

1.11.5.7.3. ClusterUpgradeStatusUpgradeProcessStatus

フィールド名	型	形式
active	Boolean
id	String
targetVersion	String
upgraderImage	String
initiatedAt	Date	date-time
progress	StorageUpgradeProgress
type	UpgradeProcessStatusUpgradeProcessType	UPGRADE, CERT_ROTATION,

1.11.5.7.4. GooglerpcStatus

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

1.11.5.7.5. 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.11.5.7.5.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.11.5.7.6. StorageAWSProviderMetadata

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

1.11.5.7.7. StorageAdmissionControlHealthInfo

フィールド名	型	説明	形式
totalDesiredPods	Integer		int32
totalReadyPods	Integer		int32
statusErrors	`string` のリスト	アドミッションコントロールのヘルス情報を取得しようとしたときに発生したエラーのコレクション。

1.11.5.7.8. StorageAdmissionControllerConfig

フィールド名	型	形式
enabled	Boolean
timeoutSeconds	Integer	int32
scanInline	Boolean
disableBypass	Boolean
enforceOnUpdates	Boolean

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

1.11.5.7.10. StorageAzureProviderMetadata

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

1.11.5.7.11. StorageCluster

フィールド名	型	説明	形式
id	String
name	String
type	StorageClusterType		GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,
labels	`string` のマップ
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	StorageAuditLogFileState のマップ	内部での使用のみ。
initBundleId	String
managedBy	StorageManagerType		MANAGER_TYPE_UNKNOWN, MANAGER_TYPE_MANUAL, MANAGER_TYPE_HELM_CHART, MANAGER_TYPE_KUBERNETES_OPERATOR,
sensorCapabilities	`string` のリスト

1.11.5.7.12. StorageClusterCertExpiryStatus

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

1.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	ヘルス機能を持たないセンサーの場合、gRPC 接続ポーリングが使用されます。それ以外の場合、このタイムスタンプは、メッセージ処理時に中央パイプラインによって更新されます。注記: この設定は、CRS ベースのクラスター登録中に特定の攻撃ベクトルから保護するために使用します。CRS を使用してクラスター A を登録し、その CRS が漏洩したとしても、攻撃者が CRS フローを再実行してクラスター A に発行された証明書とキーを入手できることがあってはなりません。対抗策として、last_contact フィールドが空である場合にのみ CRS フローの再実行を許可します。これは、正当なクラスター A のセンサーが CRS が発行したサービス証明書にまだ接続されていないことを示します。	date-time
healthInfoComplete	Boolean

1.11.5.7.14. StorageClusterMetadata

ClusterMetadata には、クラスターインフラストラクチャーに関するメタデータ情報が含まれます。

フィールド名	型	説明	形式
type	StorageClusterMetadataType		UNSPECIFIED, AKS, ARO, EKS, GKE, OCP, OSD, ROSA,
name	String	name は、クラウドプロバイダーに登録したクラスターの名前を表します。self managed OpenShift の場合、これは OpenShift インストーラーによって選択された名前です。
id	String	id は、クラウドプロバイダーに登録したクラスターの一意の ID を表します。すべてのクラスタータイプに id があるわけではありません。すべての OpenShift クラスターの場合、これは OCM に登録された Red Hat `cluster_id` です。

1.11.5.7.15. StorageClusterMetadataType

列挙値
UNSPECIFIED
AKS
ARO
EKS
GKE
OCP
OSD
ROSA

1.11.5.7.16. StorageClusterStatus

フィールド名	型	説明	形式
sensorVersion	String
DEPRECATEDLastContact	Date	このフィールドはリリース 49.0 以降で非推奨になりました。代わりに healthStatus.lastContact を使用してください。	date-time
providerMetadata	StorageProviderMetadata
orchestratorMetadata	StorageOrchestratorMetadata
upgradeStatus	StorageClusterUpgradeStatus
certExpiryStatus	StorageClusterCertExpiryStatus

1.11.5.7.17. StorageClusterType

列挙値
GENERIC_CLUSTER
KUBERNETES_CLUSTER
OPENSHIFT_CLUSTER
OPENSHIFT4_CLUSTER

1.11.5.7.18. StorageClusterUpgradeStatus

フィールド名	型	形式
upgradability	ClusterUpgradeStatusUpgradability	UNSET, UP_TO_DATE, MANUAL_UPGRADE_REQUIRED, AUTO_UPGRADE_POSSIBLE, SENSOR_VERSION_HIGHER,
upgradabilityStatusReason	String
mostRecentProcess	ClusterUpgradeStatusUpgradeProcessStatus

1.11.5.7.19. StorageCollectionMethod

列挙値
UNSET_COLLECTION
NO_COLLECTION
KERNEL_MODULE
EBPF
CORE_BPF

1.11.5.7.20. StorageCollectorHealthInfo

フィールド名	型	説明	形式
version	String
totalDesiredPods	Integer		int32
totalReadyPods	Integer		int32
totalRegisteredNodes	Integer		int32
statusErrors	`string` のリスト	コレクターのヘルスの情報を取得しようとしたときに発生したエラーのコレクション。

1.11.5.7.21. StorageCompleteClusterConfig

静的および動的設定を含む ID/名前識別子を除いた完全なクラスター設定をエンコードします。

フィールド名	必須	Null 許容型	型	説明	形式
dynamicConfig			StorageDynamicClusterConfig
staticConfig			StorageStaticClusterConfig
configFingerprint			String
clusterLabels			`string` のマップ

1.11.5.7.22. StorageDynamicClusterConfig

フィールド名	必須	Null 許容型	型	説明	形式
admissionControllerConfig			StorageAdmissionControllerConfig
registryOverride			String
disableAuditLogs			Boolean

1.11.5.7.23. StorageGoogleProviderMetadata

フィールド名	必須	Null 許容型	型	説明	形式
project			String
clusterName			String	providerMetadata.cluster.name に置き換えられたため非推奨になりました。

1.11.5.7.24. StorageManagerType

列挙値
MANAGER_TYPE_UNKNOWN
MANAGER_TYPE_MANUAL
MANAGER_TYPE_HELM_CHART
MANAGER_TYPE_KUBERNETES_OPERATOR

1.11.5.7.25. StorageOrchestratorMetadata

フィールド名	型	形式
version	String
openshiftVersion	String
buildDate	Date	date-time
apiVersions	`string` のリスト

1.11.5.7.26. StorageProviderMetadata

フィールド名	必須	Null 許容型	型	説明	形式
region			String
zone			String
google			StorageGoogleProviderMetadata
aws			StorageAWSProviderMetadata
azure			StorageAzureProviderMetadata
verified			Boolean
cluster			StorageClusterMetadata

1.11.5.7.27. StorageScannerHealthInfo

フィールド名	型	説明	形式
totalDesiredAnalyzerPods	Integer		int32
totalReadyAnalyzerPods	Integer		int32
totalDesiredDbPods	Integer		int32
totalReadyDbPods	Integer		int32
statusErrors	`string` のリスト	スキャナーのヘルス情報を取得しようとしたときに発生したエラーのコレクション。

1.11.5.7.28. StorageSensorDeploymentIdentification

フィールド名	必須	Null 許容型	型	説明	形式
systemNamespaceId			String
defaultNamespaceId			String
appNamespace			String
appNamespaceId			String
appServiceaccountId			String
k8sNodeName			String

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

1.11.5.7.30. StorageTolerationsConfig

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

1.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, UPGRADE_ERROR_ROLLED_BACK, UPGRADE_ERROR_ROLLBACK_FAILED, UPGRADE_ERROR_UNKNOWN, UPGRADE_TIMED_OUT,
upgradeStatusDetail	String
since	Date	date-time

1.11.5.7.32. UpgradeProcessStatusUpgradeProcessType

UPGRADE: UPGRADE は sensor のバージョンのアップグレードを表します。
CERT_ROTATION: CERT_ROTATION は、クラスターで使用される TLS 証明書のみをローテーションし、他のものは変更しないアップグレードプロセスを表します。

列挙値
UPGRADE
CERT_ROTATION

1.11.5.7.33. UpgradeProgressUpgradeState

UPGRADER_LAUNCHING: 進行中の状態。
UPGRADE_COMPLETE: 成功状態。すべてに番号をつけて、これより上に IN-PROGRESS の状態を、これより下に ERROR 状態のアップグレードプロセスを指定します。
UPGRADE_INITIALIZATION_ERROR: エラーの状態。

列挙値
UPGRADE_INITIALIZING
UPGRADE_LAUNCHING
UPGRADER_LAUNCHED
PRE_FLIGHT_CHECKS_COMPLETE
UPGRADE_OPERATIONS_DONE
UPGRADE_COMPLETE
UPGRADE_INITIALIZATION_ERROR
PRE_FLIGHT_CHECKS_FAILED
UPGRADE_ERROR_ROLLING_BACK
UPGRADE_ERROR_ROLLED_BACK
UPGRADE_ERROR_ROLLBACK_FAILED
UPGRADE_ERROR_UNKNOWN
UPGRADE_TIMED_OUT

1.11.5.7.34. V1ClusterResponse

フィールド名	必須	Null 許容型	型	説明	形式
cluster			StorageCluster
clusterRetentionInfo			V1DecommissionedClusterRetentionInfo

1.11.5.7.35. V1DecommissionedClusterRetentionInfo

next available tag: 3

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

1.11.6. PutCluster

PUT /v1/clusters/{id}

1.11.6.1. 説明

1.11.6.2. パラメーター

1.11.6.2.1. パスパラメーター

名前	説明	必須	デフォルト	パターン
id		X	null

1.11.6.2.2. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	ClustersServicePutClusterBody	X

1.11.6.3. 戻り値のタイプ

V1ClusterResponse

1.11.6.4. コンテンツタイプ

application/json

1.11.6.5. レスポンス

表1.58 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ClusterResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.11.6.6. サンプル

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

1.11.6.7.1. ClusterHealthStatusHealthStatusLabel

UNAVAILABLE: ステータスに unavailable を指定できるのはコレクターのみです

列挙値
UNINITIALIZED
UNAVAILABLE
UNHEALTHY
DEGRADED
HEALTHY

1.11.6.7.2. ClusterUpgradeStatusUpgradability

SENSOR_VERSION_HIGHER: SENSOR_VERSION_HIGHER は、sensor がこの Central よりも新しいバージョンを実行していることが検出された場合に発生します。これは予期しないエラーですが、顧客が行うパッチによっては発生する可能性があります。この場合、自動アップグレード設定がオンであっても、ダウングレードになるため、sensor が自動的に "アップグレード" されることはありません。ユーザーは手動でアップグレードをトリガーできますが、この設定はサポートされていないため、最初に Central をアップグレードせずに手動でアップグレードすることは推奨されません。

列挙値
UNSET
UP_TO_DATE
MANUAL_UPGRADE_REQUIRED
AUTO_UPGRADE_POSSIBLE
SENSOR_VERSION_HIGHER

1.11.6.7.3. ClusterUpgradeStatusUpgradeProcessStatus

フィールド名	型	形式
active	Boolean
id	String
targetVersion	String
upgraderImage	String
initiatedAt	Date	date-time
progress	StorageUpgradeProgress
type	UpgradeProcessStatusUpgradeProcessType	UPGRADE, CERT_ROTATION,

1.11.6.7.4. ClustersServicePutClusterBody

フィールド名	型	説明	形式
name	String
type	StorageClusterType		GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,
labels	`string` のマップ
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	StorageAuditLogFileState のマップ	内部での使用のみ。
initBundleId	String
managedBy	StorageManagerType		MANAGER_TYPE_UNKNOWN, MANAGER_TYPE_MANUAL, MANAGER_TYPE_HELM_CHART, MANAGER_TYPE_KUBERNETES_OPERATOR,
sensorCapabilities	`string` のリスト

1.11.6.7.5. GooglerpcStatus

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

1.11.6.7.6. 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.11.6.7.6.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.11.6.7.7. StorageAWSProviderMetadata

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

1.11.6.7.8. StorageAdmissionControlHealthInfo

フィールド名	型	説明	形式
totalDesiredPods	Integer		int32
totalReadyPods	Integer		int32
statusErrors	`string` のリスト	アドミッションコントロールのヘルス情報を取得しようとしたときに発生したエラーのコレクション。

1.11.6.7.9. StorageAdmissionControllerConfig

フィールド名	型	形式
enabled	Boolean
timeoutSeconds	Integer	int32
scanInline	Boolean
disableBypass	Boolean
enforceOnUpdates	Boolean

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

1.11.6.7.11. StorageAzureProviderMetadata

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

1.11.6.7.12. StorageCluster

フィールド名	型	説明	形式
id	String
name	String
type	StorageClusterType		GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,
labels	`string` のマップ
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	StorageAuditLogFileState のマップ	内部での使用のみ。
initBundleId	String
managedBy	StorageManagerType		MANAGER_TYPE_UNKNOWN, MANAGER_TYPE_MANUAL, MANAGER_TYPE_HELM_CHART, MANAGER_TYPE_KUBERNETES_OPERATOR,
sensorCapabilities	`string` のリスト

1.11.6.7.13. StorageClusterCertExpiryStatus

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

1.11.6.7.14. 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	ヘルス機能を持たないセンサーの場合、gRPC 接続ポーリングが使用されます。それ以外の場合、このタイムスタンプは、メッセージ処理時に中央パイプラインによって更新されます。注記: この設定は、CRS ベースのクラスター登録中に特定の攻撃ベクトルから保護するために使用します。CRS を使用してクラスター A を登録し、その CRS が漏洩したとしても、攻撃者が CRS フローを再実行してクラスター A に発行された証明書とキーを入手できることがあってはなりません。対抗策として、last_contact フィールドが空である場合にのみ CRS フローの再実行を許可します。これは、正当なクラスター A のセンサーが CRS が発行したサービス証明書にまだ接続されていないことを示します。	date-time
healthInfoComplete	Boolean

1.11.6.7.15. StorageClusterMetadata

ClusterMetadata には、クラスターインフラストラクチャーに関するメタデータ情報が含まれます。

フィールド名	型	説明	形式
type	StorageClusterMetadataType		UNSPECIFIED, AKS, ARO, EKS, GKE, OCP, OSD, ROSA,
name	String	name は、クラウドプロバイダーに登録したクラスターの名前を表します。self managed OpenShift の場合、これは OpenShift インストーラーによって選択された名前です。
id	String	id は、クラウドプロバイダーに登録したクラスターの一意の ID を表します。すべてのクラスタータイプに id があるわけではありません。すべての OpenShift クラスターの場合、これは OCM に登録された Red Hat `cluster_id` です。

1.11.6.7.16. StorageClusterMetadataType

列挙値
UNSPECIFIED
AKS
ARO
EKS
GKE
OCP
OSD
ROSA

1.11.6.7.17. StorageClusterStatus

フィールド名	型	説明	形式
sensorVersion	String
DEPRECATEDLastContact	Date	このフィールドはリリース 49.0 以降で非推奨になりました。代わりに healthStatus.lastContact を使用してください。	date-time
providerMetadata	StorageProviderMetadata
orchestratorMetadata	StorageOrchestratorMetadata
upgradeStatus	StorageClusterUpgradeStatus
certExpiryStatus	StorageClusterCertExpiryStatus

1.11.6.7.18. StorageClusterType

列挙値
GENERIC_CLUSTER
KUBERNETES_CLUSTER
OPENSHIFT_CLUSTER
OPENSHIFT4_CLUSTER

1.11.6.7.19. StorageClusterUpgradeStatus

フィールド名	型	形式
upgradability	ClusterUpgradeStatusUpgradability	UNSET, UP_TO_DATE, MANUAL_UPGRADE_REQUIRED, AUTO_UPGRADE_POSSIBLE, SENSOR_VERSION_HIGHER,
upgradabilityStatusReason	String
mostRecentProcess	ClusterUpgradeStatusUpgradeProcessStatus

1.11.6.7.20. StorageCollectionMethod

列挙値
UNSET_COLLECTION
NO_COLLECTION
KERNEL_MODULE
EBPF
CORE_BPF

1.11.6.7.21. StorageCollectorHealthInfo

フィールド名	型	説明	形式
version	String
totalDesiredPods	Integer		int32
totalReadyPods	Integer		int32
totalRegisteredNodes	Integer		int32
statusErrors	`string` のリスト	コレクターのヘルスの情報を取得しようとしたときに発生したエラーのコレクション。

1.11.6.7.22. StorageCompleteClusterConfig

静的および動的設定を含む ID/名前識別子を除いた完全なクラスター設定をエンコードします。

フィールド名	必須	Null 許容型	型	説明	形式
dynamicConfig			StorageDynamicClusterConfig
staticConfig			StorageStaticClusterConfig
configFingerprint			String
clusterLabels			`string` のマップ

1.11.6.7.23. StorageDynamicClusterConfig

フィールド名	必須	Null 許容型	型	説明	形式
admissionControllerConfig			StorageAdmissionControllerConfig
registryOverride			String
disableAuditLogs			Boolean

1.11.6.7.24. StorageGoogleProviderMetadata

フィールド名	必須	Null 許容型	型	説明	形式
project			String
clusterName			String	providerMetadata.cluster.name に置き換えられたため非推奨になりました。

1.11.6.7.25. StorageManagerType

列挙値
MANAGER_TYPE_UNKNOWN
MANAGER_TYPE_MANUAL
MANAGER_TYPE_HELM_CHART
MANAGER_TYPE_KUBERNETES_OPERATOR

1.11.6.7.26. StorageOrchestratorMetadata

フィールド名	型	形式
version	String
openshiftVersion	String
buildDate	Date	date-time
apiVersions	`string` のリスト

1.11.6.7.27. StorageProviderMetadata

フィールド名	必須	Null 許容型	型	説明	形式
region			String
zone			String
google			StorageGoogleProviderMetadata
aws			StorageAWSProviderMetadata
azure			StorageAzureProviderMetadata
verified			Boolean
cluster			StorageClusterMetadata

1.11.6.7.28. StorageScannerHealthInfo

フィールド名	型	説明	形式
totalDesiredAnalyzerPods	Integer		int32
totalReadyAnalyzerPods	Integer		int32
totalDesiredDbPods	Integer		int32
totalReadyDbPods	Integer		int32
statusErrors	`string` のリスト	スキャナーのヘルス情報を取得しようとしたときに発生したエラーのコレクション。

1.11.6.7.29. StorageSensorDeploymentIdentification

フィールド名	必須	Null 許容型	型	説明	形式
systemNamespaceId			String
defaultNamespaceId			String
appNamespace			String
appNamespaceId			String
appServiceaccountId			String
k8sNodeName			String

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

1.11.6.7.31. StorageTolerationsConfig

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

1.11.6.7.32. 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, UPGRADE_ERROR_ROLLED_BACK, UPGRADE_ERROR_ROLLBACK_FAILED, UPGRADE_ERROR_UNKNOWN, UPGRADE_TIMED_OUT,
upgradeStatusDetail	String
since	Date	date-time

1.11.6.7.33. UpgradeProcessStatusUpgradeProcessType

UPGRADE: UPGRADE は sensor のバージョンのアップグレードを表します。
CERT_ROTATION: CERT_ROTATION は、クラスターで使用される TLS 証明書のみをローテーションし、他のものは変更しないアップグレードプロセスを表します。

列挙値
UPGRADE
CERT_ROTATION

1.11.6.7.34. UpgradeProgressUpgradeState

UPGRADER_LAUNCHING: 進行中の状態。
UPGRADE_COMPLETE: 成功状態。すべてに番号をつけて、これより上に IN-PROGRESS の状態を、これより下に ERROR 状態のアップグレードプロセスを指定します。
UPGRADE_INITIALIZATION_ERROR: エラーの状態。

列挙値
UPGRADE_INITIALIZING
UPGRADE_LAUNCHING
UPGRADER_LAUNCHED
PRE_FLIGHT_CHECKS_COMPLETE
UPGRADE_OPERATIONS_DONE
UPGRADE_COMPLETE
UPGRADE_INITIALIZATION_ERROR
PRE_FLIGHT_CHECKS_FAILED
UPGRADE_ERROR_ROLLING_BACK
UPGRADE_ERROR_ROLLED_BACK
UPGRADE_ERROR_ROLLBACK_FAILED
UPGRADE_ERROR_UNKNOWN
UPGRADE_TIMED_OUT

1.11.6.7.35. V1ClusterResponse

フィールド名	必須	Null 許容型	型	説明	形式
cluster			StorageCluster
clusterRetentionInfo			V1DecommissionedClusterRetentionInfo

1.11.6.7.36. V1DecommissionedClusterRetentionInfo

next available tag: 3

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

1.11.7. PostCluster

POST /v1/clusters

1.11.7.1. 説明

1.11.7.2. パラメーター

1.11.7.2.1. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	StorageCluster	X

1.11.7.3. 戻り値のタイプ

V1ClusterResponse

1.11.7.4. コンテンツタイプ

application/json

1.11.7.5. レスポンス

表1.59 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ClusterResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.11.7.6. サンプル

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

1.11.7.7.1. ClusterHealthStatusHealthStatusLabel

UNAVAILABLE: ステータスに unavailable を指定できるのはコレクターのみです

列挙値
UNINITIALIZED
UNAVAILABLE
UNHEALTHY
DEGRADED
HEALTHY

1.11.7.7.2. ClusterUpgradeStatusUpgradability

SENSOR_VERSION_HIGHER: SENSOR_VERSION_HIGHER は、sensor がこの Central よりも新しいバージョンを実行していることが検出された場合に発生します。これは予期しないエラーですが、顧客が行うパッチによっては発生する可能性があります。この場合、自動アップグレード設定がオンであっても、ダウングレードになるため、sensor が自動的に "アップグレード" されることはありません。ユーザーは手動でアップグレードをトリガーできますが、この設定はサポートされていないため、最初に Central をアップグレードせずに手動でアップグレードすることは推奨されません。

列挙値
UNSET
UP_TO_DATE
MANUAL_UPGRADE_REQUIRED
AUTO_UPGRADE_POSSIBLE
SENSOR_VERSION_HIGHER

1.11.7.7.3. ClusterUpgradeStatusUpgradeProcessStatus

フィールド名	型	形式
active	Boolean
id	String
targetVersion	String
upgraderImage	String
initiatedAt	Date	date-time
progress	StorageUpgradeProgress
type	UpgradeProcessStatusUpgradeProcessType	UPGRADE, CERT_ROTATION,

1.11.7.7.4. GooglerpcStatus

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

1.11.7.7.5. 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.11.7.7.5.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.11.7.7.6. StorageAWSProviderMetadata

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

1.11.7.7.7. StorageAdmissionControlHealthInfo

フィールド名	型	説明	形式
totalDesiredPods	Integer		int32
totalReadyPods	Integer		int32
statusErrors	`string` のリスト	アドミッションコントロールのヘルス情報を取得しようとしたときに発生したエラーのコレクション。

1.11.7.7.8. StorageAdmissionControllerConfig

フィールド名	型	形式
enabled	Boolean
timeoutSeconds	Integer	int32
scanInline	Boolean
disableBypass	Boolean
enforceOnUpdates	Boolean

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

1.11.7.7.10. StorageAzureProviderMetadata

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

1.11.7.7.11. StorageCluster

フィールド名	型	説明	形式
id	String
name	String
type	StorageClusterType		GENERIC_CLUSTER, KUBERNETES_CLUSTER, OPENSHIFT_CLUSTER, OPENSHIFT4_CLUSTER,
labels	`string` のマップ
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	StorageAuditLogFileState のマップ	内部での使用のみ。
initBundleId	String
managedBy	StorageManagerType		MANAGER_TYPE_UNKNOWN, MANAGER_TYPE_MANUAL, MANAGER_TYPE_HELM_CHART, MANAGER_TYPE_KUBERNETES_OPERATOR,
sensorCapabilities	`string` のリスト

1.11.7.7.12. StorageClusterCertExpiryStatus

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

1.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	ヘルス機能を持たないセンサーの場合、gRPC 接続ポーリングが使用されます。それ以外の場合、このタイムスタンプは、メッセージ処理時に中央パイプラインによって更新されます。注記: この設定は、CRS ベースのクラスター登録中に特定の攻撃ベクトルから保護するために使用します。CRS を使用してクラスター A を登録し、その CRS が漏洩したとしても、攻撃者が CRS フローを再実行してクラスター A に発行された証明書とキーを入手できることがあってはなりません。対抗策として、last_contact フィールドが空である場合にのみ CRS フローの再実行を許可します。これは、正当なクラスター A のセンサーが CRS が発行したサービス証明書にまだ接続されていないことを示します。	date-time
healthInfoComplete	Boolean

1.11.7.7.14. StorageClusterMetadata

ClusterMetadata には、クラスターインフラストラクチャーに関するメタデータ情報が含まれます。

フィールド名	型	説明	形式
type	StorageClusterMetadataType		UNSPECIFIED, AKS, ARO, EKS, GKE, OCP, OSD, ROSA,
name	String	name は、クラウドプロバイダーに登録したクラスターの名前を表します。self managed OpenShift の場合、これは OpenShift インストーラーによって選択された名前です。
id	String	id は、クラウドプロバイダーに登録したクラスターの一意の ID を表します。すべてのクラスタータイプに id があるわけではありません。すべての OpenShift クラスターの場合、これは OCM に登録された Red Hat `cluster_id` です。

1.11.7.7.15. StorageClusterMetadataType

列挙値
UNSPECIFIED
AKS
ARO
EKS
GKE
OCP
OSD
ROSA

1.11.7.7.16. StorageClusterStatus

フィールド名	型	説明	形式
sensorVersion	String
DEPRECATEDLastContact	Date	このフィールドはリリース 49.0 以降で非推奨になりました。代わりに healthStatus.lastContact を使用してください。	date-time
providerMetadata	StorageProviderMetadata
orchestratorMetadata	StorageOrchestratorMetadata
upgradeStatus	StorageClusterUpgradeStatus
certExpiryStatus	StorageClusterCertExpiryStatus

1.11.7.7.17. StorageClusterType

列挙値
GENERIC_CLUSTER
KUBERNETES_CLUSTER
OPENSHIFT_CLUSTER
OPENSHIFT4_CLUSTER

1.11.7.7.18. StorageClusterUpgradeStatus

フィールド名	型	形式
upgradability	ClusterUpgradeStatusUpgradability	UNSET, UP_TO_DATE, MANUAL_UPGRADE_REQUIRED, AUTO_UPGRADE_POSSIBLE, SENSOR_VERSION_HIGHER,
upgradabilityStatusReason	String
mostRecentProcess	ClusterUpgradeStatusUpgradeProcessStatus

1.11.7.7.19. StorageCollectionMethod

列挙値
UNSET_COLLECTION
NO_COLLECTION
KERNEL_MODULE
EBPF
CORE_BPF

1.11.7.7.20. StorageCollectorHealthInfo

フィールド名	型	説明	形式
version	String
totalDesiredPods	Integer		int32
totalReadyPods	Integer		int32
totalRegisteredNodes	Integer		int32
statusErrors	`string` のリスト	コレクターのヘルスの情報を取得しようとしたときに発生したエラーのコレクション。

1.11.7.7.21. StorageCompleteClusterConfig

静的および動的設定を含む ID/名前識別子を除いた完全なクラスター設定をエンコードします。

フィールド名	必須	Null 許容型	型	説明	形式
dynamicConfig			StorageDynamicClusterConfig
staticConfig			StorageStaticClusterConfig
configFingerprint			String
clusterLabels			`string` のマップ

1.11.7.7.22. StorageDynamicClusterConfig

フィールド名	必須	Null 許容型	型	説明	形式
admissionControllerConfig			StorageAdmissionControllerConfig
registryOverride			String
disableAuditLogs			Boolean

1.11.7.7.23. StorageGoogleProviderMetadata

フィールド名	必須	Null 許容型	型	説明	形式
project			String
clusterName			String	providerMetadata.cluster.name に置き換えられたため非推奨になりました。

1.11.7.7.24. StorageManagerType

列挙値
MANAGER_TYPE_UNKNOWN
MANAGER_TYPE_MANUAL
MANAGER_TYPE_HELM_CHART
MANAGER_TYPE_KUBERNETES_OPERATOR

1.11.7.7.25. StorageOrchestratorMetadata

フィールド名	型	形式
version	String
openshiftVersion	String
buildDate	Date	date-time
apiVersions	`string` のリスト

1.11.7.7.26. StorageProviderMetadata

フィールド名	必須	Null 許容型	型	説明	形式
region			String
zone			String
google			StorageGoogleProviderMetadata
aws			StorageAWSProviderMetadata
azure			StorageAzureProviderMetadata
verified			Boolean
cluster			StorageClusterMetadata

1.11.7.7.27. StorageScannerHealthInfo

フィールド名	型	説明	形式
totalDesiredAnalyzerPods	Integer		int32
totalReadyAnalyzerPods	Integer		int32
totalDesiredDbPods	Integer		int32
totalReadyDbPods	Integer		int32
statusErrors	`string` のリスト	スキャナーのヘルス情報を取得しようとしたときに発生したエラーのコレクション。

1.11.7.7.28. StorageSensorDeploymentIdentification

フィールド名	必須	Null 許容型	型	説明	形式
systemNamespaceId			String
defaultNamespaceId			String
appNamespace			String
appNamespaceId			String
appServiceaccountId			String
k8sNodeName			String

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

1.11.7.7.30. StorageTolerationsConfig

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

1.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, UPGRADE_ERROR_ROLLED_BACK, UPGRADE_ERROR_ROLLBACK_FAILED, UPGRADE_ERROR_UNKNOWN, UPGRADE_TIMED_OUT,
upgradeStatusDetail	String
since	Date	date-time

1.11.7.7.32. UpgradeProcessStatusUpgradeProcessType

UPGRADE: UPGRADE は sensor のバージョンのアップグレードを表します。
CERT_ROTATION: CERT_ROTATION は、クラスターで使用される TLS 証明書のみをローテーションし、他のものは変更しないアップグレードプロセスを表します。

列挙値
UPGRADE
CERT_ROTATION

1.11.7.7.33. UpgradeProgressUpgradeState

UPGRADER_LAUNCHING: 進行中の状態。
UPGRADE_COMPLETE: 成功状態。すべてに番号をつけて、これより上に IN-PROGRESS の状態を、これより下に ERROR 状態のアップグレードプロセスを指定します。
UPGRADE_INITIALIZATION_ERROR: エラーの状態。

列挙値
UPGRADE_INITIALIZING
UPGRADE_LAUNCHING
UPGRADER_LAUNCHED
PRE_FLIGHT_CHECKS_COMPLETE
UPGRADE_OPERATIONS_DONE
UPGRADE_COMPLETE
UPGRADE_INITIALIZATION_ERROR
PRE_FLIGHT_CHECKS_FAILED
UPGRADE_ERROR_ROLLING_BACK
UPGRADE_ERROR_ROLLED_BACK
UPGRADE_ERROR_ROLLBACK_FAILED
UPGRADE_ERROR_UNKNOWN
UPGRADE_TIMED_OUT

1.11.7.7.34. V1ClusterResponse

フィールド名	必須	Null 許容型	型	説明	形式
cluster			StorageCluster
clusterRetentionInfo			V1DecommissionedClusterRetentionInfo

1.11.7.7.35. V1DecommissionedClusterRetentionInfo

next available tag: 3

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

1.12. CollectionService

1.12.1. GetCollectionCount

GET /v1/collectionscount

1.12.1.1. 説明

1.12.1.2. パラメーター

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

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

1.12.1.3. 戻り値のタイプ

V1GetCollectionCountResponse

1.12.1.4. コンテンツタイプ

application/json

1.12.1.5. レスポンス

表1.60 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetCollectionCountResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.12.1.6. サンプル

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

1.12.1.7.1. GooglerpcStatus

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

1.12.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 {
  ...
}

1.12.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.12.1.7.3. V1GetCollectionCountResponse

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

1.12.2. DryRunCollection

POST /v1/collections/dryrun

1.12.2.1. 説明

1.12.2.2. パラメーター

1.12.2.2.1. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	V1DryRunCollectionRequest	X

1.12.2.3. 戻り値のタイプ

V1DryRunCollectionResponse

1.12.2.4. コンテンツタイプ

application/json

1.12.2.5. レスポンス

表1.61 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1DryRunCollectionResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.12.2.6. サンプル

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

1.12.2.7.1. GooglerpcStatus

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

1.12.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 {
  ...
}

1.12.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.12.2.7.3. StorageBooleanOperator

列挙値
OR
AND

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

1.12.2.7.5. StorageMatchType

列挙値
EXACT
REGEX

1.12.2.7.6. StorageResourceSelector

フィールド名	必須	Null 許容型	型	説明	形式
rules			StorageSelectorRule のリスト	`rules` は、接続詞 (AND) として解決されます。

1.12.2.7.7. StorageRuleValue

フィールド名	必須	Null 許容型	型	説明	形式
value			String
matchType			StorageMatchType		EXACT, REGEX,

1.12.2.7.8. StorageSelectorRule

フィールド名	型	説明	形式
fieldName	String
operator	StorageBooleanOperator		OR, AND,
values	StorageRuleValue のリスト	`values` は、演算子に応じて論理積 (AND) または論理和 (OR) として解決されます。MVP の場合、UX の観点から OR のみがサポートされます。

1.12.2.7.9. V1AggregateBy

フィールド名	必須	Null 許容型	型	説明	形式
aggrFunc			V1Aggregation		UNSET, COUNT, MIN, MAX,
distinct			Boolean

1.12.2.7.10. V1Aggregation

列挙値
UNSET
カウント
最小
最大

1.12.2.7.11. V1CollectionDeploymentMatchOptions

フィールド名	必須	Null 許容型	型	説明	形式
withMatches			Boolean
filterQuery			V1RawQuery

1.12.2.7.12. V1DryRunCollectionRequest

フィールド名	必須	Null 許容型	型	説明	形式
name			String
id			String
description			String
resourceSelectors			StorageResourceSelector のリスト
embeddedCollectionIds			`string` のリスト
options			V1CollectionDeploymentMatchOptions

1.12.2.7.13. V1DryRunCollectionResponse

フィールド名	必須	Null 許容型	型	説明	形式
デプロイメント			StorageListDeployment のリスト

1.12.2.7.14. V1Pagination

フィールド名	型	説明	形式
limit	Integer		int32
offset	Integer		int32
sortOption	V1SortOption
sortOptions	V1SortOption のリスト	このフィールドは開発中です。REST API ではサポートされていません。

1.12.2.7.15. V1RawQuery

RawQuery は検索クエリー文字列を表します。クエリー文字列の形式は、"<field name>:<value,value,…><field name>:<value, value,...>…" です。たとえば、"stackrox" という namespace で "central" および "sensor" という名前のデプロイメントを検索する場合、クエリー文字列は "Deployment:central,sensor+Namespace:stackrox" になります。RawQuery は、ListAPI で特定のオブジェクトを検索するために使用されます。

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

1.12.2.7.16. V1SortOption

フィールド名	必須	Null 許容型	型	説明	形式
field			String
reversed			Boolean
aggregateBy			V1AggregateBy

1.12.3. ListCollections

GET /v1/collections

1.12.3.1. 説明

1.12.3.2. パラメーター

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

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

1.12.3.3. 戻り値のタイプ

V1ListCollectionsResponse

1.12.3.4. コンテンツタイプ

application/json

1.12.3.5. レスポンス

表1.62 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListCollectionsResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.12.3.6. サンプル

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

1.12.3.7.1. GooglerpcStatus

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

1.12.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 {
  ...
}

1.12.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.12.3.7.3. ResourceCollectionEmbeddedResourceCollection

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

1.12.3.7.4. StorageBooleanOperator

列挙値
OR
AND

1.12.3.7.5. StorageMatchType

列挙値
EXACT
REGEX

1.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 の場合、UX の観点から、resource_selectors のサイズは最大 1 になります。
embeddedCollections	ResourceCollectionEmbeddedResourceCollection のリスト

1.12.3.7.7. StorageResourceSelector

フィールド名	必須	Null 許容型	型	説明	形式
rules			StorageSelectorRule のリスト	`rules` は、接続詞 (AND) として解決されます。

1.12.3.7.8. StorageRuleValue

フィールド名	必須	Null 許容型	型	説明	形式
value			String
matchType			StorageMatchType		EXACT, REGEX,

1.12.3.7.9. StorageSelectorRule

フィールド名	型	説明	形式
fieldName	String
operator	StorageBooleanOperator		OR, AND,
values	StorageRuleValue のリスト	`values` は、演算子に応じて論理積 (AND) または論理和 (OR) として解決されます。MVP の場合、UX の観点から OR のみがサポートされます。

1.12.3.7.10. StorageSlimUser

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

1.12.3.7.11. V1ListCollectionsResponse

フィールド名	必須	Null 許容型	型	説明	形式
コレクション			StorageResourceCollection のリスト

1.12.4. DeleteCollection

DELETE /v1/collections/{id}

1.12.4.1. 説明

1.12.4.2. パラメーター

1.12.4.2.1. パスパラメーター

名前	説明	必須	デフォルト	パターン
id		X	null

1.12.4.3. 戻り値のタイプ

Object

1.12.4.4. コンテンツタイプ

application/json

1.12.4.5. レスポンス

表1.63 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	`Object`
0	予期しないエラーの応答。	GooglerpcStatus

1.12.4.6. サンプル

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

1.12.4.7.1. GooglerpcStatus

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

1.12.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 {
  ...
}

1.12.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.12.5. GetCollection

GET /v1/collections/{id}

1.12.5.1. 説明

1.12.5.2. パラメーター

1.12.5.2.1. パスパラメーター

名前	説明	必須	デフォルト	パターン
id		X	null

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

1.12.5.3. 戻り値のタイプ

V1GetCollectionResponse

1.12.5.4. コンテンツタイプ

application/json

1.12.5.5. レスポンス

表1.64 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetCollectionResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.12.5.6. サンプル

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

1.12.5.7.1. GooglerpcStatus

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

1.12.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 {
  ...
}

1.12.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.12.5.7.3. ResourceCollectionEmbeddedResourceCollection

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

1.12.5.7.4. StorageBooleanOperator

列挙値
OR
AND

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

1.12.5.7.6. StorageMatchType

列挙値
EXACT
REGEX

1.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 の場合、UX の観点から、resource_selectors のサイズは最大 1 になります。
embeddedCollections	ResourceCollectionEmbeddedResourceCollection のリスト

1.12.5.7.8. StorageResourceSelector

フィールド名	必須	Null 許容型	型	説明	形式
rules			StorageSelectorRule のリスト	`rules` は、接続詞 (AND) として解決されます。

1.12.5.7.9. StorageRuleValue

フィールド名	必須	Null 許容型	型	説明	形式
value			String
matchType			StorageMatchType		EXACT, REGEX,

1.12.5.7.10. StorageSelectorRule

フィールド名	型	説明	形式
fieldName	String
operator	StorageBooleanOperator		OR, AND,
values	StorageRuleValue のリスト	`values` は、演算子に応じて論理積 (AND) または論理和 (OR) として解決されます。MVP の場合、UX の観点から OR のみがサポートされます。

1.12.5.7.11. StorageSlimUser

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

1.12.5.7.12. V1GetCollectionResponse

フィールド名	必須	Null 許容型	型	説明	形式
collection			StorageResourceCollection
デプロイメント			StorageListDeployment のリスト

1.12.6. UpdateCollection

PATCH /v1/collections/{id}

1.12.6.1. 説明

1.12.6.2. パラメーター

1.12.6.2.1. パスパラメーター

名前	説明	必須	デフォルト	パターン
id		X	null

1.12.6.2.2. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	CollectionServiceUpdateCollectionBody	X

1.12.6.3. 戻り値のタイプ

V1UpdateCollectionResponse

1.12.6.4. コンテンツタイプ

application/json

1.12.6.5. レスポンス

表1.65 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1UpdateCollectionResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.12.6.6. サンプル

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

1.12.6.7.1. CollectionServiceUpdateCollectionBody

フィールド名	必須	Null 許容型	型	説明	形式
name			String
description			String
resourceSelectors			StorageResourceSelector のリスト
embeddedCollectionIds			`string` のリスト

1.12.6.7.2. GooglerpcStatus

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

1.12.6.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 {
  ...
}

1.12.6.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.12.6.7.4. ResourceCollectionEmbeddedResourceCollection

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

1.12.6.7.5. StorageBooleanOperator

列挙値
OR
AND

1.12.6.7.6. StorageMatchType

列挙値
EXACT
REGEX

1.12.6.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 の場合、UX の観点から、resource_selectors のサイズは最大 1 になります。
embeddedCollections	ResourceCollectionEmbeddedResourceCollection のリスト

1.12.6.7.8. StorageResourceSelector

フィールド名	必須	Null 許容型	型	説明	形式
rules			StorageSelectorRule のリスト	`rules` は、接続詞 (AND) として解決されます。

1.12.6.7.9. StorageRuleValue

フィールド名	必須	Null 許容型	型	説明	形式
value			String
matchType			StorageMatchType		EXACT, REGEX,

1.12.6.7.10. StorageSelectorRule

フィールド名	型	説明	形式
fieldName	String
operator	StorageBooleanOperator		OR, AND,
values	StorageRuleValue のリスト	`values` は、演算子に応じて論理積 (AND) または論理和 (OR) として解決されます。MVP の場合、UX の観点から OR のみがサポートされます。

1.12.6.7.11. StorageSlimUser

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

1.12.6.7.12. V1UpdateCollectionResponse

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

1.12.7. CreateCollection

POST /v1/collections

1.12.7.1. 説明

1.12.7.2. パラメーター

1.12.7.2.1. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	V1CreateCollectionRequest	X

1.12.7.3. 戻り値のタイプ

V1CreateCollectionResponse

1.12.7.4. コンテンツタイプ

application/json

1.12.7.5. レスポンス

表1.66 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1CreateCollectionResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.12.7.6. サンプル

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

1.12.7.7.1. GooglerpcStatus

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

1.12.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 {
  ...
}

1.12.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.12.7.7.3. ResourceCollectionEmbeddedResourceCollection

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

1.12.7.7.4. StorageBooleanOperator

列挙値
OR
AND

1.12.7.7.5. StorageMatchType

列挙値
EXACT
REGEX

1.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 の場合、UX の観点から、resource_selectors のサイズは最大 1 になります。
embeddedCollections	ResourceCollectionEmbeddedResourceCollection のリスト

1.12.7.7.7. StorageResourceSelector

フィールド名	必須	Null 許容型	型	説明	形式
rules			StorageSelectorRule のリスト	`rules` は、接続詞 (AND) として解決されます。

1.12.7.7.8. StorageRuleValue

フィールド名	必須	Null 許容型	型	説明	形式
value			String
matchType			StorageMatchType		EXACT, REGEX,

1.12.7.7.9. StorageSelectorRule

フィールド名	型	説明	形式
fieldName	String
operator	StorageBooleanOperator		OR, AND,
values	StorageRuleValue のリスト	`values` は、演算子に応じて論理積 (AND) または論理和 (OR) として解決されます。MVP の場合、UX の観点から OR のみがサポートされます。

1.12.7.7.10. StorageSlimUser

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

1.12.7.7.11. V1CreateCollectionRequest

フィールド名	必須	Null 許容型	型	説明	形式
name			String
description			String
resourceSelectors			StorageResourceSelector のリスト
embeddedCollectionIds			`string` のリスト

1.12.7.7.12. V1CreateCollectionResponse

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

1.12.8. ListCollectionSelectors

GET /v1/collections/selectors

1.12.8.1. 説明

1.12.8.2. パラメーター

1.12.8.3. 戻り値のタイプ

V1ListCollectionSelectorsResponse

1.12.8.4. コンテンツタイプ

application/json

1.12.8.5. レスポンス

表1.67 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1ListCollectionSelectorsResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.12.8.6. サンプル

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

1.12.8.7.1. GooglerpcStatus

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

1.12.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 {
  ...
}

1.12.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.12.8.7.3. V1ListCollectionSelectorsResponse

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

1.13. ComplianceManagementService

1.13.1. GetRecentRuns

GET /v1/complianceManagement/runs

1.13.1.1. 説明

1.13.1.2. パラメーター

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

名前	必須	デフォルト
clusterId	-	null
standardId	-	null
since	-	null

1.13.1.3. 戻り値のタイプ

V1GetRecentComplianceRunsResponse

1.13.1.4. コンテンツタイプ

application/json

1.13.1.5. レスポンス

表1.68 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetRecentComplianceRunsResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.13.1.6. サンプル

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

1.13.1.7.1. GooglerpcStatus

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

1.13.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 {
  ...
}

1.13.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

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

1.13.1.7.4. V1ComplianceRunState

列挙値
INVALID
READY
STARTED
WAIT_FOR_DATA
EMVALUTING_CHECKS
FINISHED

1.13.1.7.5. V1GetRecentComplianceRunsResponse

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

1.13.2. TriggerRuns

POST /v1/compliancemanagement/runs

1.13.2.1. 説明

1.13.2.2. パラメーター

1.13.2.2.1. 本文パラメーター

名前	説明	必須	デフォルト	パターン
body	V1TriggerComplianceRunsRequest	X

1.13.2.3. 戻り値のタイプ

V1TriggerComplianceRunsResponse

1.13.2.4. コンテンツタイプ

application/json

1.13.2.5. レスポンス

表1.69 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1TriggerComplianceRunsResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.13.2.6. サンプル

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

1.13.2.7.1. GooglerpcStatus

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

1.13.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 {
  ...
}

1.13.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

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

1.13.2.7.4. V1ComplianceRunSelection

フィールド名	必須	Null 許容型	型	説明	形式
clusterId			String	クラスターの ID。\"*\" は \"all clusters\" を意味します。
standardId			String	コンプライアンス標準の ID。\"*\" は \"all standards\" を意味します。

1.13.2.7.5. V1ComplianceRunState

列挙値
INVALID
READY
STARTED
WAIT_FOR_DATA
EMVALUTING_CHECKS
FINISHED

1.13.2.7.6. V1TriggerComplianceRunsRequest

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

1.13.2.7.7. V1TriggerComplianceRunsResponse

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

1.13.3. GetRunStatuses

GET /v1/compliancemanagement/runstatuses

1.13.3.1. 説明

1.13.3.2. パラメーター

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

名前	説明	必須	デフォルト	パターン
runIds	`String`	-	null
latest		-	null

1.13.3.3. 戻り値のタイプ

V1GetComplianceRunStatusesResponse

1.13.3.4. コンテンツタイプ

application/json

1.13.3.5. レスポンス

表1.70 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetComplianceRunStatusesResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.13.3.6. サンプル

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

1.13.3.7.1. GooglerpcStatus

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

1.13.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 {
  ...
}

1.13.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

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

1.13.3.7.4. V1ComplianceRunState

列挙値
INVALID
READY
STARTED
WAIT_FOR_DATA
EMVALUTING_CHECKS
FINISHED

1.13.3.7.5. V1GetComplianceRunStatusesResponse

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

1.14. ComplianceService

1.14.1. GetAggregatedResults

GET /v1/compliance/aggregatedresults

1.14.1.1. 説明

1.14.1.2. パラメーター

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

1.14.1.3. 戻り値のタイプ

StorageComplianceAggregationResponse

1.14.1.4. コンテンツタイプ

application/json

1.14.1.5. レスポンス

表1.71 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	StorageComplianceAggregationResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.14.1.6. サンプル

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

1.14.1.7.1. ComplianceAggregationAggregationKey

Next available tag: 3

フィールド名	必須	Null 許容型	型	説明	形式
scope			StorageComplianceAggregationScope		UNKNOWN, STANDARD, CLUSTER, CATEGORY, CONTROL, NAMESPACE, NODE, DEPLOYMENT, CHECK,
id			String

1.14.1.7.2. GooglerpcStatus

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

1.14.1.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 {
  ...
}

1.14.1.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 許容型	型	説明	形式
@type			String	シリアル化されたプロトコルバッファーメッセージの型を一意に識別する URL/リソース名。この文字列には少なくとも \"/\" 文字が 1 つ以上含まれている必要があります。URL のパスの最後のセグメントは、型の完全修飾名を表す必要があります (例: `path/google.protobuf.Duration`)。名前は正規の形式にする必要があります (たとえば、先頭に ".\" を使用できません)。実際には、チームは通常、Any のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、`http`、`https` のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、`https` が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。`http`、`https` 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

1.14.1.7.4. StorageComplianceAggregationResponse

Next available tag: 3

フィールド名	必須	Null 許容型	型	説明	形式
results			StorageComplianceAggregationResult のリスト
sources			StorageComplianceAggregationSource のリスト
errorMessage			String

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

1.14.1.7.6. StorageComplianceAggregationScope

列挙値
UNKNOWN
STANDARD
CLUSTER
CATEGORY
CONTROL
NAMESPACE
NODE
DEPLOYMENT
CHECK

1.14.1.7.7. StorageComplianceAggregationSource

Next available tag: 5

フィールド名	必須	Null 許容型	型	説明	形式
clusterId			String
standardId			String
successfulRun			StorageComplianceRunMetadata
failedRuns			StorageComplianceRunMetadata のリスト

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

1.14.2. GetRunResults

GET /v1/compliance/runresults

1.14.2.1. 説明

1.14.2.2. パラメーター

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

名前	説明	必須	デフォルト
clusterId		-	null
standardId		-	null
runId	結果を返す実行 ID を指定します。空の場合は、最新の実行が返されます。注意: このフィールドを設定すると、サーバー側の結果キャッシュが回避され、メモリー負荷が大幅に増加し、パフォーマンスが低下する可能性があります。	-	null

1.14.2.3. 戻り値のタイプ

V1GetComplianceRunResultsResponse

1.14.2.4. コンテンツタイプ

application/json

1.14.2.5. レスポンス

表1.72 HTTP レスポンスコード
コード	メッセージ	データ型
200	正常な応答。	V1GetComplianceRunResultsResponse
0	予期しないエラーの応答。	GooglerpcStatus

1.14.2.6. サンプル

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

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

1.14.2.7.2. ComplianceRunResultsEntityResults

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

1.14.2.7.3. GooglerpcStatus

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

API リファレンス

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

第1章 バージョン v1

1.1. AdministrationEventService

1.1.1. ListAdministrationEvents

1.1.1.1. 説明

1.1.1.2. パラメーター

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

1.1.1.3. 戻り値のタイプ

1.1.1.4. コンテンツタイプ

1.1.1.5. レスポンス

1.1.1.6. サンプル

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

1.1.1.7.1. GooglerpcStatus

1.1.1.7.2. ProtobufAny

1.1.1.7.2.1. JSON 表現

1.1.1.7.3. V1AdministrationEvent

1.1.1.7.4. V1AdministrationEventLevel

1.1.1.7.5. V1AdministrationEventResource

1.1.1.7.6. V1AdministrationEventType

1.1.1.7.7. V1ListAdministrationEventsResponse

1.1.2. GetAdministrationEvent

1.1.2.1. 説明

1.1.2.2. パラメーター

1.1.2.2.1. パスパラメーター

1.1.2.3. 戻り値のタイプ

1.1.2.4. コンテンツタイプ

1.1.2.5. レスポンス

1.1.2.6. サンプル

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

1.1.2.7.1. GooglerpcStatus

1.1.2.7.2. ProtobufAny

1.1.2.7.2.1. JSON 表現

1.1.2.7.3. V1AdministrationEvent

1.1.2.7.4. V1AdministrationEventLevel

1.1.2.7.5. V1AdministrationEventResource

1.1.2.7.6. V1AdministrationEventType

1.1.2.7.7. V1GetAdministrationEventResponse

1.1.3. CountAdministrationEvents

1.1.3.1. 説明

1.1.3.2. パラメーター

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

1.1.3.3. 戻り値のタイプ

1.1.3.4. コンテンツタイプ

1.1.3.5. レスポンス

1.1.3.6. サンプル

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

1.1.3.7.1. GooglerpcStatus

1.1.3.7.2. ProtobufAny

1.1.3.7.2.1. JSON 表現

1.1.3.7.3. V1CountAdministrationEventsResponse

1.2. AdministrationUsageService

1.2.1. GetCurrentSecuredUnitsUsage

1.2.1.1. 説明

1.2.1.2. パラメーター

1.2.1.3. 戻り値のタイプ

1.2.1.4. コンテンツタイプ

1.2.1.5. レスポンス

1.2.1.6. サンプル

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

1.2.1.7.1. GooglerpcStatus

1.2.1.7.2. ProtobufAny

1.2.1.7.2.1. JSON 表現

1.2.1.7.3. V1SecuredUnitsUsageResponse

1.2.2. GetMaxSecuredUnitsUsage

1.2.2.1. 説明

1.2.2.2. パラメーター

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

1.2.2.3. 戻り値のタイプ

1.2.2.4. コンテンツタイプ

1.2.2.5. レスポンス

1.2.2.6. サンプル

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

1.2.2.7.1. GooglerpcStatus

1.2.2.7.2. ProtobufAny

1.2.2.7.2.1. JSON 表現

1.2.2.7.3. V1MaxSecuredUnitsUsageResponse

1.3. AlertService

1.3.1. CountAlerts

1.3.1.1. 説明

第1章バージョン v1