コンテンツにスキップ

削除



POST /api/v1/checker/delete

概要

モニター、スケジュール、および関連参照を一括削除します。

呼び出し前の確認と使用手順

まずすべての対象 UUID と影響範囲を確認し、本ワークスペースのモニター一覧に従って項目ごとに選択します。関連するメイン/サブ/クロスワークスペースのスケジュールを同期削除し、その後ルールをソフト削除して本ワークスペースに関連する EntityRef 参照をクリーンアップします。旧イベントと元のモニタリングデータはルールの削除に伴って削除されません。削除対象外のヒットが少なくとも 1 件ある場合のみ処理を続行し、空配列またはすべて未ヒットの場合は ObjectNotExists を返します。現在のメソッドは type を限定していないため、本モジュールのルール UUID のみを使用し、他の Rule を誤って削除しないでください。一部の UUID が一致しなくても項目ごとにエラーは報告されません。参照のクリーンアップは入力集合全体に対して行われるため、無主設定のヒット有無から本ワークスペースの対応する参照が影響を受けていないと判断することはできません。その後、関連する SLO などの参照が非同期で更新されるため、完了前はページの状態が遅延する可能性があります。

各対象についてカスタム操作権限が 1 件ずつ検証されますが、API Key インターフェース権限も引き続き必要です。スケジュールサービス、データベースコミット、参照のクリーンアップ、非同期ディスパッチはサービスをまたぐアトミックトランザクションではありません。異常発生時には一部の状態やスケジュールがすでに更新されている可能性があるため、まず設定とスケジュールの現在の状態を読み戻してから再試行し、HTTP 200 のみで検収しないでください。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Body リクエストパラメータ

パラメータ名 型 必須 説明
ruleUUIDs[*] string グループ、履歴、SLO、または生成メトリクスの UUID ではありません。
例: rul_checker_example
取得または入力方法: 現在のワークスペースで操作可能な単一のモニター uuid。
ruleUUIDs array Y 必須の配列で、空でないことを推奨します。これらの共有メソッドはモニターのカテゴリを追加で限定していないため、rul_ プレフィックスのみを根拠に他の Rule リソース UUID を混入させないでください。
null を許可: False
例: ["rul_checker_example"]
取得または入力方法: モニター一覧から対象の type ごとに本ワークスペースの uuid を取得します。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/checker/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ruleUUIDs":["rul_checker_example"]}'

レスポンス

HTTP 200、application/json。以下の例は直接読み取れる主要なフィールドを示しています。

フィールド 型 説明
content boolean 成功時は true です。項目ごとのヒット数や下流の実行検収結果ではありません。
{
  "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 Body のトップレベルがオブジェクトでない(配列/文字列など) 一部の json ファイルの形式エラー 例に従って JSON オブジェクトを送信してください。checkers や event の配列を直接送信することはできません。
403 ft.ForbiddenCheckerOperation 対象の通常モニターに対する操作権限がない モニター【{}】の操作権限がありません owner またはルールで許可された操作主体を使用し、API Key の権限を確認してください。
403 ft.ForbiddenSmartCheckerOperation 対象のインテリジェント/AI モニタリングに対する操作権限がない インテリジェントモニタリング【{}】の操作権限がありません 該当ルールの permissionSet と操作アイデンティティを確認してください。
400 ft.OuterFuncFailed スケジュールの一括起動/停止/削除が明確な業務失敗を返す 外部関数の呼び出しに失敗しました スケジュールとルールの状態を確認してから再試行し、traceId を提供してください。
500 ft.InternalServerError スケジュール接続/タイムアウト/無効な JSON などの未捕捉例外、ストレージ、参照、またはコミット後の非同期ディスパッチの失敗 内部エラー まず各オブジェクトとスケジュールの現在の状態を読み取り、完了済みの手順を確認したうえで対象を絞って再試行し、traceId を提供してください。
404 ft.ObjectNotExists コレクション内に本ワークスペースの非削除ルールのヒットが 1 件もない([] を含む) 指定されたオブジェクトが存在しません 現在の一覧から有効な UUID を再取得してください。削除済みのオブジェクトはこのレスポンスでは復元できません。

フィードバック

このページは役に立ちましたか?