6.2. API エンドポイント


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

  • /apis/tuned.openshift.io/v1/tuneds

    • GET: 調整された種類のオブジェクトをリスト表示します
  • /apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds

    • DELETE:Tuned のコレクションを削除します
    • GET: 調整された種類のオブジェクトをリスト表示します
    • POST: 調整済みを作成します
  • /apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds/{name}

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

6.2.1. /apis/tuned.openshift.io/v1/tuneds

HTTP メソッド
GET
Description
調整された種類のオブジェクトをリスト表示します
表6.1 HTTP 応答
HTTP コード応答本文

200 - OK

TunedList スキーマ

401 - Unauthorized

空白

6.2.2. /apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds

HTTP メソッド
DELETE
Description
調整済みのコレクションを削除する
表6.2 HTTP 応答
HTTP コード応答本文

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
Description
調整された種類のオブジェクトをリスト表示します
表6.3 HTTP 応答
HTTP コード応答本文

200 - OK

TunedList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
Description
チューンドを作成する
表6.4 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

fieldValidation

string

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

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

ボディー

TuneD スキーマ

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

200 - OK

TuneD スキーマ

201 - Created

TuneD スキーマ

202 - Accepted

TuneD スキーマ

401 - Unauthorized

空白

6.2.3. /apis/tuned.openshift.io/v1/namespaces/{namespace}/tuneds/{name}

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

name

string

チューンドの名前

HTTP メソッド
DELETE
Description
調整済みを削除する
表6.8 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

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

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
Description
指定された Tuned を読む
表6.10 HTTP 応答
HTTP コード応答本文

200 - OK

TuneD スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

200 - OK

TuneD スキーマ

401 - Unauthorized

空白

HTTP メソッド
PUT
Description
指定された Tuned を交換してください
表6.13 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

fieldValidation

string

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

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

ボディー

TuneD スキーマ

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

200 - OK

TuneD スキーマ

201 - Created

TuneD スキーマ

401 - Unauthorized

空白

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

© 2024 Red Hat, Inc.