削除¶
POST /api/v1/alert_policy/delete
概要¶
現在のワークスペースのアラートポリシーを一括削除し、対応するモニターおよびセキュリティルールの関連付けをクリーンアップして、キャッシュを更新します。
呼び出し前と使用手順¶
アラートポリシー一覧から対象 UUID を取得し、当該通知ルールが不要になったことを確認してから送信してください。見つかった各ポリシーについてカスタム操作権限を検証します。一致するポリシーがない場合は ObjectNotExists を返します。ポリシーを削除しても、モニター/SLO/セキュリティルールのリソース自体は削除されません。現在明示的にクリーンアップされるのは通常のモニターとセキュリティルールの関連付けであり、SLO の関連付けが自動的に解除されると一概に仮定することはできません。削除後は関連付け画面で確認する必要があります。成功時は true を返します。キャッシュのクリーンアップと一部の関連付けキャッシュ更新には非同期処理が含まれます。すでに処理中の通知が取り消されることは保証されません。保存およびキャッシュ更新は、通知の配信を意味するものではありません。実際の送信は、有効な通知先、イベントレベル、時間帯、フィルター、重複抑制、およびアラート実行サービスに依存します。失敗またはタイムアウト後は、まずポリシーとバインディング状態を読み取り、重複作成や部分更新の誤判定を避けてください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| alertPolicyUUIDs[*] | string | 単一の altpl_ アラートポリシー UUID。 例: altpl_example取得または入力方法: アラートポリシー一覧からポリシー UUID を 1 つコピーします。 |
|
| alertPolicyUUIDs | array | Y | 削除対象のアラートポリシー UUID 配列。必須です。空でない配列を送信することを推奨します。現在のワークスペース内の未削除のポリシーのみを処理します。 null を許可: False 例: ["altpl_example"]取得または入力方法: アラートポリシー一覧の content.data[].uuid から、同一ワークスペース内の対象 UUID を取得します。 |
パラメータ補足説明¶
一括指定内に存在しない個別の UUID があっても、項目ごとにエラーが返されることは保証されません。一覧と関連情報を再取得して最終結果を確認してください。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/alert_policy/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"alertPolicyUUIDs":["altpl_example"]}'
レスポンス¶
HTTP 200、application/json。以下の例では、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 削除処理が成功した場合は true。UUID ごとの結果は提供されません。 |
{
"code": 200,
"content": true,
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反している | パラメータ解析に失敗しました | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | JSON のトップレベルがオブジェクトではありません | 一部の JSON ファイル形式エラー | 単一の JSON オブジェクトを送信してください。 |
| 404 | ft.ObjectNotExists | 現在のワークスペースに、空配列の場合を含め、一致する未削除のポリシーが存在しない | 指定されたオブジェクトが存在しません | UUID とワークスペースを再確認してください。 |
| 403 | ft.ForbiddenAlertPolicyOperation | いずれかのポリシーで現在のアイデンティティによる操作が許可されていません | アラートポリシー【{}】を操作する権限がありません | まずこれらのポリシーの操作権限を取得してください。 |
| 403 | ft.Forbidden | 現在のアイデンティティに API 操作権限がありません | 操作権限がありません | 削除権限を持つ API Key を使用してください。 |
| 500 | ft.InternalServerError | 関連付け、キャッシュ、またはその他の削除処理に失敗 | 内部エラー | まずポリシーと関連付けの状態を確認してから再試行を判断してください。継続的に失敗する場合は traceId を提供してください。 |