第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
フィールド名必須Null 許容型説明形式

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 のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、httphttps のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、https が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。httphttps 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

 
1.1.1.7.3. V1AdministrationEvent

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

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

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

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

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

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
フィールド名必須Null 許容型説明形式

code

  

Integer

 

int32

message

  

String

  

details

  

ProtobufAny のリスト

  
1.1.2.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.2.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 のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、httphttps のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、https が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。httphttps 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

 
1.1.2.7.3. V1AdministrationEvent

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

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

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

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

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

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
フィールド名必須Null 許容型説明形式

code

  

Integer

 

int32

message

  

String

  

details

  

ProtobufAny のリスト

  
1.1.3.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.3.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 のコンテキストで使用される可能性があるすべての型を、事前にバイナリー形式でコンパイルします。ただし、httphttps のスキームを使用する URL、またはスキームなしの URL の場合は、次のように型 URL をメッセージ定義にマップする型サーバーをオプションで設定できます。* スキームが指定されていない場合は、https が想定されます。* URL に対する HTTP GET はバイナリー形式の [google.protobuf.Type][] 値を生成する必要があります。そうでない場合はエラーが発生します。* アプリケーションは、URL に基づいて検索結果をキャッシュしたり、検索結果をバイナリーに事前にコンパイルして検索を回避したりできます。したがって、型の変更時にバイナリー互換性を維持する必要があります。(重大な変更を管理するには、バージョン管理された型名を使用します。)注記: この機能は現在、公式の protobuf リリースでは利用できません。また、type.googleapis.com で始まる型 URL では使用されません。2023 年 5 月現在、広く使用されているタイプサーバーの実装はなく、実装する予定もありません。httphttps 以外のスキーム (または空のスキーム) は、実装固有のセマンティクスで使用される場合があります。

 
1.1.3.7.3. V1CountAdministrationEventsResponse
フィールド名必須Null 許容型説明形式

count

  

Integer

フィルタリングと重複排除後のイベントの合計数。

int32

トップに戻る
Red Hat logoGithubredditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

Red Hat ドキュメントについて

Red Hat をお使いのお客様が、信頼できるコンテンツが含まれている製品やサービスを活用することで、イノベーションを行い、目標を達成できるようにします。 最新の更新を見る.

多様性を受け入れるオープンソースの強化

Red Hat では、コード、ドキュメント、Web プロパティーにおける配慮に欠ける用語の置き換えに取り組んでいます。このような変更は、段階的に実施される予定です。詳細情報: Red Hat ブログ.

会社概要

Red Hat は、企業がコアとなるデータセンターからネットワークエッジに至るまで、各種プラットフォームや環境全体で作業を簡素化できるように、強化されたソリューションを提供しています。

Theme

© 2025 Red Hat, Inc.