17.2. API エンドポイント

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

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

17.2.1. /apis/config.openshift.io/v1/networks

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

表17.1 HTTP 応答
HTTP コード	応答本文
200 - OK	`Status` schema
401 - Unauthorized	空白

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

表17.2 HTTP 応答
HTTP コード	応答本文
200 - OK	`NetworkList` スキーマ
401 - Unauthorized	空白

HTTP メソッド: POST
説明: ネットワークの作成

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

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

表17.5 HTTP 応答
HTTP コード	応答本文
200 - OK	`Network` スキーマ
201 - Created	`Network` スキーマ
202 - Accepted	`Network` スキーマ
401 - Unauthorized	空白

17.2.2. /apis/config.openshift.io/v1/networks/{name}

表17.6 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	ネットワークの名前

HTTP メソッド: DELETE
説明: ネットワークの削除

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

表17.8 HTTP 応答
HTTP コード	応答本文
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	空白

HTTP メソッド: GET
説明: 指定されたネットワークを読み取る

表17.9 HTTP 応答
HTTP コード	応答本文
200 - OK	`Network` スキーマ
401 - Unauthorized	空白

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

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

表17.11 HTTP 応答
HTTP コード	応答本文
200 - OK	`Network` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PUT
説明: 指定されたネットワークを交換してください

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

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

表17.14 HTTP 応答
HTTP コード	応答本文
200 - OK	`Network` スキーマ
201 - Created	`Network` スキーマ
401 - Unauthorized	空白

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

© 2024 Red Hat, Inc.