5.2. API エンドポイント


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

  • /apis/monitoring.openshift.io/v1/alertingrules

    • GET: AlertingRule 種類のオブジェクトを一覧表示します
  • /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertingrules

    • DELETE: AlertingRule のコレクションを削除します
    • GET: AlertingRule 種類のオブジェクトを一覧表示します
    • POST: AlertingRule を作成します
  • /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertingrules/{name}

    • DELETE: AlertingRule を削除します
    • GET: 指定された AlertingRule を読み取ります
    • PATCH: 指定された AlertingRule を部分的に更新します
    • PUT: 指定された AlertingRule を置き換えます
  • /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertingrules/{name}/status

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

5.2.1. /apis/monitoring.openshift.io/v1/alertingrules

HTTP メソッド
GET
説明
AlertingRule 種類のオブジェクトを一覧表示します
表5.1 HTTP 応答
HTTP コード応答本文

200 - OK

AlertingRuleList スキーマ

401 - Unauthorized

空白

5.2.2. /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertingrules

HTTP メソッド
DELETE
説明
AlertingRule のコレクションを削除します
表5.2 HTTP 応答
HTTP コード応答本文

200 - OK

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
AlertingRule 種類のオブジェクトを一覧表示します
表5.3 HTTP 応答
HTTP コード応答本文

200 - OK

AlertingRuleList スキーマ

401 - Unauthorized

空白

HTTP メソッド
POST
説明
AlertingRule の作成
表5.4 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

fieldValidation

string

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

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

body

AlertingRule スキーマ

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

200 - OK

AlertingRule スキーマ

201 - Created

AlertingRule スキーマ

202 - Accepted

AlertingRule スキーマ

401 - Unauthorized

空白

5.2.3. /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertingrules/{name}

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

name

string

AlertingRule の名前

HTTP メソッド
DELETE
説明
AlertingRule の削除
表5.8 クエリーパラメーター
パラメータータイプ説明

dryRun

string

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

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

200 - OK

Status スキーマ

202 - Accepted

Status スキーマ

401 - Unauthorized

空白

HTTP メソッド
GET
説明
指定された AlertingRule を読み取ります
表5.10 HTTP 応答
HTTP コード応答本文

200 - OK

AlertingRule スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

200 - OK

AlertingRule スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

body

AlertingRule スキーマ

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

200 - OK

AlertingRule スキーマ

201 - Created

AlertingRule スキーマ

401 - Unauthorized

空白

5.2.4. /apis/monitoring.openshift.io/v1/namespaces/{namespace}/alertingrules/{name}/status

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

name

string

AlertingRule の名前

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

200 - OK

AlertingRule スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

200 - OK

AlertingRule スキーマ

401 - Unauthorized

空白

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

dryRun

string

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

fieldValidation

string

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

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

body

AlertingRule スキーマ

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

200 - OK

AlertingRule スキーマ

201 - Created

AlertingRule スキーマ

401 - Unauthorized

空白

Red Hat logoGithubRedditYoutubeTwitter

詳細情報

試用、購入および販売

コミュニティー

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

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

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

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

会社概要

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

© 2024 Red Hat, Inc.