15.2. API エンドポイント


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

  • /apis/config.openshift.io/v1/infrastructures

    • 削除: インフラストラクチャーのコレクションを削除します
    • GET: インフラストラクチャーの種類のオブジェクトをリスト表示します
    • POST: インフラストラクチャーを作成する
  • /apis/config.openshift.io/v1/infrastructures/{name}

    • 削除: インフラストラクチャーを削除します
    • GET: 指定されたインフラストラクチャーを読み取ります
    • PATCH: 指定されたインフラストラクチャーを部分的に更新します
    • PUT: 指定されたインフラストラクチャーを置き換えます
  • /apis/config.openshift.io/v1/infrastructures/{name}/status

    • GET: 指定されたインフラストラクチャーのステータスを読み取ります
    • PATCH: 指定されたインフラストラクチャーのステータスを部分的に更新します
    • PUT: 指定されたインフラストラクチャーのステータスを置き換えます

15.2.1. /apis/config.openshift.io/v1/infrastructures

HTTP メソッド
DELETE
説明
インフラストラクチャーのコレクションを削除する
表15.1 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
インフラストラクチャーの種類のオブジェクトをリスト表示します
表15.2 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

InfrastructureList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
インフラストラクチャーを作成する
表15.3 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

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

body

Infrastructure スキーマ

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

200 - OK

Infrastructure スキーマ

201 - Created

Infrastructure スキーマ

202 - Accepted

Infrastructure スキーマ

401 - Unauthorized

空白

15.2.2. /apis/config.openshift.io/v1/infrastructures/{name}

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

name

string

インフラストラクチャーの名前

HTTP メソッド
DELETE
説明
インフラストラクチャーを削除する
表15.7 クエリーパラメーター
パラメーター説明

dryRun

string

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

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

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定されたインフラストラクチャーを読む
表15.9 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Infrastructure スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定されたインフラストラクチャーを部分的に更新します
表15.10 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

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

200 - OK

Infrastructure スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定されたインフラストラクチャーを交換してください
表15.12 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

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

body

Infrastructure スキーマ

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

200 - OK

Infrastructure スキーマ

201 - Created

Infrastructure スキーマ

401 - Unauthorized

空白

15.2.3. /apis/config.openshift.io/v1/infrastructures/{name}/status

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

name

string

インフラストラクチャーの名前

HTTP メソッド
GET
説明
指定されたインフラストラクチャーのステータスを読み取ります
表15.16 HTTP 応答
HTTP コードレスポンスのボディー

200 - OK

Infrastructure スキーマ

401 - Unauthorized

空白

HTTP メソッド
PATCH
説明
指定されたインフラストラクチャーのステータスを部分的に更新します
表15.17 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

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

200 - OK

Infrastructure スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
説明
指定されたインフラストラクチャーのステータスを置き換えます
表15.19 クエリーパラメーター
パラメーター説明

dryRun

string

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

fieldValidation

string

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

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

body

Infrastructure スキーマ

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

200 - OK

Infrastructure スキーマ

201 - Created

Infrastructure スキーマ

401 - Unauthorized

空白

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

© 2024 Red Hat, Inc.