メタデータ API

OpenShift Container Platform 4.17

メタデータ API のリファレンスガイド

Red Hat OpenShift Documentation Team

法律上の通知

概要

このドキュメントでは、OpenShift Container Platform メタデータ API オブジェクトとその詳細な仕様を説明します。

第1章メタデータ API

1.1. APIRequestCount [apiserver.openshift.io/v1]

説明: APIRequestCount は、API に対して行われたリクエストを追跡します。インスタンス名は、リソース と一致する resource.version.group の形式である必要があります。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。
型: object

1.2. バインディング [v1]

説明: バインディングは、あるオブジェクトを別のオブジェクトに結び付けます。たとえば、Pod はスケジューラーによってノードにバインドされます。1.7 で非推奨になりました。代わりに、Pod のバインディングサブリソースを使用してください。
型: object

1.3. ComponentStatus [v1]

説明: ComponentStatus (および ComponentStatusList) は、クラスター検証情報を保持します。非推奨: この API は v1.19+ で非推奨となりました。
型: object

1.4. ConfigMap [v1]

説明: ConfigMap は、Pod が使用する設定データを保持します。
型: object

1.5. ControllerRevision [apps/v1]

説明: ControllerRevision は、状態データの不変のスナップショットを実装します。クライアントは、内部状態を含むオブジェクトをシリアル化および逆シリアル化する責任があります。ControllerRevision が正常に作成されると、更新できなくなります。API サーバーは、データフィールドを変更しようとするすべてのリクエストの検証に失敗します。ただし、ControllerRevisions は削除される場合があります。DaemonSet コントローラーと StatefulSet コントローラーの両方で更新とロールバックに使用されるため、このオブジェクトはベータ版であることに注意してください。ただし、将来のリリースで名前と表現が変更される可能性があるため、クライアントはその安定性に依存しないでください。これは主にコントローラーによる内部使用のためのものです。
型: object

1.6. イベント [events.k8s.io/v1]

説明: イベントは、クラスター内のどこかにあるイベントのレポートです。これは通常、システムの状態変化を示します。イベントの保持時間は限られており、トリガーとメッセージは時間とともに進化する可能性があります。イベントの利用者は、一貫した根本的なトリガーを反映する特定の理由を持つイベントのタイミング、またはその理由を持つイベントの継続的な存在に依存するべきではありません。イベントは、有益で、最善を尽くした、補足的なデータとして扱う必要があります。
型: object

1.7. Event [v1]

説明: イベントは、クラスター内のどこかにあるイベントのレポートです。イベントの保持時間は限られており、トリガーとメッセージは時間とともに進化する可能性があります。イベントの利用者は、一貫した根本的なトリガーを反映する特定の理由を持つイベントのタイミング、またはその理由を持つイベントの継続的な存在に依存するべきではありません。イベントは、有益で、最善を尽くした、補足的なデータとして扱う必要があります。
型: object

1.8. リース [coordination.k8s.io/v1]

説明: リースは、リースの概念を定義します。
型: object

1.9. Namespace [v1]

説明: 名前空間は、名前のスコープを提供します。複数の名前空間の使用はオプションです。
型: object

第2章 APIRequestCount [apiserver.openshift.io/v1]

説明

APIRequestCount は、API に対して行われたリクエストを追跡します。インスタンス名は、リソース と一致する resource.version.group の形式である必要があります。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。

型

object

必須

spec

2.1. 仕様

プロパティー	型	説明
`apiVersion`	`string`	APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。
`kind`	`string`	kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これを更新することはできません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。
`metadata`	`ObjectMeta`	標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。
`spec`	`object`	spec は、リソースの特性を定義します。
`status`	`object`	status には、リソースの監視された状態が含まれます。

2.1.1. .spec

説明: spec は、リソースの特性を定義します。
型: object

プロパティー	型	説明
`numberOfUsersToReport`	`integer`	numberOfUsersToReport は、レポートに含めるユーザーの数です。指定されていないかゼロの場合、デフォルトは 10 です。これはデフォルトであり、変更される可能性があります。

2.1.2. .status

説明: status には、リソースの監視された状態が含まれます。
型: object

プロパティー	型	説明
`conditions`	`array`	条件には、この API リソースの現在のステータスの詳細が含まれています。
`conditions[]`	`object`	条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition `json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions"` // other fields } とに入力します。
`currentHour`	`object`	currentHour には、現在の時間のリクエスト履歴が含まれます。これは、問題に対処したかどうかを確認する人間が API を読みやすくするための磁器です。このフィールドは正時にリセットされます。
`last24h`	`array`	last24h には、過去 24 時間のリクエスト履歴が含まれ、時間でインデックスが付けられます。したがって、12:00 AM〜12:59 はインデックス 0、6 am〜6:59am はインデックス 6 などになります。現在の時間のインデックスはライブで更新され、requestsLastHour フィールドに複製されます。
`last24h[]`	`object`	PerResourceAPIRequestLog は、さまざまなノードの要求をログに記録します。
`removedInRelease`	`string`	removedInRelease は、API が削除される時期です。
`requestCount`	`integer`	requestCount は、現在のすべての時間、ノード、およびユーザーにわたるすべての requestCount の合計です。

2.1.3. .status.conditions

説明: 条件には、この API リソースの現在のステータスの詳細が含まれています。
型: array

2.1.4. .status.conditions[]

説明

