Red Hat Summitメタデータ API
メタデータ API のリファレンスガイド
概要
第1章 メタデータ API
1.1. APIRequestCount [apiserver.openshift.io/v1]
- 説明
-
APIRequestCount は、API に対して行われたリクエストを追跡します。インスタンス名は、
リソースと一致する resource.version.group の形式である必要があります。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。 - 型
-
object
1.2. バインディング [v1]
- 説明
- バインディングは、あるオブジェクトを別のオブジェクトに結び付けます。たとえば、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]
- 説明
- Namespace は、名前のスコープを提供します。複数の名前空間の使用はオプションです。
- 型
-
object
第2章 APIRequestCount [apiserver.openshift.io/v1]
- 説明
-
APIRequestCount は、API に対して行われたリクエストを追跡します。インスタンス名は、
リソースと一致する resource.version.group の形式である必要があります。互換性レベル 1: メジャーリリース内で最低 12 か月または 3 つのマイナーリリース (どちらか長い方) の間安定しています。 - 型
-
object - 必須
-
spec
-
2.1. 仕様
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
|
| spec は、リソースの特性を定義します。 |
|
|
| status には、リソースの監視された状態が含まれます。 |
2.1.1. .spec
- 説明
- spec は、リソースの特性を定義します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| numberOfUsersToReport は、レポートに含めるユーザーの数です。指定されていないかゼロの場合、デフォルトは 10 です。これはデフォルトであり、変更される可能性があります。 |
2.1.2. .status
- 説明
- status には、リソースの監視された状態が含まれます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 条件には、この API リソースの現在のステータスの詳細が含まれています。 |
|
|
|
条件には、この API リソースの現在の状態の 1 つの側面の詳細が含まれています。--- この構造体は、フィールドパスの .status.conditions で配列として直接使用することを目的としています。For example, type 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 |
|
|
| currentHour には、現在の時間のリクエスト履歴が含まれます。これは、問題に対処したかどうかを確認する人間が API を読みやすくするための磁器です。このフィールドは正時にリセットされます。 |
|
|
| last24h には、過去 24 時間のリクエスト履歴が含まれ、時間でインデックスが付けられます。したがって、12:00 AM〜12:59 はインデックス 0、6 am〜6:59 am はインデックス 6 などになります。現在の時間のインデックスはライブで更新され、requestsLastHour フィールドに複製されます。 |
|
|
| PerResourceAPIRequestLog は、さまざまなノードの要求をログに記録します。 |
|
|
| removedInRelease は、API が削除される時期です。 |
|
|
| 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 は、ある状態から別の状態に最後に遷移した時間です。これは、基本的な条件が変更された時点となります。不明な場合には、API フィールドが変更された時点を使用することも可能です。 |
|
|
| message は、遷移の詳細を示す人が判読できるメッセージです。空の文字列の場合もあります。 |
|
|
| observedGeneration は、それをベースに条件が設定された .metadata.generation を表します。たとえば、.metadata.generation が現在 12 で、.status.conditions[x].observedGeneration が 9 の場合、インスタンスの現在の状態に対して条件が古くなっています。 |
|
|
| reason には、条件の最後の遷移の理由を示すプログラムによる識別子が含まれます。特定の条件タイプのプロデューサーは、このフィールドの期待値と意味、および値が保証された API と見なされるかどうかを定義できます。値は CamelCase 文字列である必要があります。このフィールドには空白を指定できません。 |
|
|
| 条件のステータス、True、False、Unknown のいずれか。 |
|
|
| CamelCase または foo.example.com/CamelCase の条件のタイプ。--- 多くの.condition.type 値は、Available などのリソース全体で一貫していますが、任意の条件が役立つ可能性があるため (.node.status.conditions を参照)、競合を解消する機能が重要です。一致する正規表現は (dns1123SubdomainFmt/)?(qualifiedNameFmt) です。 |
2.1.5. .status.currentHour
- 説明
- currentHour には、現在の時間のリクエスト履歴が含まれます。これは、問題に対処したかどうかを確認する人間が API を読みやすくするための磁器です。このフィールドは正時にリセットされます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| byNode には、ノードごとのリクエストのログが含まれています。 |
|
|
| PerNodeAPIRequestLog には、特定のノードへの要求のログが含まれています。 |
|
|
| requestCount は、ノード全体のすべての requestCount の合計です。 |
2.1.6. .status.currentHour.byNode
- 説明
- byNode には、ノードごとのリクエストのログが含まれています。
- 型
-
array
2.1.7. .status.currentHour.byNode[]
- 説明
- PerNodeAPIRequestLog には、特定のノードへの要求のログが含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| byUser には、上位の.spec.numberOfUsersToReport ユーザーによるリクエストの詳細が含まれています。apiserver の場合、トップユーザーのリストを再起動することはベストエフォートベースで決定されるため、リストが不正確になる可能性があることに注意してください。さらに、一部のシステムユーザーがリストに明示的に含まれている場合があります。 |
|
|
| PerUserAPIRequestCount には、ユーザーのリクエストのログが含まれます。 |
|
|
| リクエストが処理されている nodeName。 |
|
|
| 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 動詞ごとの詳細。 |
|
|
| API リクエスト動詞による PerVerbAPIRequestCount requestCounts 要求。 |
|
|
| requestCount すべての動詞にわたるユーザーによる要求の数。 |
|
|
| リクエストを行った userAgent。同じユーザーが、接続する複数のバイナリー (多くのコンテナーを持つ Pod) を持っていることがよくあります。バイナリーが異なれば、userAgent も異なりますが、ユーザーは同じです。さらに、バージョン情報が埋め込まれた userAgent があり、userName が変更される可能性はほとんどありません。 |
|
|
| リクエストを行った userName。 |
2.1.10. .status.currentHour.byNode[].byUser[].byVerb
- 説明
- byVerb 動詞ごとの詳細。
- 型
-
array
2.1.11. .status.currentHour.byNode[].byUser[].byVerb[]
- 説明
- API リクエスト動詞による PerVerbAPIRequestCount requestCounts 要求。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| requestCount 動詞のリクエストの数。 |
|
|
| API リクエストの動詞 (get、list、create など…) |
2.1.12. .status.last24h
- 説明
- last24h には、過去 24 時間のリクエスト履歴が含まれ、時間でインデックスが付けられます。したがって、12:00 AM〜12:59 はインデックス 0、6 am〜6:59 am はインデックス 6 などになります。現在の時間のインデックスはライブで更新され、requestsLastHour フィールドに複製されます。
- 型
-
array
2.1.13. .status.last24h[]
- 説明
- PerResourceAPIRequestLog は、さまざまなノードの要求をログに記録します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| byNode には、ノードごとのリクエストのログが含まれています。 |
|
|
| PerNodeAPIRequestLog には、特定のノードへの要求のログが含まれています。 |
|
|
| requestCount は、ノード全体のすべての requestCount の合計です。 |
2.1.14. .status.last24h[].byNode
- 説明
- byNode には、ノードごとのリクエストのログが含まれています。
- 型
-
array
2.1.15. .status.last24h[].byNode[]
- 説明
- PerNodeAPIRequestLog には、特定のノードへの要求のログが含まれています。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| byUser には、上位の.spec.numberOfUsersToReport ユーザーによるリクエストの詳細が含まれています。apiserver の場合、トップユーザーのリストを再起動することはベストエフォートベースで決定されるため、リストが不正確になる可能性があることに注意してください。さらに、一部のシステムユーザーがリストに明示的に含まれている場合があります。 |
|
|
| PerUserAPIRequestCount には、ユーザーのリクエストのログが含まれます。 |
|
|
| リクエストが処理されている nodeName。 |
|
|
| 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 動詞ごとの詳細。 |
|
|
| API リクエスト動詞による PerVerbAPIRequestCount requestCounts 要求。 |
|
|
| requestCount すべての動詞にわたるユーザーによる要求の数。 |
|
|
| リクエストを行った userAgent。同じユーザーが、接続する複数のバイナリー (多くのコンテナーを持つ Pod) を持っていることがよくあります。バイナリーが異なれば、userAgent も異なりますが、ユーザーは同じです。さらに、バージョン情報が埋め込まれた userAgent があり、userName が変更される可能性はほとんどありません。 |
|
|
| リクエストを行った userName。 |
2.1.18. .status.last24h[].byNode[].byUser[].byVerb
- 説明
- byVerb 動詞ごとの詳細。
- 型
-
array
2.1.19. .status.last24h[].byNode[].byUser[].byVerb[]
- 説明
- API リクエスト動詞による PerVerbAPIRequestCount requestCounts 要求。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| requestCount 動詞のリクエストの数。 |
|
|
| 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 のコレクションを削除します
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が APIRequestCount のオブジェクトをリスト表示します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- APIRequestCount を作成します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
2.2.2. /apis/apiserver.openshift.io/v1/apirequestcounts/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| APIRequestCount の名前 |
- HTTP メソッド
-
DELETE - 説明
- APIRequestCount を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された APIRequestCount を読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された APIRequestCount を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された APIRequestCount を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
2.2.3. /apis/apiserver.openshift.io/v1/apirequestcounts/{name}/status
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| APIRequestCount の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された APIRequestCount のステータスを読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された APIRequestCount のステータスを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された APIRequestCount のステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
第3章 バインディング [v1]
- 説明
- バインディングは、あるオブジェクトを別のオブジェクトに結び付けます。たとえば、Pod はスケジューラーによってノードにバインドされます。
- 型
-
object - 必須
-
target
-
3.1. 仕様
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
|
| ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。 |
3.1.1. .target
- 説明
- ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 参照先の API バージョン。 |
|
|
| オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。 |
|
|
| 参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
|
| 参照先の 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
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
- HTTP メソッド
-
POST - 説明
- バインディングを作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
3.2.2. /api/v1/namespaces/{namespace}/pods/{name}/binding
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| バインディングの名前 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
- HTTP メソッド
-
POST - 説明
- Pod のバインディングを作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
第4章 ComponentStatus [v1]
- 説明
- ComponentStatus (および ComponentStatusList) は、クラスター検証情報を保持します。非推奨: この API は v1.19+ で非推奨となりました。
- 型
-
object
4.1. 仕様
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| 観察されたコンポーネント条件のリスト |
|
|
| コンポーネントの状態に関する情報。 |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 標準オブジェクトのメタデータ。詳細は、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
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| コンポーネントの条件エラーコード。たとえば、ヘルスチェックのエラーコード。 |
|
|
| コンポーネントの状態に関するメッセージ。たとえば、ヘルスチェックに関する情報。 |
|
|
| コンポーネントの状態のステータス。"Healthy" の有効な値: "True"、"False"、または "Unknown"。 |
|
|
| コンポーネントの条件のタイプ。有効な値: "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 のオブジェクトをリスト表示します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
4.2.2. /api/v1/componentstatuses/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ComponentStatus の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された ComponentStatus を読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
第5章 ConfigMap [v1]
- 説明
- ConfigMap は、Pod が使用する設定データを保持します。
- 型
-
object
5.1. 仕様
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| BinaryData には、バイナリーデータが含まれています。各キーは英数字、'-'、'_'、または '.' で構成される必要があります。BinaryData には、UTF-8 の範囲にないバイトシーケンスを含めることができます。BinaryData に格納されているキーは、データフィールドのキーと重複してはなりません。これは、検証プロセス中に適用されます。このフィールドを使用するには、1.10 以降の apiserver と kubelet が必要です。 |
|
|
| 設定データが含まれます。各キーは英数字、'-'、'_'、または '.' で構成される必要があります。非 UTF-8 バイトシーケンスの値は、BinaryData フィールドを使用する必要があります。データに保存されているキーは、BinaryData フィールドのキーと重複してはなりません。これは検証プロセス中に適用されます。 |
|
|
| Immutable を true に設定すると、ConfigMap に保存されているデータは更新できなくなります (オブジェクトのメタデータのみを変更できます)。true に設定されていない場合、いつでもフィールドを変更できます。デフォルトは nil です。 |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 標準オブジェクトのメタデータ。詳細は、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}-
DELETE: 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 のオブジェクトをリスト表示または監視します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
5.2.2. /api/v1/watch/configmaps
- HTTP メソッド
-
GET - 説明
- ConfigMap のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
5.2.3. /api/v1/namespaces/{namespace}/configmaps
- HTTP メソッド
-
DELETE - 説明
- ConfigMap のコレクションを削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が ConfigMap のオブジェクトをリスト表示または監視します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- ConfigMap を作成します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
5.2.4. /api/v1/watch/namespaces/{namespace}/configmaps
- HTTP メソッド
-
GET - 説明
- ConfigMap のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
5.2.5. /api/v1/namespaces/{namespace}/configmaps/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ConfigMap の名前 |
- HTTP メソッド
-
DELETE - 説明
- ConfigMap を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された ConfigMap を読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ConfigMap を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ConfigMap を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
5.2.6. /api/v1/watch/namespaces/{namespace}/configmaps/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ConfigMap の名前 |
- HTTP メソッド
-
GET - 説明
- 種類が ConfigMap のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
第6章 ControllerRevision [apps/v1]
- 説明
- ControllerRevision は、状態データの不変のスナップショットを実装します。クライアントは、内部状態を含むオブジェクトをシリアル化および逆シリアル化する責任があります。ControllerRevision が正常に作成されると、更新できなくなります。API サーバーは、データフィールドを変更しようとするすべてのリクエストの検証に失敗します。ただし、ControllerRevisions は削除される場合があります。DaemonSet コントローラーと StatefulSet コントローラーの両方で更新とロールバックに使用されるため、このオブジェクトはベータ版であることに注意してください。ただし、将来のリリースで名前と表現が変更される可能性があるため、クライアントはその安定性に依存しないでください。これは主にコントローラーによる内部使用のためのものです。
- 型
-
object - 必須
-
revision
-
6.1. 仕様
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
| データは、状態のシリアル化された表現です。 | |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
|
| リビジョンは、データで表される状態のリビジョンを示します。 |
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}-
DELETE: 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 のオブジェクトをリスト表示または監視します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
6.2.2. /apis/apps/v1/watch/controllerrevisions
- HTTP メソッド
-
GET - 説明
- ControllerRevision のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
6.2.3. /apis/apps/v1/namespaces/{namespace}/controllerrevisions
- HTTP メソッド
-
DELETE - 説明
- ControllerRevision のコレクションを削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が ControllerRevision のオブジェクトをリスト表示または監視します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- ControllerRevision を作成します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
6.2.4. /apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions
- HTTP メソッド
-
GET - 説明
- ControllerRevision のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
6.2.5. /apis/apps/v1/namespaces/{namespace}/controllerrevisions/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ControllerRevision の名前 |
- HTTP メソッド
-
DELETE - 説明
- ControllerRevision を削除します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された ControllerRevision を読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された ControllerRevision を部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された ControllerRevision を置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
6.2.6. /apis/apps/v1/watch/namespaces/{namespace}/controllerrevisions/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| ControllerRevision の名前 |
- HTTP メソッド
-
GET - 説明
- 種類が ControllerRevision のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
第7章 イベント [events.k8s.io/v1]
- 説明
- イベントは、クラスター内のどこかにあるイベントのレポートです。これは通常、システムの状態変化を示します。イベントの保持時間は限られており、トリガーとメッセージは時間とともに進化する可能性があります。イベントの利用者は、一貫した根本的なトリガーを反映する特定の理由を持つイベントのタイミング、またはその理由を持つイベントの継続的な存在に依存するべきではありません。イベントは、有益で、最善を尽くした、補足的なデータとして扱う必要があります。
- 型
-
object - 必須
-
eventTime
-
7.1. 仕様
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| アクションは、関連するオブジェクトに関して実行された/失敗したアクションです。機械可読です。このフィールドは、新しいイベントでは空にすることはできず、最大 128 文字にすることができます。 |
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| deprecatedCount は、core.v1 イベントタイプとの下位互換性を保証する非推奨のフィールドです。 |
|
| deprecatedFirstTimestamp は、core.v1 イベントタイプとの下位互換性を保証する非推奨のフィールドです。 | |
|
| deprecatedLastTimestamp は、core.v1 イベントタイプとの下位互換性を保証する非推奨のフィールドです。 | |
|
| deprecatedSource は、core.v1 イベントタイプとの下位互換性を保証する非推奨のフィールドです。 | |
|
| eventTime は、このイベントが最初に観察された時刻です。必須です。 | |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
|
| 注は、この操作のステータスを人間が読める形式で説明したものです。ノートの最大長は 1kB ですが、ライブラリーは 64kB までの値を処理できるように準備する必要があります。 |
|
|
| 理由は、行動がとられた理由です。人間が読める形式です。このフィールドは、新しいイベントでは空にすることはできず、最大 128 文字にすることができます。 |
|
| このイベントに関するオブジェクトが含まれています。ほとんどの場合、これはオブジェクトレポートコントローラーが実装します。たとえば、ReplicaSetController は ReplicaSets を実装し、このイベントは、ReplicaSet オブジェクトの一部の変更に作用するために発行されます。 | |
|
| 関連するのは、より複雑なアクションのためのオプションのセカンダリーオブジェクトです。たとえば、オブジェクトに関しては、関連するオブジェクトの作成または削除がトリガーされます。 | |
|
|
|
reportingController は、このイベントを発行したコントローラーの名前です (例: |
|
|
|
reportingInstance は、コントローラーインスタンスの ID です (例: |
|
|
| EventSeries には、一連のイベントに関する情報が含まれています。つまり、しばらくの間継続的に発生していた/発生しているものです。EventSeries を更新する頻度は、イベントレポーター次第です。"k8s.io/client-go/tools/events/event_broadcaster.go" のデフォルトのイベントレポーターは、この構造体がハートビートでどのように更新されるかを示し、カスタマイズされたレポーターの実装をガイドできます。 |
|
|
| type は、このイベントのタイプ (Normal、Warning) であり、将来、新しいタイプが追加される可能性があります。機械可読です。新しいイベントの場合、このフィールドを空にすることはできません。 |
7.1.1. .series
- 説明
- EventSeries には、一連のイベントに関する情報が含まれています。つまり、しばらくの間継続的に発生していた/発生しているものです。EventSeries を更新する頻度は、イベントレポーター次第です。"k8s.io/client-go/tools/events/event_broadcaster.go" のデフォルトのイベントレポーターは、この構造体がハートビートでどのように更新されるかを示し、カスタマイズされたレポーターの実装をガイドできます。
- 型
-
object - 必須
-
count -
lastObservedTime
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| count は、最後のハートビート時間までのこのシリーズの発生数です。 |
|
| lastObservedTime は、シリーズの最後のイベントが最後のハートビートの前に見られた時刻です。 |
7.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/events.k8s.io/v1/events-
GET: 種類が Event のオブジェクトをリスト表示または監視します。
-
/apis/events.k8s.io/v1/watch/events-
GET: イベントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/events.k8s.io/v1/namespaces/{namespace}/events-
DELETE: イベントのコレクションを削除します -
GET: 種類が Event のオブジェクトをリスト表示または監視します。 -
POST: イベントを作成します
-
/apis/events.k8s.io/v1/watch/namespaces/{namespace}/events-
GET: イベントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/events.k8s.io/v1/namespaces/{namespace}/events/{name}-
DELETE: イベントを削除します -
GET: 指定されたイベントを読み取ります -
PATCH: 指定されたイベントを部分的に更新します -
PUT: 指定されたイベントを置き換えます
-
/apis/events.k8s.io/v1/watch/namespaces/{namespace}/events/{name}-
GET: 種類が Event のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
7.2.1. /apis/events.k8s.io/v1/events
- HTTP メソッド
-
GET - 説明
- 種類が Event のオブジェクトをリスト表示または監視します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
7.2.2. /apis/events.k8s.io/v1/watch/events
- HTTP メソッド
-
GET - 説明
- イベントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
7.2.3. /apis/events.k8s.io/v1/namespaces/{namespace}/events
- HTTP メソッド
-
DELETE - 説明
- イベントのコレクションを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が Event のオブジェクトをリスト表示または監視します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- イベントを作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
7.2.4. /apis/events.k8s.io/v1/watch/namespaces/{namespace}/events
- HTTP メソッド
-
GET - 説明
- イベントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
7.2.5. /apis/events.k8s.io/v1/namespaces/{namespace}/events/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| イベントの名前 |
- HTTP メソッド
-
DELETE - 説明
- イベントを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定されたイベントを読み取る
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定されたイベントを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定されたイベントを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
7.2.6. /apis/events.k8s.io/v1/watch/namespaces/{namespace}/events/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| イベントの名前 |
- HTTP メソッド
-
GET - 説明
- 種類が Event のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
第8章 Event [v1]
- 説明
- イベントは、クラスター内のどこかにあるイベントのレポートです。イベントの保持時間は限られており、トリガーとメッセージは時間とともに進化する可能性があります。イベントの利用者は、一貫した根本的なトリガーを反映する特定の理由を持つイベントのタイミング、またはその理由を持つイベントの継続的な存在に依存するべきではありません。イベントは、有益で、最善を尽くした、補足的なデータとして扱う必要があります。
- 型
-
object - 必須
-
metadata -
involvedObject
-
8.1. 仕様
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| Regarding オブジェクトに関して実行/失敗したアクション。 |
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| このイベントが発生した回数 |
|
| このイベントが最初に観測された時刻。 | |
|
| イベントが最初に記録された時間(サーバーの受信時刻は TypeMeta にあります。) | |
|
|
| ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。 |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| このイベントの最新の発生が記録された時刻。 | |
|
|
| この操作のステータスの、人間が判読できる説明。 |
|
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
|
| これは、オブジェクトの現在のステータスに移行する理由を示す、マシンが理解できる短い文字列である必要があります。 |
|
|
| ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。 |
|
|
|
このイベントを発行したコントローラーの名前 (例: |
|
|
|
コントローラーインスタンスの ID(例: |
|
|
| EventSeries には、一連のイベントに関する情報が含まれています。つまり、しばらくの間継続的に発生していた/発生しているものです。 |
|
|
| EventSource にはイベントの情報が含まれます。 |
|
|
| このイベントのタイプ (通常、警告)、将来的に新しいタイプが追加される可能性があります |
8.1.1. .involvedObject
- 説明
- ObjectReference には参照先のオブジェクトを調査または変更するのに十分な情報が含まれます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 参照先の API バージョン。 |
|
|
| オブジェクト全体ではなく一部を参照する場合に、この文字列には、desiredState.manifest.containers[2] など、有効な JSON/Go フィールドアクセスステートメントを含める必要があります。たとえば、オブジェクトの参照先が Pod 内のコンテナーの場合には、"spec.containers{name}" などの値に設定されます ("name" はイベントをトリガーしたコンテナー名に置き換えます)。またはコンテナー名が指定されていない場合には、"spec.containers[2]" の値に設定されます (この Pod 内でインデックスが 2 のコンテナー)。この構文が選択された唯一の理由は、オブジェクトの一部の参照を明確に定義するためです。 |
|
|
| 参照先の種類。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
|
| 参照先の名前。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#names |
|
|
| 参照先の namespace。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/namespaces/ |
|
|
| この参照が作成される特定の resourceVersion (ある場合)。詳細: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency |
|
|
| 参照先の UID。詳細: https://kubernetes.io/docs/concepts/overview/working-with-objects/names/#uids |
8.1.3. .series
- 説明
- EventSeries には、一連のイベントに関する情報が含まれています。つまり、しばらくの間継続的に発生していた/発生しているものです。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 最後のハートビート時間までのこのシリーズの発生数 |
|
| 観測された最後の発生時刻 |
8.1.4. .source
- 説明
- EventSource にはイベントの情報が含まれます。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| イベントの生成元となるコンポーネント。 |
|
|
| イベントが生成されるノード名。 |
8.2. API エンドポイント
以下の API エンドポイントを利用できます。
/api/v1/events-
GET: 種類が Event のオブジェクトをリスト表示または監視します。
-
/api/v1/watch/events-
GET: イベントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/api/v1/namespaces/{namespace}/events-
DELETE: イベントのコレクションを削除します -
GET: 種類が Event のオブジェクトをリスト表示または監視します。 -
POST: イベントを作成します
-
/api/v1/watch/namespaces/{namespace}/events-
GET: イベントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/api/v1/namespaces/{namespace}/events/{name}-
DELETE: イベントを削除します -
GET: 指定されたイベントを読み取ります -
PATCH: 指定されたイベントを部分的に更新します -
PUT: 指定されたイベントを置き換えます
-
/api/v1/watch/namespaces/{namespace}/events/{name}-
GET: 種類が Event のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
8.2.1. /api/v1/events
- HTTP メソッド
-
GET - 説明
- 種類が Event のオブジェクトをリスト表示または監視します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
8.2.2. /api/v1/watch/events
- HTTP メソッド
-
GET - 説明
- イベントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
8.2.3. /api/v1/namespaces/{namespace}/events
- HTTP メソッド
-
DELETE - 説明
- イベントのコレクションを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が Event のオブジェクトをリスト表示または監視します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- イベントを作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
8.2.4. /api/v1/watch/namespaces/{namespace}/events
- HTTP メソッド
-
GET - 説明
- イベントのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
8.2.5. /api/v1/namespaces/{namespace}/events/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| イベントの名前 |
- HTTP メソッド
-
DELETE - 説明
- イベントを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定されたイベントを読み取る
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定されたイベントを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定されたイベントを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
8.2.6. /api/v1/watch/namespaces/{namespace}/events/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| イベントの名前 |
- HTTP メソッド
-
GET - 説明
- 種類が Event のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
第9章 リース [coordination.k8s.io/v1]
- 説明
- リースは、リースの概念を定義します。
- 型
-
object
9.1. 仕様
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
|
| LeaseSpec は、Lease の仕様です。 |
9.1.1. .spec
- 説明
- LeaseSpec は、Lease の仕様です。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
| acquireTime は、現在のリースが取得された時刻です。 | |
|
|
| holderIdentity には、現在のリースの所有者の ID が含まれます。Coordinated Leader Election が使用される場合、保有者アイデンティティーは、選出された LeaseCandidate.metadata.name フィールドと等しくなければなりません。 |
|
|
| leaseDurationSeconds は、リースの候補者がそれを強制的に取得するのを待つ必要がある期間です。これは、最後に観測された renewTime の時間に対して測定されます。 |
|
|
| leaseTransitions は、所有者間のリースの遷移の数です。 |
|
|
| PreferredHolder は、より適したリース所有者が存在するため、リースを放棄する必要があることをリース所有者に通知します。このフィールドは、ストラテジーも設定されている場合にのみ設定できます。 |
|
| renewTime は、リースの現在の所有者が最後にリースを更新した時刻です。 | |
|
|
| strategy は、coordinated leader election を選ぶためのストラテジーを示します。このフィールドが指定されていない場合、リースにアクティブな調整はありません。(アルファ) このフィールドを使用するには、CoordinatedLeaderElection フィーチャーゲートを有効にする必要があります。 |
9.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/coordination.k8s.io/v1/leases-
GET: 種類が Lease のオブジェクトをリスト表示または監視します。
-
/apis/coordination.k8s.io/v1/watch/leases-
GET: リースのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/coordination.k8s.io/v1/namespaces/{namespace}/leases-
DELETE: リースのコレクションを削除します -
GET: 種類が Lease のオブジェクトをリスト表示または監視します。 -
POST: リースを作成します
-
/apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases-
GET: リースのリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}-
DELETE: リースを削除します -
GET: 指定されたリースを読み取ります -
PATCH: 指定されたリースを部分的に更新します -
PUT: 指定されたリースを置き換えます
-
/apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases/{name}-
GET: 種類が Lease のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
9.2.1. /apis/coordination.k8s.io/v1/leases
- HTTP メソッド
-
GET - 説明
- 種類が Lease のオブジェクトをリスト表示または監視します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
9.2.2. /apis/coordination.k8s.io/v1/watch/leases
- HTTP メソッド
-
GET - 説明
- リースのリストへの個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
9.2.3. /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases
- HTTP メソッド
-
DELETE - 説明
- リースのコレクションを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 種類が Lease のオブジェクトをリスト表示または監視します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- リースを作成する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
9.2.4. /apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases
- HTTP メソッド
-
GET - 説明
- リースのリストへの個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
9.2.5. /apis/coordination.k8s.io/v1/namespaces/{namespace}/leases/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| リースの名前 |
- HTTP メソッド
-
DELETE - 説明
- リースを削除する
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定されたリースを読む
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定されたリースを部分的に更新します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定されたリースを交換してください
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
9.2.6. /apis/coordination.k8s.io/v1/watch/namespaces/{namespace}/leases/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| リースの名前 |
- HTTP メソッド
-
GET - 説明
- 種類が Lease のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
第10章 Namespace [v1]
- 説明
- Namespace は、名前のスコープを提供します。複数の名前空間の使用はオプションです。
- 型
-
object
10.1. 仕様
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| apiVersion はオブジェクトのこの表現のバージョンスキーマを定義します。サーバーは認識されたスキーマを最新の内部値に変換し、認識されない値は拒否することがあります。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources を参照してください。 |
|
|
| kind はこのオブジェクトが表す REST リソースを表す文字列の値です。サーバーはクライアントが要求を送信するエンドポイントからこれを推測できることがあります。これは更新できません。CamelCase を使用します。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds を参照してください。 |
|
| 標準オブジェクトのメタデータ。詳細は、https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#metadata を参照してください。 | |
|
|
| NamespaceSpec は、Namespace の属性を記述します。 |
|
|
| NamespaceStatus は、ネームスペースの現在のステータスに関する情報です。 |
10.1.1. .spec
- 説明
- NamespaceSpec は、Namespace の属性を記述します。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| ファイナライザーは、オブジェクトをストレージから完全に削除するために空にする必要がある不透明な値のリストです。詳細: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/ |
10.1.2. .status
- 説明
- NamespaceStatus は、ネームスペースの現在のステータスに関する情報です。
- 型
-
object
| プロパティー | 型 | 説明 |
|---|---|---|
|
|
| 名前空間の現在の状態の最新の利用可能な観測を表します。 |
|
|
| NamespaceCondition には、namespace の状態の詳細が含まれます。 |
|
|
| フェーズは、名前空間の現在のライフサイクルフェーズです。詳細: https://kubernetes.io/docs/tasks/administer-cluster/namespaces/
使用可能な列挙値: - |
10.1.3. .status.conditions
- 説明
- 名前空間の現在の状態の最新の利用可能な観測を表します。
- 型
-
array
10.1.4. .status.conditions[]
- 説明
- NamespaceCondition には、namespace の状態の詳細が含まれます。
- 型
-
object - 必須
-
type -
status
-
| プロパティー | 型 | 説明 |
|---|---|---|
|
| 最後にある状態から別の状態に遷移した時間。 | |
|
|
| 最後にある状態から別の状態に遷移した時間。 |
|
|
| 条件の最後の遷移の一意の 1 単語の CamelCase 理由。 |
|
|
| 状態のステータス (True、False、Unknown のいずれか)。 |
|
|
| 名前空間コントローラーの状態のタイプ。 |
10.2. API エンドポイント
以下の API エンドポイントを利用できます。
/api/v1/namespaces-
GET: 種類が Namespace のオブジェクトをリスト表示または監視します。 -
POST: Namespace を作成します。
-
/api/v1/watch/namespaces-
GET: Namespace のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
-
/api/v1/namespaces/{name}-
DELETE: Namespace を削除します。 -
GET: 指定された Namespace を読み取ります。 -
PATCH: 指定された Namespace を部分的に更新します。 -
PUT: 指定された Namespace を置き換えます。
-
/api/v1/watch/namespaces/{name}-
GET: 種類が Namespace のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
-
/api/v1/namespaces/{name}/status-
GET: 指定された Namespace のステータスを読み取ります。 -
PATCH: 指定された Namespace のステータスを部分的に更新します。 -
PUT: 指定された Namespace のステータスを置き換えます。
-
/api/v1/namespaces/{name}/finalize-
PUT: 指定された Namespace のファイナライズを置き換えます。
-
10.2.1. /api/v1/namespaces
- HTTP メソッド
-
GET - 説明
- 種類が Namespace のオブジェクトをリスト表示または監視します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- namespace を作成します
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
10.2.2. /api/v1/watch/namespaces
- HTTP メソッド
-
GET - 説明
- Namespace のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
10.2.3. /api/v1/namespaces/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| Namespace の名前です。 |
- HTTP メソッド
-
DELETE - 説明
- Namespace を削除します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された Namespace を読み取ります。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された Namespace を部分的に更新します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された Namespace を置き換えます。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
10.2.4. /api/v1/watch/namespaces/{name}
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| Namespace の名前です。 |
- HTTP メソッド
-
GET - 説明
- 種類が Namespace のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
10.2.5. /api/v1/namespaces/{name}/status
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| Namespace の名前です。 |
- HTTP メソッド
-
GET - 説明
- 指定されたネームスペースのステータスを読み取ります
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された Namespace のステータスを部分的に更新します。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | レスポンスのボディー |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定されたネームスペースのステータスを置き換えます
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
10.2.6. /api/v1/namespaces/{name}/finalize
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| Namespace の名前です。 |
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
| これは、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合はエラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべてのドライランステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです。- Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合は、リクエストが BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
- HTTP メソッド
-
PUT - 説明
- 指定された Namespace の finalize を置き換えます。
| パラメーター | 型 | 説明 |
|---|---|---|
|
|
|
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}