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 で、すべての dryRun ステージが処理されます。
`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 で、すべての dryRun ステージが処理されます。

表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 で、すべての dryRun ステージが処理されます。
`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 で、すべての dryRun ステージが処理されます。
`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 で、すべての dryRun ステージが処理されます。
`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 で、すべての dryRun ステージが処理されます。
`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 で、すべての dryRun ステージが処理されます。
`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	空白

10.2. API エンドポイント

10.2.1. /api/v1/namespaces

10.2.2. /api/v1/watch/namespaces

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

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

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

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

詳細情報

試用、購入および販売

コミュニティー

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

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

会社概要

Red Hat legal and privacy links

Red Hat legal and privacy links