16.2. API エンドポイント


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

  • /apis/apps/v1/replicasets

    • GET: ReplicaSet 種類のオブジェクトをリスト表示または監視します
  • /apis/apps/v1/watch/replicasets

    • GET: ReplicaSet のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
  • /apis/apps/v1/namespaces/{namespace}/replicasets

    • DELETE: ReplicaSet のコレクションを削除する
    • GET: ReplicaSet 種類のオブジェクトをリスト表示または監視します
    • POST: ReplicaSet を作成する
  • /apis/apps/v1/watch/namespaces/{namespace}/replicasets

    • GET: ReplicaSet のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
  • /apis/apps/v1/namespaces/{namespace}/replicasets/{name}

    • DELETE: ReplicaSet を削除する
    • GET: 指定された ReplicaSet を読み取る
    • PATCH: 指定された ReplicaSet を部分的に更新する
    • PUT: 指定された ReplicaSet を置き換える
  • /apis/apps/v1/watch/namespaces/{namespace}/replicasets/{name}

    • GET: ReplicaSet 種類のオブジェクトへの変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用し、'fieldSelector' パラメーターで単一の項目にフィルター処理します。
  • /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status

    • GET: 指定された ReplicaSet のステータスを読み取る
    • PATCH: 指定された ReplicaSet のステータスを部分的に更新する
    • PUT: 指定された ReplicaSet のステータスを置き換える

16.2.1. /apis/apps/v1/replicasets

HTTP メソッド
GET
説明
ReplicaSet 種類のオブジェクトをリスト表示または監視する
表16.1 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ReplicaSetList スキーマ

401 - Unauthorized

空白

16.2.2. /apis/apps/v1/watch/replicasets

HTTP メソッド
GET
説明
ReplicaSet のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
表16.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

16.2.3. /apis/apps/v1/namespaces/{namespace}/replicasets

HTTP メソッド
DELETE
説明
ReplicaSet のコレクションを削除する
表16.3 クエリーパラメーター
パラメーター説明

dryRun

string

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

表16.4 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
ReplicaSet 種類のオブジェクトをリスト表示または監視する
表16.5 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ReplicaSetList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
ReplicaSet を作成する
表16.6 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

表16.7 ボディのパラメーター
パラメーター説明

body

ReplicaSet スキーマ

 
表16.8 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ReplicaSet スキーマ

201 - Created

ReplicaSet スキーマ

202 - Accepted

ReplicaSet スキーマ

401 - Unauthorized

空白

16.2.4. /apis/apps/v1/watch/namespaces/{namespace}/replicasets

HTTP メソッド
GET
説明
ReplicaSet のリストに対する個々の変更を監視します。非推奨: 代わりに、リスト操作で 'watch' パラメーターを使用してください。
表16.9 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

16.2.5. /apis/apps/v1/namespaces/{namespace}/replicasets/{name}

表16.10 グローバルパスパラメーター
パラメーター説明

name

string

ReplicaSet の名前

HTTP メソッド
DELETE
説明
ReplicaSet を削除する
表16.11 クエリーパラメーター
パラメーター説明

dryRun

string

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

表16.12 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された ReplicaSet を読み取る
表16.13 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ReplicaSet スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された ReplicaSet を部分的に更新する
表16.14 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

表16.15 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ReplicaSet スキーマ

201 - Created

ReplicaSet スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された ReplicaSet を置き換える
表16.16 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

表16.17 ボディのパラメーター
パラメーター説明

body

ReplicaSet スキーマ

 
表16.18 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ReplicaSet スキーマ

201 - Created

ReplicaSet スキーマ

401 - Unauthorized

空白

16.2.6. /apis/apps/v1/watch/namespaces/{namespace}/replicasets/{name}

表16.19 グローバルパスパラメーター
パラメーター説明

name

string

ReplicaSet の名前

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

200 - OK

WatchEvent スキーマ

401 - Unauthorized

空白

16.2.7. /apis/apps/v1/namespaces/{namespace}/replicasets/{name}/status

表16.21 グローバルパスパラメーター
パラメーター説明

name

string

ReplicaSet の名前

HTTP メソッド
GET
説明
指定された ReplicaSet のステータスを読み取る
表16.22 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ReplicaSet スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定された ReplicaSet のステータスを部分的に更新する
表16.23 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

表16.24 HTTP レスポンス
HTTP コードレスポンスのボディー

200 - OK

ReplicaSet スキーマ

201 - Created

ReplicaSet スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定された ReplicaSet のステータスを置き換える
表16.25 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

表16.26 ボディのパラメーター
パラメーター説明

body

ReplicaSet スキーマ

 
表16.27 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

ReplicaSet スキーマ

201 - Created

ReplicaSet スキーマ

401 - Unauthorized

空白

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

© 2024 Red Hat, Inc.