9.2. API エンドポイント
以下の API エンドポイントを利用できます。
/apis/monitoring.coreos.com/v1/prometheusrules-
GET: 種類 PrometheusRule のオブジェクトをリスト表示します
-
/apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheusrules-
DELETE:PrometheusRule のコレクションを削除します -
GET: 種類 PrometheusRule のオブジェクトをリスト表示します -
POST:PrometheusRule を作成します
-
/apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheusrules/{name}-
削除:PrometheusRule を削除します -
GET: 指定された PrometheusRule を読み取ります -
PATCH: 指定された PrometheusRule を部分的に更新します -
PUT: 指定された PrometheusRule を置き換えます
-
9.2.1. /apis/monitoring.coreos.com/v1/prometheusrules
- HTTP メソッド
-
GET - Description
- PrometheusRule の種類のオブジェクトをリスト表示します
| HTTP コード | 応答本文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
9.2.2. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheusrules
- HTTP メソッド
-
DELETE - Description
- PrometheusRule のコレクションを削除します
| HTTP コード | 応答本文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - Description
- PrometheusRule の種類のオブジェクトをリスト表示します
| HTTP コード | 応答本文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
POST - Description
- PrometheusRule を作成する
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合は、エラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです - Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答本文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
9.2.3. /apis/monitoring.coreos.com/v1/namespaces/{namespace}/prometheusrules/{name}
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| PrometheusRule の名前 |
- HTTP メソッド
-
DELETE - Description
- PrometheusRule を削除します
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合は、エラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
| HTTP コード | 応答本文 |
|---|---|
| 200 - OK |
|
| 202 - Accepted |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
GET - Description
- 指定された PrometheusRule を読み取ります
| HTTP コード | 応答本文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PATCH - Description
- 指定された PrometheusRule を部分的に更新します
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合は、エラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです - Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| HTTP コード | 応答本文 |
|---|---|
| 200 - OK |
|
| 401 - Unauthorized | 空白 |
- HTTP メソッド
-
PUT - Description
- 指定された PrometheusRule を置き換えます
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
| これが指定されている場合は、変更を永続化してはならないことを示します。dryRun ディレクティブが無効な場合や、認識されない場合は、エラーの応答が返され、その要求に対する処理はこれ以上行われません。有効な値は All で、すべての dryRun ステージが処理されます。 |
|
|
| fieldValidation は、不明なフィールドまたは重複したフィールドを含むリクエスト (POST/PUT/PATCH) 内のオブジェクトを処理する方法をサーバーに指示します。有効な値は Ignore です。オブジェクトからサイレントにドロップされた不明なフィールドを無視し、デコーダーが検出した最後の重複フィールドを除くすべてを無視します。これは、v1.23 より前のデフォルトの動作です。- Warn: オブジェクトから削除された不明なフィールドごと、および検出された重複フィールドごとに、標準の警告応答ヘッダーを介して警告が送信されます。他にエラーがなければ要求は成功し、重複するフィールドの最後のものだけを保持します。これは v1.23 以降のデフォルトです - Strict: 不明なフィールドがオブジェクトから削除される場合、または重複フィールドが存在する場合、リクエストは BadRequest エラーで失敗します。サーバーから返されるエラーには、検出されたすべての不明な重複フィールドが含まれます。 |
| パラメーター | タイプ | 説明 |
|---|---|---|
|
|
|
| HTTP コード | 応答本文 |
|---|---|
| 200 - OK |
|
| 201 - Created |
|
| 401 - Unauthorized | 空白 |