条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。たとえば、次のように入力します。FooStatus struct{ // Represents the observations of a foo’s current state. // Known .status.conditions.type are: "Available", "Progressing", and "Degraded" // +patchMergeKey=type // +patchStrategy=merge // +listType=map // +listMapKey=type Conditions []metav1.Condition json:"conditions,omitempty" patchStrategy:"merge" patchMergeKey:"type" protobuf:"bytes,1,rep,name=conditions" // other fields }

型

object

必須

lastTransitionTime
message
reason
status
type

プロパティー	型	説明
`lastTransitionTime`	`string`	lastTransitionTime は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。
`message`	`string`	message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。
`observedGeneration`	`integer`	observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。
`reason`	`string`	reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。
`status`	`string`	条件のステータス、True、False、Unknown のいずれか。
`type`	`string`	CamelCase または foo.example.com/CamelCase の条件のタイプ。--- 多くの.condition.type 値は、Available などのリソース全体で一貫していますが、任意の条件が役立つ可能性があるため (.node.status.conditions を参照)、競合を解消する機能が重要です。一致する正規表現は (dns1123SubdomainFmt/)?(qualifiedNameFmt) です。

2.1.5. .status.currentHour

説明: currentHour には、現在の時間のリクエスト履歴が含まれます。これは、問題に対処したかどうかを確認する人間が API を読みやすくするための磁器です。このフィールドは正時にリセットされます。
型: object

プロパティー	型	説明
`byNode`	`array`	byNode には、ノードごとのリクエストのログが含まれています。
`byNode[]`	`object`	PerNodeAPIRequestLog には、特定のノードへの要求のログが含まれています。
`requestCount`	`integer`	requestCount は、ノード全体のすべての requestCount の合計です。

2.1.6. .status.currentHour.byNode

説明: byNode には、ノードごとのリクエストのログが含まれています。
型: array

2.1.7. .status.currentHour.byNode[]

説明: PerNodeAPIRequestLog には、特定のノードへの要求のログが含まれています。
型: object

プロパティー	型	説明
`byUser`	`array`	byUser には、上位の.spec.numberOfUsersToReport ユーザーによるリクエストの詳細が含まれています。apiserver の場合、トップユーザーのリストを再起動することはベストエフォートベースで決定されるため、リストが不正確になる可能性があることに注意してください。さらに、一部のシステムユーザーがリストに明示的に含まれている場合があります。
`byUser[]`	`object`	PerUserAPIRequestCount には、ユーザーのリクエストのログが含まれます。
`nodeName`	`string`	リクエストが処理されている nodeName。
`requestCount`	`integer`	requestCount は、上位 10 人のユーザー以外のユーザーも含め、すべてのユーザーのすべての requestCount の合計です。

2.1.8. .status.currentHour.byNode[].byUser

説明: byUser には、上位の.spec.numberOfUsersToReport ユーザーによるリクエストの詳細が含まれています。apiserver の場合、トップユーザーのリストを再起動することはベストエフォートベースで決定されるため、リストが不正確になる可能性があることに注意してください。さらに、一部のシステムユーザーがリストに明示的に含まれている場合があります。
型: array

2.1.9. .status.currentHour.byNode[].byUser[]

説明: PerUserAPIRequestCount には、ユーザーのリクエストのログが含まれます。
型: object

プロパティー	型	説明
`byVerb`	`array`	byVerb 動詞ごとの詳細。
`byVerb[]`	`object`	API リクエスト動詞による PerVerbAPIRequestCount requestCounts 要求。
`requestCount`	`integer`	requestCount すべての動詞にわたるユーザーによる要求の数。
`userAgent`	`string`	リクエストを行った userAgent。同じユーザーが、接続する複数のバイナリー (多くのコンテナーを持つ Pod) を持っていることがよくあります。バイナリーが異なれば、userAgent も異なりますが、ユーザーは同じです。さらに、バージョン情報が埋め込まれた userAgent があり、userName が変更される可能性はほとんどありません。
`username`	`string`	リクエストを行った userName。

2.1.10. .status.currentHour.byNode[].byUser[].byVerb

説明: byVerb 動詞ごとの詳細。
型: array

2.1.11. .status.currentHour.byNode[].byUser[].byVerb[]

説明: API リクエスト動詞による PerVerbAPIRequestCount requestCounts 要求。
型: object

プロパティー	型	説明
`requestCount`	`integer`	requestCount 動詞のリクエストの数。
`verb`	`string`	API リクエストの動詞 (get、list、create など…)

2.1.12. .status.last24h

説明: last24h には、過去 24 時間のリクエスト履歴が含まれ、時間でインデックスが付けられます。したがって、12:00 AM〜12:59 はインデックス 0、6 am〜6:59am はインデックス 6 などになります。現在の時間のインデックスはライブで更新され、requestsLastHour フィールドに複製されます。
型: array

2.1.13. .status.last24h[]

説明: PerResourceAPIRequestLog は、さまざまなノードの要求をログに記録します。
型: object

プロパティー	型	説明
`byNode`	`array`	byNode には、ノードごとのリクエストのログが含まれています。
`byNode[]`	`object`	PerNodeAPIRequestLog には、特定のノードへの要求のログが含まれています。
`requestCount`	`integer`	requestCount は、ノード全体のすべての requestCount の合計です。

2.1.14. .status.last24h[].byNode

説明: byNode には、ノードごとのリクエストのログが含まれています。
型: array

2.1.15. .status.last24h[].byNode[]

説明: PerNodeAPIRequestLog には、特定のノードへの要求のログが含まれています。
型: object

プロパティー	型	説明
`byUser`	`array`	byUser には、上位の.spec.numberOfUsersToReport ユーザーによるリクエストの詳細が含まれています。apiserver の場合、トップユーザーのリストを再起動することはベストエフォートベースで決定されるため、リストが不正確になる可能性があることに注意してください。さらに、一部のシステムユーザーがリストに明示的に含まれている場合があります。
`byUser[]`	`object`	PerUserAPIRequestCount には、ユーザーのリクエストのログが含まれます。
`nodeName`	`string`	リクエストが処理されている nodeName。
`requestCount`	`integer`	requestCount は、上位 10 人のユーザー以外のユーザーも含め、すべてのユーザーのすべての requestCount の合計です。

2.1.16. .status.last24h[].byNode[].byUser

説明: byUser には、上位の.spec.numberOfUsersToReport ユーザーによるリクエストの詳細が含まれています。apiserver の場合、トップユーザーのリストを再起動することはベストエフォートベースで決定されるため、リストが不正確になる可能性があることに注意してください。さらに、一部のシステムユーザーがリストに明示的に含まれている場合があります。
型: array

2.1.17. .status.last24h[].byNode[].byUser[]

説明: PerUserAPIRequestCount には、ユーザーのリクエストのログが含まれます。
型: object

プロパティー	型	説明
`byVerb`	`array`	byVerb 動詞ごとの詳細。
`byVerb[]`	`object`	API リクエスト動詞による PerVerbAPIRequestCount requestCounts 要求。
`requestCount`	`integer`	requestCount すべての動詞にわたるユーザーによる要求の数。
`userAgent`	`string`	リクエストを行った userAgent。同じユーザーが、接続する複数のバイナリー (多くのコンテナーを持つ Pod) を持っていることがよくあります。バイナリーが異なれば、userAgent も異なりますが、ユーザーは同じです。さらに、バージョン情報が埋め込まれた userAgent があり、userName が変更される可能性はほとんどありません。
`username`	`string`	リクエストを行った userName。

2.1.18. .status.last24h[].byNode[].byUser[].byVerb

説明: byVerb 動詞ごとの詳細。
型: array

2.1.19. .status.last24h[].byNode[].byUser[].byVerb[]

説明: API リクエスト動詞による PerVerbAPIRequestCount requestCounts 要求。
型: object

プロパティー	型	説明
`requestCount`	`integer`	requestCount 動詞のリクエストの数。
`verb`	`string`	API リクエストの動詞 (get、list、create など…)

2.2. API エンドポイント

以下の API エンドポイントを利用できます。

/apis/apiserver.openshift.io/v1/apirequestcounts
- DELETE:APIRequestCount のコレクションを削除します
- GET: 種類 APIRequestCount のオブジェクトをリスト表示します
- POST:APIRequestCount を作成します
/apis/apiserver.openshift.io/v1/apirequestcounts/{name}
- 削除:APIRequestCount を削除します
- GET: 指定された APIRequestCount を読み取ります
- PATCH: 指定された APIRequestCount を部分的に更新します
- PUT: 指定された APIRequestCount を置き換えます
/apis/apiserver.openshift.io/v1/apirequestcounts/{name}/status
- GET: 指定された APIRequestCount のステータスを読み取ります
- PATCH: 指定された APIRequestCount のステータスを部分的に更新します
- PUT: 指定された APIRequestCount のステータスを置き換えます

2.2.1. /apis/apiserver.openshift.io/v1/apirequestcounts

HTTP メソッド: DELETE
説明: APIRequestCount のコレクションを削除します

表2.1 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Status` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: APIRequestCount の種類のオブジェクトをリスト表示します

表2.2 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`APIRequestCountList` schema
401 - Unauthorized	空白

HTTP メソッド: POST
説明: APIRequestCount を作成します

表2.3 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表2.4 ボディのパラメーター
パラメーター	型	説明
`body`	`APIRequestCount` スキーマ

表2.5 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`APIRequestCount` スキーマ
201 - Created	`APIRequestCount` スキーマ
202 - Accepted	`APIRequestCount` スキーマ
401 - Unauthorized	空白

2.2.2. /apis/apiserver.openshift.io/v1/apirequestcounts/{name}

表2.6 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	APIRequestCount の名前

HTTP メソッド: DELETE
説明: APIRequestCount を削除します

表2.7 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表2.8 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Status` スキーマ
202 - Accepted	`Status` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: 指定された APIRequestCount を読み取ります

表2.9 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`APIRequestCount` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PATCH
説明: 指定された APIRequestCount を部分的に更新します

表2.10 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表2.11 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`APIRequestCount` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PUT
説明: 指定された APIRequestCount を置き換えます

表2.12 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表2.13 ボディのパラメーター
パラメーター	型	説明
`body`	`APIRequestCount` スキーマ

表2.14 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`APIRequestCount` スキーマ
201 - Created	`APIRequestCount` スキーマ
401 - Unauthorized	空白

2.2.3. /apis/apiserver.openshift.io/v1/apirequestcounts/{name}/status

表2.15 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	APIRequestCount の名前

HTTP メソッド: GET
説明: 指定された APIRequestCount のステータスを読み取ります

表2.16 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`APIRequestCount` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PATCH
説明: 指定された APIRequestCount のステータスを部分的に更新します

表2.17 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表2.18 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`APIRequestCount` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PUT
説明: 指定された APIRequestCount のステータスを置き換えます

表2.19 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表2.20 ボディのパラメーター
パラメーター	型	説明
`body`	`APIRequestCount` スキーマ

表2.21 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`APIRequestCount` スキーマ
201 - Created	`APIRequestCount` スキーマ
401 - Unauthorized	空白

第3章バインディング [v1]

説明

バインディングは、あるオブジェクトを別のオブジェクトに結び付けます。たとえば、Pod はスケジューラーによってノードにバインドされます。1.7 で非推奨になりました。代わりに、Pod のバインディングサブリソースを使用してください。

型

object

必須

target

3.1. 仕様

プロパティー	型	説明
`apiVersion`	`string`	APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。
`kind`	`string`	kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これを更新することはできません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。
`metadata`	`ObjectMeta`	標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。
`target`	`object`	ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。

3.1.1. .target

説明: ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。
型: object

プロパティー	型	説明
`apiVersion`	`string`	参照先の API バージョン。
`fieldPath`	`string`	オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。
`kind`	`string`	参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。
`name`	`string`	参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
`namespace`	`string`	参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
`resourceVersion`	`string`	この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
`uid`	`string`	参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

3.2. API エンドポイント

以下の API エンドポイントを利用できます。

/api/v1/namespaces/{namespace}/bindings
- POST: バインディングを作成します
/api/v1/namespaces/{namespace}/pods/{name}/binding
- POST:Pod のバインディングを作成します

3.2.1. /api/v1/namespaces/{namespace}/bindings

表3.1 グローバルクエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

HTTP メソッド: POST
説明: バインディングを作成する

表3.2 本文パラメーター
パラメーター	型	説明
`body`	`Binding` スキーマ

表3.3 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Binding` スキーマ
201 - Created	`Binding` スキーマ
202 - Accepted	`Binding` スキーマ
401 - Unauthorized	空白

3.2.2. /api/v1/namespaces/{namespace}/pods/{name}/binding

表3.4 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	バインディングの名前

表3.5 グローバルクエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

HTTP メソッド: POST
説明: Pod のバインディングを作成する

表3.6 本文パラメーター
パラメーター	型	説明
`body`	`Binding` スキーマ

表3.7 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Binding` スキーマ
201 - Created	`Binding` スキーマ
202 - Accepted	`Binding` スキーマ
401 - Unauthorized	空白

第4章 ComponentStatus [v1]

説明: ComponentStatus (および ComponentStatusList) は、クラスター検証情報を保持します。非推奨: この API は v1.19+ で非推奨となりました。
型: object

4.1. 仕様

プロパティー	型	説明
`apiVersion`	`string`	APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。
`conditions`	`array`	観察されたコンポーネント条件のリスト
`conditions[]`	`object`	コンポーネントの状態に関する情報。
`kind`	`string`	kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これを更新することはできません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。
`metadata`	`ObjectMeta`	標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。

4.1.1. .conditions

説明: 観察されたコンポーネント条件のリスト
型: array

4.1.2. .conditions[]

説明

コンポーネントの状態に関する情報。

型

object

必須

type
status

プロパティー	型	説明
`error`	`string`	コンポーネントの条件エラーコード。たとえば、ヘルスチェックのエラーコード。
`message`	`string`	コンポーネントの状態に関するメッセージ。たとえば、ヘルスチェックに関する情報。
`status`	`string`	コンポーネントの状態のステータス。"Healthy" の有効な値: "True"、"False"、または "Unknown"。
`type`	`string`	コンポーネントの条件のタイプ。有効な値: "Healthy"

4.2. API エンドポイント

以下の API エンドポイントを利用できます。

/api/v1/componentstatuses
- GET: 種類のオブジェクトをリスト表示する ComponentStatus
/api/v1/componentstatuses/{name}
- GET: 指定された ComponentStatus を読み取ります

4.2.1. /api/v1/componentstatuses

HTTP メソッド: GET
説明: 種類のオブジェクトをリスト表示する ComponentStatus

表4.1 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`ComponentStatusList` スキーマ
401 - Unauthorized	空白

4.2.2. /api/v1/componentstatuses/{name}

表4.2 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	ComponentStatus の名前

HTTP メソッド: GET
説明: 指定された ComponentStatus を読み取ります

表4.3 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`ComponentStatus` スキーマ
401 - Unauthorized	空白

第5章 ConfigMap [v1]

説明: ConfigMap は、Pod が使用する設定データを保持します。
型: object

5.1. 仕様

プロパティー	型	説明
`apiVersion`	`string`	APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。
`binaryData`	`object (string)`	BinaryData には、バイナリーデータが含まれています。各キーは英数字、'-'、'_'、または '.' で構成される必要があります。BinaryData には、UTF-8 の範囲にないバイトシーケンスを含めることができます。BinaryData に格納されているキーは、データフィールドのキーと重複してはなりません。これは、検証プロセス中に適用されます。このフィールドを使用するには、1.10 以降の apiserver と kubelet が必要です。
`data`	`object (string)`	設定データが含まれます。各キーは英数字、'-'、'_'、または '.' で構成される必要があります。非 UTF-8 バイトシーケンスの値は、BinaryData フィールドを使用する必要があります。データに保存されているキーは、BinaryData フィールドのキーと重複してはなりません。これは検証プロセス中に適用されます。
`immutable`	`boolean`	Immutable を true に設定すると、ConfigMap に保存されているデータは更新できなくなります (オブジェクトのメタデータのみを変更できます)。true に設定されていない場合、いつでもフィールドを変更できます。デフォルトは nil です。
`kind`	`string`	kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これを更新することはできません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。
`metadata`	`ObjectMeta`	標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。

5.2. API エンドポイント

以下の API エンドポイントを利用できます。

/api/v1/configmaps
- GET:ConfigMap の種類のオブジェクトをリスト表示または監視します
/api/v1/watch/configmaps
- GET:ConfigMap のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
/api/v1/namespaces/{namespace}/configmaps
- DELETE:ConfigMap のコレクションを削除します
- GET:ConfigMap の種類のオブジェクトをリスト表示または監視します
- POST:ConfigMap を作成します
/api/v1/watch/namespaces/{namespace}/configmaps
- GET:ConfigMap のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
/api/v1/namespaces/{namespace}/configmaps/{name}
- 削除:ConfigMap を削除します
- GET: 指定された ConfigMap を読み取ります
- PATCH: 指定された ConfigMap を部分的に更新します
- PUT: 指定された ConfigMap を置き換えます
/api/v1/watch/namespaces/{namespace}/configmaps/{name}
- GET:ConfigMap の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

5.2.1. /api/v1/configmaps

HTTP メソッド: GET
説明: ConfigMap の種類のオブジェクトをリスト表示または監視する

表5.1 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`ConfigMapList` スキーマ
401 - Unauthorized	空白

5.2.2. /api/v1/watch/configmaps

HTTP メソッド: GET
説明: ConfigMap のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。

表5.2 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

5.2.3. /api/v1/namespaces/{namespace}/configmaps

HTTP メソッド: DELETE
説明: ConfigMap のコレクションを削除します

表5.3 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表5.4 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Status` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: ConfigMap の種類のオブジェクトをリスト表示または監視する

表5.5 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`ConfigMapList` スキーマ
401 - Unauthorized	空白

HTTP メソッド: POST
説明: ConfigMap を作成します

表5.6 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表5.7 ボディのパラメーター
パラメーター	型	説明
`body`	`ConfigMap` スキーマ

表5.8 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`ConfigMap` スキーマ
201 - Created	`ConfigMap` スキーマ
202 - Accepted	`ConfigMap` スキーマ
401 - Unauthorized	空白

5.2.4. /api/v1/watch/namespaces/{namespace}/configmaps

HTTP メソッド: GET
説明: ConfigMap のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。

表5.9 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

5.2.5. /api/v1/namespaces/{namespace}/configmaps/{name}

表5.10 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	ConfigMap の名前

HTTP メソッド: DELETE
説明: ConfigMap を削除します

表5.11 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表5.12 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Status` スキーマ
202 - Accepted	`Status` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: 指定された ConfigMap を読み取ります

表5.13 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`ConfigMap` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PATCH
説明: 指定された ConfigMap を部分的に更新します

表5.14 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表5.15 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`ConfigMap` スキーマ
201 - Created	`ConfigMap` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PUT
説明: 指定された ConfigMap を置き換えます

表5.16 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表5.17 ボディのパラメーター
パラメーター	型	説明
`body`	`ConfigMap` スキーマ

表5.18 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`ConfigMap` スキーマ
201 - Created	`ConfigMap` スキーマ
401 - Unauthorized	空白

5.2.6. /api/v1/watch/namespaces/{namespace}/configmaps/{name}

表5.19 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	ConfigMap の名前

HTTP メソッド: GET
説明: ConfigMap の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

表5.20 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

第6章 ControllerRevision [apps/v1]

説明

ControllerRevision は、状態データの不変のスナップショットを実装します。クライアントは、内部状態を含むオブジェクトをシリアル化および逆シリアル化する責任があります。ControllerRevision が正常に作成されると、更新できなくなります。API サーバーは、データフィールドを変更しようとするすべてのリクエストの検証に失敗します。ただし、ControllerRevisions は削除される場合があります。DaemonSet コントローラーと StatefulSet コントローラーの両方で更新とロールバックに使用されるため、このオブジェクトはベータ版であることに注意してください。ただし、将来のリリースで名前と表現が変更される可能性があるため、クライアントはその安定性に依存しないでください。これは主にコントローラーによる内部使用のためのものです。

型

object

必須

revision

6.1. 仕様

プロパティー	型	説明
`apiVersion`	`string`	APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。
`data`	`RawExtension`	データは、状態のシリアル化された表現です。
`kind`	`string`	kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これを更新することはできません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。
`metadata`	`ObjectMeta`	標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。
`revision`	`integer`	リビジョンは、データで表される状態のリビジョンを示します。

6.2. API エンドポイント

以下の API エンドポイントを利用できます。

/apis/apps/v1/controllerrevisions
- GET: 種類のオブジェクトをリスト表示または監視する ControllerRevision
/apis/apps/v1/watch/controllerrevisions
- GET: ControllerRevision のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
/apis/apps/v1/namespaces/{namespace}/controllerrevisions
- DELETE:ControllerRevision のコレクションを削除します
- GET: 種類のオブジェクトをリスト表示または監視する ControllerRevision
- POST:ControllerRevision を作成します
/apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions
- GET: ControllerRevision のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
/apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}
- 削除:ControllerRevision を削除します
- GET: 指定された ControllerRevision を読み取ります
- PATCH: 指定された ControllerRevision を部分的に更新します
- PUT: 指定された ControllerRevision を置き換えます
/apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions/{name}
- GET:ControllerRevision の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

