5.2. API エンドポイント

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

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

5.2.1. /apis/user.openshift.io/v1/users

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

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

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

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

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

HTTP メソッド: POST
説明: User を作成する

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

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

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

5.2.2. /apis/user.openshift.io/v1/watch/users

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

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

5.2.3. /apis/user.openshift.io/v1/users/{name}

表5.8 グローバルパスパラメーター
パラメーター	タイプ	説明
`name`	`string`	User の名前

HTTP メソッド: DELETE
説明: User を削除する

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

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

HTTP メソッド: GET
説明: 指定された User を読み取る

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

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

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

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

HTTP メソッド: PUT
説明: 指定された User を置き換える

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

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

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

5.2.4. /apis/user.openshift.io/v1/watch/users/{name}

表5.17 グローバルパスパラメーター
パラメーター	タイプ	説明
`name`	`string`	User の名前

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

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

5.2. API エンドポイント

5.2.1. /apis/user.openshift.io/v1/users

5.2.2. /apis/user.openshift.io/v1/watch/users

5.2.3. /apis/user.openshift.io/v1/users/{name}

5.2.4. /apis/user.openshift.io/v1/watch/users/{name}

詳細情報

試用、購入および販売

コミュニティー

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

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

会社概要

Red Hat legal and privacy links

Red Hat legal and privacy links