23.2. API エンドポイント

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

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

23.2.1. /api/v1/services

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

表23.1 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`ServiceList` スキーマ
401 - Unauthorized	空白

23.2.2. /api/v1/watch/services

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

表23.2 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

23.2.3. /api/v1/namespaces/{namespace}/services

HTTP メソッド: DELETE
説明: Service のコレクションを削除します。

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

表23.4 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Status` スキーマ
401 - Unauthorized	空白

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

表23.5 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`ServiceList` スキーマ
401 - Unauthorized	空白

HTTP メソッド: POST
説明: サービスを作成します。

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

表23.7 ボディのパラメーター
パラメーター	型	説明
`body`	`Service` スキーマ

表23.8 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Service` スキーマ
201 - Created	`Service` スキーマ
202 - Accepted	`Service` スキーマ
401 - Unauthorized	空白

23.2.4. /api/v1/watch/namespaces/{namespace}/services

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

表23.9 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

23.2.5. /api/v1/namespaces/{namespace}/services/{name}

表23.10 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	サービスの名前

HTTP メソッド: DELETE
説明: サービスを削除する

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

表23.12 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Service` スキーマ
202 - Accepted	`Service` スキーマ
401 - Unauthorized	空白

HTTP メソッド: GET
説明: 指定されたサービスを読む

表23.13 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Service` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PATCH
説明: 指定されたサービスを部分的に更新します

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

表23.15 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Service` スキーマ
201 - Created	`Service` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PUT
説明: 指定されたサービスを交換してください

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

表23.17 ボディのパラメーター
パラメーター	型	説明
`body`	`Service` スキーマ

表23.18 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Service` スキーマ
201 - Created	`Service` スキーマ
401 - Unauthorized	空白

23.2.6. /api/v1/watch/namespaces/{namespace}/services/{name}

表23.19 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	サービスの名前

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

表23.20 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`WatchEvent` スキーマ
401 - Unauthorized	空白

23.2.7. /api/v1/namespaces/{namespace}/services/{name}/status

表23.21 グローバルパスパラメーター
パラメーター	型	説明
`name`	`string`	サービスの名前

HTTP メソッド: GET
説明: 指定されたサービスのステータスを読み取ります

表23.22 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Service` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PATCH
説明: 指定されたサービスのステータスを部分的に更新します

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

表23.24 HTTP レスポンス
HTTP コード	レスポンスのボディー
200 - OK	`Service` スキーマ
201 - Created	`Service` スキーマ
401 - Unauthorized	空白

HTTP メソッド: PUT
説明: 指定されたサービスのステータスを置き換えます

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

表23.26 ボディのパラメーター
パラメーター	型	説明
`body`	`Service` スキーマ

表23.27 HTTP 応答
HTTP コード	レスポンスのボディー
200 - OK	`Service` スキーマ
201 - Created	`Service` スキーマ
401 - Unauthorized	空白

23.2. API エンドポイント

23.2.1. /api/v1/services

23.2.2. /api/v1/watch/services

23.2.3. /api/v1/namespaces/{namespace}/services

23.2.4. /api/v1/watch/namespaces/{namespace}/services

23.2.5. /api/v1/namespaces/{namespace}/services/{name}

23.2.6. /api/v1/watch/namespaces/{namespace}/services/{name}

23.2.7. /api/v1/namespaces/{namespace}/services/{name}/status

詳細情報

試用、購入および販売

コミュニティー

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

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

会社概要

Red Hat legal and privacy links

Red Hat legal and privacy links