6.2.1. /apis/apps/v1/controllerrevisions

HTTP メソッド: GET
説明: ControllerRevision の種類のオブジェクトをリスト表示または監視する

表6.1 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`ControllerRevisionList` スキーマ
401 - Unauthorized	空白

6.2.2. /apis/apps/v1/watch/controllerrevisions

HTTP メソッド: GET
説明: ControllerRevision のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。

表6.2 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

6.2.3. /apis/apps/v1/namespaces/{namespace}/controllerrevisions

HTTP メソッド: DELETE
説明: ControllerRevision のコレクションを削除します

表6.3 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表6.4 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Status` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: ControllerRevision の種類のオブジェクトをリスト表示または監視する

表6.5 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`ControllerRevisionList` スキーマ
401 - Unauthorized	空白

HTTP メソッド: POST
説明: ControllerRevision を作成します

表6.6 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表6.7 ボディのパラメーター
パラメーター	型	説明
`body`	`ControllerRevision` スキーマ

表6.8 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`ControllerRevision` スキーマ
201 - Created	`ControllerRevision` スキーマ
202 - Accepted	`ControllerRevision` スキーマ
401 - Unauthorized	空白

6.2.4. /apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions

HTTP メソッド: GET
説明: ControllerRevision のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。

表6.9 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

6.2.5. /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}

表6.10 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	ControllerRevision の名前

HTTP メソッド: DELETE
説明: ControllerRevision を削除します

表6.11 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表6.12 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Status` スキーマ
202 - Accepted	`Status` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: 指定された ControllerRevision を読み取ります

