3.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/apiextensions.k8s.io/v1/customresourcedefinitions-
DELETE:CustomResourceDefinition のコレクションを削除します -
GET:CustomResourceDefinition の種類のオブジェクトをリスト表示または監視します -
POST:CustomResourceDefinition を作成します
-
/apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions-
GET:CustomResourceDefinition のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で watch パラメーターを使用してください。
-
/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}-
削除:CustomResourceDefinition を削除します -
GET: 指定された CustomResourceDefinition を読み取ります -
PATCH: 指定された CustomResourceDefinition を部分的に更新します -
PUT: 指定された CustomResourceDefinition を置き換えます
-
/apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions/{name}-
GET:CustomResourceDefinition の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で watch パラメーターを使用し、fieldSelector パラメーターで単一の項目にフィルター処理します。
-
/apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status-
GET: 指定された CustomResourceDefinition のステータスを読み取ります -
PATCH: 指定された CustomResourceDefinition のステータスを部分的に更新します -
PUT: 指定された CustomResourceDefinition のステータスを置き換えます
-
3.2.1. /apis/apiextensions.k8s.io/v1/customresourcedefinitions
- HTTP メソッド
-
DELETE - 説明
- CustomResourceDefinition のコレクションを削除します
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合は、エラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
| HTTP コード | 応答本文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- CustomResourceDefinition の種類のオブジェクトをリスト表示または監視する
| HTTP コード | 応答本文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - 説明
- CustomResourceDefinition を作成します
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合は、エラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです - Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| HTTP コード | 応答本文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 202 - Accepted | |
| 401 - Unauthorized | 空白 |
3.2.2. /apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions
- HTTP メソッド
-
GET - 説明
- CustomResourceDefinition のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で watch パラメーターを使用してください。
| HTTP コード | 応答本文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
3.2.3. /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| CustomResourceDefinition の名前 |
- HTTP メソッド
-
DELETE - 説明
- CustomResourceDefinition を削除します
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合は、エラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
| HTTP コード | 応答本文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - 説明
- 指定された CustomResourceDefinition を読み取ります
| HTTP コード | 応答本文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された CustomResourceDefinition を部分的に更新します
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合は、エラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです - Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答本文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された CustomResourceDefinition を置き換えます
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合は、エラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです - Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| HTTP コード | 応答本文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空白 |
3.2.4. /apis/apiextensions.k8s.io/v1/watch/customresourcedefinitions/{name}
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| CustomResourceDefinition の名前 |
- HTTP メソッド
-
GET - 説明
- CustomResourceDefinition の種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で watch パラメーターを使用し、fieldSelector パラメーターで単一の項目にフィルター処理します。
| HTTP コード | 応答本文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
3.2.5. /apis/apiextensions.k8s.io/v1/customresourcedefinitions/{name}/status
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| CustomResourceDefinition の名前 |
- HTTP メソッド
-
GET - 説明
- 指定された CustomResourceDefinition のステータスを読み取ります
| HTTP コード | 応答本文 |
|---|---|
| 200 - OK | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - 説明
- 指定された CustomResourceDefinition のステータスを部分的に更新します
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合は、エラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです - Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答本文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - 説明
- 指定された CustomResourceDefinition のステータスを置き換えます
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合は、エラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです - Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| HTTP コード | 応答本文 |
|---|---|
| 200 - OK | |
| 201 - Created | |
| 401 - Unauthorized | 空白 |
