コンテンツにスキップ

削除



POST /api/v1/self_built_checker/delete

概要

セルフビルドインスペクションを論理削除します。

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

この API は、一致したセルフビルドインスペクションのメインレコードのみを論理削除しますが、参照のクリーンアップでは入力 UUID 全体を使用し、参照タイプを問いません(現在のワークスペースに限定されます)。そのため、まずこのモジュールのリストで項目ごとに確認し、通常のモニタリングなど他の Rule の UUID を混在させないでください。メインレコードが一致しなくても、同じワークスペース内の他のタイプの UUID 参照がクリーンアップされる可能性があるため、true を副作用が発生しなかったと見なしてはいけません。削除後、関連するアラートポリシーのキャッシュを非同期でクリアします。生成済みのイベント/生データは同時に削除されず、enable では復元できません。

このワークスペースのこのモジュールのリストにある UUID のみを使用できます。refKey を指定した場合は UUID と組み合わせてフィルタリングされます。独立した一括特定方法ではありません。true を返しますが、項目ごとのヒット数/変更数は返しません。空配列または一致なしでも成功する場合があるため、状態/関連付けは読み戻して確認する必要があります。エラー/タイムアウト時はまず設定の現状を確認してください。削除/コミット後の非同期ディスパッチ失敗は、すでにデータベースに反映されている可能性があります。

リクエストヘッダー

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

Body リクエストパラメータ

パラメータ名 型 必須 説明
refKey string オプションの追加フィルター条件で、各 UUID と同時に一致判定されます。UUID の代替パラメータではなく、refKey のみを渡して集合を操作することはできません。
null 許可: False
例: custom-healthcheck-production
取得または入力方法: 同じビジネス関連キーを追加で確認する必要がある場合に入力します。
ruleUUID string オプションとして宣言されていますが、呼び出し元はこのワークスペースのセルフビルドインスペクション UUID を明示的に非空で指定する必要があります。refKey のみでは対応するオブジェクトは自動選択されません。
null 許可: False
例: rul_self_example
取得または入力方法: このモジュールのリストから対象の UUID を取得します。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/self_built_checker/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"ruleUUID":"rul_self_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 を修正してください。
500 ft.InternalServerError 対象未選択、フィールドの形状または長さの誤り、データベース/コミット後の非同期タスクディスパッチなどの失敗 内部エラー まず現在のルールを読み戻して保存済みか確認してください。このワークスペースで明示的な ruleUUID を指定してから再試行し、traceId を提供してください。

フィードバック

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