表6.13 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`ControllerRevision` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PATCH
説明: 指定された ControllerRevision を部分的に更新します

表6.14 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表6.15 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`ControllerRevision` スキーマ
201 - Created	`ControllerRevision` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PUT
説明: 指定された ControllerRevision を置き換えます

表6.16 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表6.17 ボディのパラメーター
パラメーター	型	説明
`body`	`ControllerRevision` スキーマ

表6.18 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`ControllerRevision` スキーマ
201 - Created	`ControllerRevision` スキーマ
401 - Unauthorized	空白

6.2.6. /apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions/{name}

表6.19 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	ControllerRevision の名前

HTTP メソッド: GET
説明: ControllerRevision の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

表6.20 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

第7章イベント [events.k8s.io/v1]

説明

イベントは、クラスター内のどこかにあるイベントのレポートです。これは通常、システムの状態変化を示します。イベントの保持時間は限られており、トリガーとメッセージは時間とともに進化する可能性があります。イベントの利用者は、一貫した根本的なトリガーを反映する特定の理由を持つイベントのタイミング、またはその理由を持つイベントの継続的な存在に依存するべきではありません。イベントは、有益で、最善を尽くした、補足的なデータとして扱う必要があります。

型

object

必須

eventTime

7.1. 仕様

プロパティー	型	説明
`action`	`string`	アクションは、関連するオブジェクトに関して実行された/失敗したアクションです。機械可読です。このフィールドは、新しいイベントでは空にすることはできず、最大 128 文字にすることができます。
`apiVersion`	`string`	APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。
`deprecatedCount`	`integer`	deprecatedCount は、core.v1 イベントタイプとの下位互換性を保証する非推奨のフィールドです。
`deprecatedFirstTimestamp`	`Time`	deprecatedFirstTimestamp は、core.v1 イベントタイプとの下位互換性を保証する非推奨のフィールドです。
`deprecatedLastTimestamp`	`Time`	deprecatedLastTimestamp は、core.v1 イベントタイプとの下位互換性を保証する非推奨のフィールドです。
`deprecatedSource`	`EventSource`	deprecatedSource は、core.v1 イベントタイプとの下位互換性を保証する非推奨のフィールドです。
`eventTime`	`MicroTime`	eventTime は、このイベントが最初に観察された時刻です。必須です。
`kind`	`string`	kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これを更新することはできません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。
`metadata`	`ObjectMeta`	標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。
`note`	`string`	注は、この操作のステータスを人間が読める形式で説明したものです。ノートの最大長は 1kB ですが、ライブラリーは 64kB までの値を処理できるように準備する必要があります。
`reason`	`string`	理由は、行動がとられた理由です。人間が読める形式です。このフィールドは、新しいイベントでは空にすることはできず、最大 128 文字にすることができます。
`regarding`	`ObjectReference`	このイベントに関するオブジェクトが含まれています。ほとんどの場合、これはオブジェクトレポートコントローラーが実装します。たとえば、ReplicaSetController は ReplicaSets を実装し、このイベントは、ReplicaSet オブジェクトの一部の変更に作用するために発行されます。
`related`	`ObjectReference`	関連するのは、より複雑なアクションのためのオプションのセカンダリーオブジェクトです。たとえば、オブジェクトに関しては、関連するオブジェクトの作成または削除がトリガーされます。
`reportingController`	`string`	reportingController は、このイベントを発行したコントローラーの名前です (例: `kubernetes.io/kubelet)`。新しいイベントの場合、このフィールドを空にすることはできません。
`reportingInstance`	`string`	reportingInstance は、コントローラーインスタンスの ID です (例: `kubelet-xyzf)`。このフィールドは、新しいイベントでは空にすることはできず、最大 128 文字にすることができます。
`series`	`object`	EventSeries には、一連のイベントに関する情報が含まれています。つまり、しばらくの間継続的に発生していた/発生しているものです。EventSeries を更新する頻度は、イベントレポーター次第です。"k8s.io/client-go/tools/events/event_broadcaster.go" のデフォルトのイベントレポーターは、この構造体がハートビートでどのように更新されるかを示し、カスタマイズされたレポーターの実装をガイドできます。
`type`	`string`	type は、このイベントのタイプ (Normal、Warning) であり、将来、新しいタイプが追加される可能性があります。機械可読です。新しいイベントの場合、このフィールドを空にすることはできません。

7.1.1. .series

説明

EventSeries には、一連のイベントに関する情報が含まれています。つまり、しばらくの間継続的に発生していた/発生しているものです。EventSeries を更新する頻度は、イベントレポーター次第です。"k8s.io/client-go/tools/events/event_broadcaster.go" のデフォルトのイベントレポーターは、この構造体がハートビートでどのように更新されるかを示し、カスタマイズされたレポーターの実装をガイドできます。

型

object

必須

count
lastObservedTime

プロパティー	型	説明
`count`	`integer`	count は、最後のハートビート時間までのこのシリーズの発生数です。
`lastObservedTime`	`MicroTime`	lastObservedTime は、シリーズの最後のイベントが最後のハートビートの前に見られた時刻です。

7.2. API エンドポイント

以下の API エンドポイントを利用できます。

/apis/events.k8s.io/v1/events
- GET: イベントの種類のオブジェクトをリスト表示または監視する
/apis/events.k8s.io/v1/watch/events
- GET: イベントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
/apis/events.k8s.io/v1/namespaces/{namespace}/events
- DELETE: イベントのコレクションを削除します
- GET: イベントの種類のオブジェクトをリスト表示または監視する
- POST: イベントを作成します
/apis/events.k8s.io/v1/watch/namespaces/{namespace}/events
- GET: イベントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
/apis/events.k8s.io/v1/namespaces/{namespace}/events/{name}
- 削除: イベントを削除します
- GET: 指定されたイベントを読み取ります
- PATCH: 指定されたイベントを部分的に更新します
- PUT: 指定されたイベントを置き換えます
/apis/events.k8s.io/v1/watch/namespaces/{namespace}/events/{name}
- GET: イベントの種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

7.2.1. /apis/events.k8s.io/v1/events

HTTP メソッド: GET
説明: 種類のオブジェクトをリスト表示または監視するイベント

表7.1 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`EventList` スキーマ
401 - Unauthorized	空白

7.2.2. /apis/events.k8s.io/v1/watch/events

HTTP メソッド: GET
説明: イベントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。

表7.2 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

7.2.3. /apis/events.k8s.io/v1/namespaces/{namespace}/events

HTTP メソッド: DELETE
説明: イベントのコレクションを削除する

表7.3 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表7.4 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Status` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: 種類のオブジェクトをリスト表示または監視するイベント

表7.5 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`EventList` スキーマ
401 - Unauthorized	空白

HTTP メソッド: POST
説明: イベントを作成する

表7.6 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表7.7 ボディのパラメーター
パラメーター	型	説明
`body`	`Event` スキーマ

表7.8 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Event` スキーマ
201 - Created	`Event` スキーマ
202 - Accepted	`Event` スキーマ
401 - Unauthorized	空白

7.2.4. /apis/events.k8s.io/v1/watch/namespaces/{namespace}/events

HTTP メソッド: GET
説明: イベントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。

表7.9 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

7.2.5. /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name}

表7.10 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	イベントの名前

HTTP メソッド: DELETE
説明: イベントを削除する

表7.11 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表7.12 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Status` スキーマ
202 - Accepted	`Status` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: 指定されたイベントを読み取る

表7.13 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Event` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PATCH
説明: 指定されたイベントを部分的に更新します

表7.14 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表7.15 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Event` スキーマ
201 - Created	`Event` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PUT
説明: 指定されたイベントを置き換えます

表7.16 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表7.17 ボディのパラメーター
パラメーター	型	説明
`body`	`Event` スキーマ

表7.18 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Event` スキーマ
201 - Created	`Event` スキーマ
401 - Unauthorized	空白

7.2.6. /apis/events.k8s.io/v1/watch/namespaces/{namespace}/events/{name}

表7.19 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	イベントの名前

HTTP メソッド: GET
説明: イベントの種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

表7.20 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

第8章 Event [v1]

説明

イベントは、クラスター内のどこかにあるイベントのレポートです。イベントの保持時間は限られており、トリガーとメッセージは時間とともに進化する可能性があります。イベントの利用者は、一貫した根本的なトリガーを反映する特定の理由を持つイベントのタイミング、またはその理由を持つイベントの継続的な存在に依存するべきではありません。イベントは、有益で、最善を尽くした、補足的なデータとして扱う必要があります。

型

object

必須

metadata
involvedObject

8.1. 仕様

プロパティー	型	説明
`action`	`string`	Regarding オブジェクトに関して実行/失敗したアクション。
`apiVersion`	`string`	APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。
`count`	`integer`	このイベントが発生した回数
`eventTime`	`MicroTime`	このイベントが最初に観測された時刻。
`firstTimestamp`	`Time`	イベントが最初に記録された時間(サーバーの受信時刻は TypeMeta にあります。)
`involvedObject`	`object`	ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。
`kind`	`string`	kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これを更新することはできません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。
`lastTimestamp`	`Time`	このイベントの最新の発生が記録された時刻。
`message`	`string`	この操作のステータスの、人間が判読できる説明。
`metadata`	`ObjectMeta`	標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。
`reason`	`string`	これは、オブジェクトの現在のステータスに移行する理由を示す、マシンが理解できる短い文字列である必要があります。
`related`	`object`	ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。
`reportingComponent`	`string`	このイベントを発行したコントローラーの名前 (例: `kubernetes.io/kubelet)`。
`reportingInstance`	`string`	コントローラーインスタンスの ID(例: `kubelet-xyzf)`。
`series`	`object`	EventSeries には、一連のイベントに関する情報が含まれています。つまり、しばらくの間継続的に発生していた/発生しているものです。
`source`	`object`	EventSource にはイベントの情報が含まれます。
`type`	`string`	このイベントのタイプ (通常、警告)、将来的に新しいタイプが追加される可能性があります

8.1.1. .involvedObject

説明: ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。
型: object

プロパティー	型	説明
`apiVersion`	`string`	参照先の API バージョン。
`fieldPath`	`string`	オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。
`kind`	`string`	参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。
`name`	`string`	参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
`namespace`	`string`	参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
`resourceVersion`	`string`	この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
`uid`	`string`	参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

8.1.2. .related

説明: ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。
型: object

プロパティー	型	説明
`apiVersion`	`string`	参照先の API バージョン。
`fieldPath`	`string`	オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。
`kind`	`string`	参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。
`name`	`string`	参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names
`namespace`	`string`	参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/
`resourceVersion`	`string`	この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency
`uid`	`string`	参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids

8.1.3. .series

説明: EventSeries には、一連のイベントに関する情報が含まれています。つまり、しばらくの間継続的に発生していた/発生しているものです。
型: object

プロパティー	型	説明
`count`	`integer`	最後のハートビート時間までのこのシリーズの発生数
`lastObservedTime`	`MicroTime`	観測された最後の発生時刻

8.1.4. .source

説明: EventSource にはイベントの情報が含まれます。
型: object

プロパティー	型	説明
`component`	`string`	イベントの生成元となるコンポーネント。
`host`	`string`	イベントが生成されるノード名。

8.2. API エンドポイント

以下の API エンドポイントを利用できます。

/api/v1/events
- GET: イベントの種類のオブジェクトをリスト表示または監視する
/api/v1/watch/events
- GET: イベントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
/api/v1/namespaces/{namespace}/events
- DELETE: イベントのコレクションを削除します
- GET: イベントの種類のオブジェクトをリスト表示または監視する
- POST: イベントを作成します
/api/v1/watch/namespaces/{namespace}/events
- GET: イベントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
/api/v1/namespaces/{namespace}/events/{name}
- 削除: イベントを削除します
- GET: 指定されたイベントを読み取ります
- PATCH: 指定されたイベントを部分的に更新します
- PUT: 指定されたイベントを置き換えます
/api/v1/watch/namespaces/{namespace}/events/{name}
- GET: イベントの種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

8.2.1. /api/v1/events

HTTP メソッド: GET
説明: 種類のオブジェクトをリスト表示または監視するイベント

表8.1 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`EventList` スキーマ
401 - Unauthorized	空白

8.2.2. /api/v1/watch/events

HTTP メソッド: GET
説明: イベントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。

表8.2 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

8.2.3. /api/v1/namespaces/{namespace}/events

HTTP メソッド: DELETE
説明: イベントのコレクションを削除する

表8.3 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表8.4 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Status` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: 種類のオブジェクトをリスト表示または監視するイベント

表8.5 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`EventList` スキーマ
401 - Unauthorized	空白

HTTP メソッド: POST
説明: イベントを作成する

表8.6 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表8.7 ボディのパラメーター
パラメーター	型	説明
`body`	`Event` スキーマ

表8.8 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Event` スキーマ
201 - Created	`Event` スキーマ
202 - Accepted	`Event` スキーマ
401 - Unauthorized	空白

8.2.4. /api/v1/watch/namespaces/{namespace}/events

HTTP メソッド: GET
説明: イベントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。

表8.9 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

8.2.5. /api/v1/namespaces/{namespace}/events/{name}

表8.10 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	イベントの名前

HTTP メソッド: DELETE
説明: イベントを削除する

表8.11 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表8.12 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Status` スキーマ
202 - Accepted	`Status` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: 指定されたイベントを読み取る

表8.13 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Event` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PATCH
説明: 指定されたイベントを部分的に更新します

表8.14 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表8.15 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Event` スキーマ
201 - Created	`Event` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PUT
説明: 指定されたイベントを置き換えます

表8.16 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表8.17 ボディのパラメーター
パラメーター	型	説明
`body`	`Event` スキーマ

表8.18 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Event` スキーマ
201 - Created	`Event` スキーマ
401 - Unauthorized	空白

8.2.6. /api/v1/watch/namespaces/{namespace}/events/{name}

表8.19 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	イベントの名前

HTTP メソッド: GET
説明: イベントの種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

表8.20 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

第9章リース [coordination.k8s.io/v1]

説明: リースは、リースの概念を定義します。
型: object

9.1. 仕様

プロパティー	型	説明
`apiVersion`	`string`	APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。
`kind`	`string`	kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これを更新することはできません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。
`metadata`	`ObjectMeta`	詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。
`spec`	`object`	LeaseSpec は、Lease の仕様です。

9.1.1. .spec

説明: LeaseSpec は、Lease の仕様です。
型: object

プロパティー	型	説明
`acquireTime`	`MicroTime`	acquireTime は、現在のリースが取得された時刻です。
`holderIdentity`	`string`	holderIdentity には、現在のリースの所有者の ID が含まれます。
`leaseDurationSeconds`	`integer`	leaseDurationSeconds は、リースの候補者がそれを強制的に取得するのを待つ必要がある期間です。これは、最後に確認された renewTime の時間に対する測定値です。
`leaseTransitions`	`integer`	leaseTransitions は、所有者間のリースの遷移の数です。
`renewTime`	`MicroTime`	renewTime は、リースの現在の所有者が最後にリースを更新した時刻です。

9.2. API エンドポイント

以下の API エンドポイントを利用できます。

/apis/coordination.k8s.io/v1/leases
- GET: 種類のオブジェクトをリスト表示または監視するリース
/apis/coordination.k8s.io/v1/watch/leases
- GET: リースのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
/apis/coordination.k8s.io/v1/namespaces/{namespace}/leases
- DELETE: リースのコレクションを削除します
- GET: 種類のオブジェクトをリスト表示または監視するリース
- POST: リースを作成します
/apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases
- GET: リースのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
/apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}
- 削除: リースを削除します
- GET: 指定されたリースを読み取ります
- PATCH: 指定されたリースを部分的に更新します
- PUT: 指定されたリースを置き換えます
/apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases/{name}
- GET: リースの種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

9.2.1. /apis/coordination.k8s.io/v1/leases

HTTP メソッド: GET
説明: 種類のオブジェクトをリスト表示または監視するリース

表9.1 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`LeaseList` スキーマ
401 - Unauthorized	空白

9.2.2. /apis/coordination.k8s.io/v1/watch/leases

HTTP メソッド: GET
説明: リースのリストへの個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。

表9.2 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

9.2.3. /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases

HTTP メソッド: DELETE
説明: リースのコレクションを削除する

表9.3 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表9.4 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Status` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: 種類のオブジェクトをリスト表示または監視するリース

表9.5 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`LeaseList` スキーマ
401 - Unauthorized	空白

HTTP メソッド: POST
説明: リースを作成する

表9.6 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表9.7 ボディのパラメーター
パラメーター	型	説明
`body`	`Lease` スキーマ

表9.8 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Lease` スキーマ
201 - Created	`Lease` スキーマ
202 - Accepted	`Lease` スキーマ
401 - Unauthorized	空白

9.2.4. /apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases

HTTP メソッド: GET
説明: リースのリストへの個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。

表9.9 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

9.2.5. /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}

表9.10 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	リースの名前

HTTP メソッド: DELETE
説明: リースを削除する

表9.11 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表9.12 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Status` スキーマ
202 - Accepted	`Status` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: 指定されたリースを読む

表9.13 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Lease` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PATCH
説明: 指定されたリースを部分的に更新します

表9.14 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表9.15 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Lease` スキーマ
201 - Created	`Lease` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PUT
説明: 指定されたリースを交換してください

表9.16 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表9.17 ボディのパラメーター
パラメーター	型	説明
`body`	`Lease` スキーマ

表9.18 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Lease` スキーマ
201 - Created	`Lease` スキーマ
401 - Unauthorized	空白

9.2.6. /apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases/{name}

表9.19 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	リースの名前

HTTP メソッド: GET
説明: 種類のリースのオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

表9.20 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

第10章 Namespace [v1]

説明: 名前空間は、名前のスコープを提供します。複数の名前空間の使用はオプションです。
型: object

10.1. 仕様

プロパティー	型	説明
`apiVersion`	`string`	APIVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。
`kind`	`string`	kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できる場合があります。これを更新することはできません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。
`metadata`	`ObjectMeta`	標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。
`spec`	`object`	NamespaceSpec は、名前空間の属性を記述します。
`status`	`object`	NamespaceStatus は、ネームスペースの現在のステータスに関する情報です。

10.1.1. .spec

説明: NamespaceSpec は、名前空間の属性を記述します。
型: object

プロパティー	型	説明
`finalizers`	`array (string)`	ファイナライザーは、オブジェクトをストレージから完全に削除するために空にする必要がある不透明な値のリストです。詳細: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

10.1.2. .status

説明: NamespaceStatus は、ネームスペースの現在のステータスに関する情報です。
型: object

プロパティー型説明

conditions

array

名前空間の現在の状態の最新の利用可能な観測を表します。

conditions[]

object

NamespaceCondition には、名前空間の状態の詳細が含まれます。

phase

string

フェーズは、名前空間の現在のライフサイクルフェーズです。詳細: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/

使用可能な列挙値: - "Active" は、名前空間がシステムで使用できることを意味します。- "Terminating" は名前空間が正常に終了していることを意味します。

10.1.3. .status.conditions

説明: 名前空間の現在の状態の最新の利用可能な観測を表します。
型: array

10.1.4. .status.conditions[]

説明

NamespaceCondition には、名前空間の状態の詳細が含まれます。

型

object

必須

type
status

プロパティー	型	説明
`lastTransitionTime`	`Time`
`message`	`string`
`reason`	`string`
`status`	`string`	状態のステータス (True、False、Unknown のいずれか)。
`type`	`string`	名前空間コントローラーの状態のタイプ。

10.2. API エンドポイント

以下の API エンドポイントを利用できます。

/api/v1/namespaces
- GET: 名前空間の種類のオブジェクトをリスト表示または監視します
- POST: 名前空間を作成します
/api/v1/watch/namespaces
- GET: 名前空間のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
/api/v1/namespaces/{name}
- DELETE: 名前空間を削除します
- GET: 指定された名前空間を読み取ります
- PATCH: 指定された名前空間を部分的に更新します
- PUT: 指定された名前空間を置き換えます
/api/v1/watch/namespaces/{name}
- GET: 名前空間の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
/api/v1/namespaces/{name}/status
- GET: 指定された名前空間のステータスを読み取ります
- PATCH: 指定された名前空間のステータスを部分的に更新します
- PUT: 指定された名前空間のステータスを置き換えます
/api/v1/namespaces/{name}/finalize
- PUT: 指定された名前空間のファイナライズを置き換えます

10.2.1. /api/v1/namespaces

HTTP メソッド: GET
説明: 名前空間の種類のオブジェクトをリスト表示または監視する

表10.1 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`NamespaceList` スキーマ
401 - Unauthorized	空白

HTTP メソッド: POST
説明: namespace を作成します

表10.2 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表10.3 ボディのパラメーター
パラメーター	型	説明
`body`	`Namespace` スキーマ

表10.4 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Namespace` スキーマ
201 - Created	`Namespace` スキーマ
202 - Accepted	`Namespace` スキーマ
401 - Unauthorized	空白

10.2.2. /api/v1/watch/namespaces

HTTP メソッド: GET
説明: 名前空間のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。

表10.5 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

10.2.3. /api/v1/namespaces/{name}

表10.6 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	名前空間の名前

HTTP メソッド: DELETE
説明: 名前空間を削除する

表10.7 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。

表10.8 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Status` スキーマ
202 - Accepted	`Status` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: 指定された名前空間を読み取ります

表10.9 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Namespace` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PATCH
説明: 指定された名前空間を部分的に更新します

表10.10 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表10.11 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Namespace` スキーマ
201 - Created	`Namespace` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PUT
説明: 指定された名前空間を置き換えます

表10.12 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表10.13 ボディのパラメーター
パラメーター	型	説明
`body`	`Namespace` スキーマ

表10.14 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Namespace` スキーマ
201 - Created	`Namespace` スキーマ
401 - Unauthorized	空白

10.2.4. /api/v1/watch/namespaces/{name}

表10.15 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	名前空間の名前

HTTP メソッド: GET
説明: 名前空間の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。

表10.16 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

10.2.5. /api/v1/namespaces/{name}/status

表10.17 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	名前空間の名前

HTTP メソッド: GET
説明: 指定されたネームスペースのステータスを読み取ります

表10.18 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Namespace` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PATCH
説明: 指定された名前空間のステータスを部分的に更新します

表10.19 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表10.20 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Namespace` スキーマ
201 - Created	`Namespace` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PUT
説明: 指定されたネームスペースのステータスを置き換えます

表10.21 クエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

表10.22 ボディのパラメーター
パラメーター	型	説明
`body`	`Namespace` スキーマ

表10.23 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Namespace` スキーマ
201 - Created	`Namespace` スキーマ
401 - Unauthorized	空白

10.2.6. /api/v1/namespaces/{name}/finalize

表10.24 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	名前空間の名前

表10.25 グローバルクエリーパラメーター
パラメーター	型	説明
`dryRun`	`string`	これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。
`fieldValidation`	`string`	fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。

HTTP メソッド: PUT
説明: 指定された名前空間の finalize を置き換えます

表10.26 本文パラメーター
パラメーター	型	説明
`body`	`Namespace` スキーマ

表10.27 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Namespace` スキーマ
201 - Created	`Namespace` スキーマ
401 - Unauthorized	空白

Legal Notice

OpenShift documentation is licensed under the Apache License 2.0 (https://www.apache.org/licenses/LICENSE-2.0).

Modified versions must remove all Red Hat trademarks.

Portions adapted from https://github.com/kubernetes-incubator/service-catalog/ with modifications by Red Hat.

Red Hat, Red Hat Enterprise Linux, the Red Hat logo, the Shadowman logo, JBoss, OpenShift, Fedora, the Infinity logo, and RHCE are trademarks of Red Hat, Inc., registered in the United States and other countries.

Linux® is the registered trademark of Linus Torvalds in the United States and other countries.

Java® is a registered trademark of Oracle and/or its affiliates.

XFS® is a trademark of Silicon Graphics International Corp. or its subsidiaries in the United States and/or other countries.

MySQL® is a registered trademark of MySQL AB in the United States, the European Union and other countries.

Node.js® is an official trademark of Joyent. Red Hat Software Collections is not formally related to or endorsed by the official Joyent Node.js open source or commercial project.

The OpenStack® Word Mark and OpenStack logo are either registered trademarks/service marks or trademarks/service marks of the OpenStack Foundation, in the United States and other countries and are used with the OpenStack Foundation’s permission. We are not affiliated with, endorsed or sponsored by the OpenStack Foundation, or the OpenStack community.

All other trademarks are the property of their respective owners.

メタデータ API