10.2. API エンドポイント

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

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

10.2.1. /api/v1/endpoints

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

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

10.2.2. /api/v1/watch/endpoints

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

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

10.2.3. /api/v1/namespaces/{namespace}/endpoints

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

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

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

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

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

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

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

表10.7 本文パラメーター
パラメーター	タイプ	説明
`body`	`Endpoints` スキーマ

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

10.2.4. /api/v1/watch/namespaces/{namespace}/endpoints

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

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

10.2.5. /api/v1/namespaces/{namespace}/endpoints/{name}

表10.10 グローバルパスパラメーター
パラメーター	タイプ	説明
`name`	`string`	エンドポイントの名前

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

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

表10.12 HTTP 応答
HTTP コード	応答本文
200 - OK	`Status` スキーマ
202 - Accepted	`Status` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: 指定されたエンドポイントを読み取ります

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

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

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

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

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

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

表10.17 本文パラメーター
パラメーター	タイプ	説明
`body`	`Endpoints` スキーマ

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

10.2.6. /api/v1/watch/namespaces/{namespace}/endpoints/{name}

表10.19 グローバルパスパラメーター
パラメーター	タイプ	説明
`name`	`string`	エンドポイントの名前

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

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

10.2. API エンドポイント

10.2.1. /api/v1/endpoints

10.2.2. /api/v1/watch/endpoints

10.2.3. /api/v1/namespaces/{namespace}/endpoints

10.2.4. /api/v1/watch/namespaces/{namespace}/endpoints

10.2.5. /api/v1/namespaces/{namespace}/endpoints/{name}

10.2.6. /api/v1/watch/namespaces/{namespace}/endpoints/{name}

詳細情報

試用、購入および販売

コミュニティー

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

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

会社概要

Red Hat legal and privacy links

Red Hat legal and privacy links