サポートコンソール開発者トライアルの開始お問い合わせ

8.2. API エンドポイント

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

  • /apis/metal3.io/v1alpha1/hostfirmwaresettings

    • GET: 種類の HostFirmwareSettings のオブジェクトをリスト表示します

  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings

    • 削除:HostFirmwareSettings のコレクションを削除します
    • GET: 種類の HostFirmwareSettings のオブジェクトをリスト表示します
    • POST:HostFirmwareSettings を作成します

  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings/{name}

    • 削除:HostFirmwareSettings を削除します
    • GET: 指定された HostFirmwareSettings を読み取ります
    • PATCH: 指定された HostFirmwareSettings を部分的に更新します
    • PUT: 指定された HostFirmwareSettings を置き換えます

  • /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings/{name}/status

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

8.2.1. /apis/metal3.io/v1alpha1/hostfirmwaresettings

HTTP メソッド
GET
Description
HostFirmwareSettings の種類のオブジェクトをリスト表示します
表8.1 HTTP 応答
HTTP コード応答本文

200 - OK

HostFirmwareSettingsList schema

401 - Unauthorized

空白

8.2.2. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings

HTTP メソッド
DELETE
Description
HostFirmwareSettings のコレクションを削除します
表8.2 HTTP 応答
HTTP コード応答本文

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
Description
HostFirmwareSettings の種類のオブジェクトをリスト表示します
表8.3 HTTP 応答
HTTP コード応答本文

200 - OK

HostFirmwareSettingsList schema

401 - Unauthorized

空白

HTTP メソッド
POST
Description
HostFirmwareSettings を作成します
表8.4 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

fieldValidation

string

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

表8.5 本文パラメーター
パラメータータイプ説明

ボディー

HostFirmwareSettings schema

 
表8.6 HTTP 応答
HTTP コード応答本文

200 - OK

HostFirmwareSettings schema

201 - Created

HostFirmwareSettings schema

202 - Accepted

HostFirmwareSettings schema

401 - Unauthorized

空白

8.2.3. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings/{name}

表8.7 グローバルパスパラメーター
パラメータータイプ説明

name

string

HostFirmwareSettings の名前

HTTP メソッド
DELETE
Description
HostFirmwareSettings を削除します
表8.8 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

表8.9 HTTP 応答
HTTP コード応答本文

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
Description
指定された HostFirmwareSettings を読み取ります
表8.10 HTTP 応答
HTTP コード応答本文

200 - OK

HostFirmwareSettings schema

401 - Unauthorized

空白

HTTP メソッド
PATCH
Description
指定された HostFirmwareSettings を部分的に更新します
表8.11 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

fieldValidation

string

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

表8.12 HTTP 応答
HTTP コード応答本文

200 - OK

HostFirmwareSettings schema

401 - Unauthorized

空白

HTTP メソッド
PUT
Description
指定された HostFirmwareSettings を置き換えます
表8.13 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

fieldValidation

string

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

表8.14 本文パラメーター
パラメータータイプ説明

ボディー

HostFirmwareSettings schema

 
表8.15 HTTP 応答
HTTP コード応答本文

200 - OK

HostFirmwareSettings schema

201 - Created

HostFirmwareSettings schema

401 - Unauthorized

空白

8.2.4. /apis/metal3.io/v1alpha1/namespaces/{namespace}/hostfirmwaresettings/{name}/status

表8.16 グローバルパスパラメーター
パラメータータイプ説明

name

string

HostFirmwareSettings の名前

HTTP メソッド
GET
Description
指定された HostFirmwareSettings のステータスを読み取ります
表8.17 HTTP 応答
HTTP コード応答本文

200 - OK

HostFirmwareSettings schema

401 - Unauthorized

空白

HTTP メソッド
PATCH
Description
指定された HostFirmwareSettings のステータスを部分的に更新します
表8.18 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

fieldValidation

string

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

表8.19 HTTP 応答
HTTP コード応答本文

200 - OK

HostFirmwareSettings schema

401 - Unauthorized

空白

HTTP メソッド
PUT
Description
指定された HostFirmwareSettings のステータスを置き換えます
表8.20 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

fieldValidation

string

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

表8.21 本文パラメーター
パラメータータイプ説明

ボディー

HostFirmwareSettings schema

 
表8.22 HTTP 応答
HTTP コード応答本文

200 - OK

HostFirmwareSettings schema

201 - Created

HostFirmwareSettings schema

401 - Unauthorized

空白

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

© 2024 Red Hat, Inc.