一括削除¶
POST /api/v1/self_built_checker/batch_delete
概要¶
セルフホストチェッカーを一括でソフト削除します。
呼び出し前の確認と使用手順¶
本 API は、一致したセルフホストチェッカーに基づいて主レコードのみをソフト削除しますが、参照のクリーンアップには入力された完全な UUID を使用し、参照タイプを限定しません(現在のワークスペースに限定されます)。そのため、必ず本モジュールの一覧から項目ごとに確認し、通常のモニターなど他の Rule UUID を混在させないでください。主レコードが一致していなくても、同じワークスペース内の他タイプの UUID 参照がクリーンアップされる可能性があるため、true を副作用が発生していない状態とみなすことはできません。削除後、関連するアラートポリシーのキャッシュは非同期でクリアされます。生成済みのイベント/元データはこれに伴って削除されず、enable によって復元することもできません。
使用できるのは、現在のワークスペースの本モジュール一覧に含まれる UUID のみです。refKey を指定した場合は UUID と組み合わせて絞り込みますが、単独で一括対象を特定する方法ではありません。true を返しますが、項目ごとのヒット数/変更数は返しません。空配列または一致なしでも成功する場合があるため、状態/関連付けは読み戻して確認する必要があります。エラー/タイムアウト時はまず現在の設定状態を確認してください。削除/送信後の非同期ディスパッチ失敗は、すでに DB に反映されている可能性があります。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| ruleUUIDs[*] | string | 空でない文字列を推奨します。関数 ID やその他のルール識別子ではありません。 例: rul_self_example取得または入力方法: 検証済みのセルフホストチェッカー UUID 1 件。 |
|
| refKey | string | 任意の追加絞り込み条件。各 UUID と同時に一致させます。UUID の代替パラメータではなく、refKey のみを渡してコレクションを操作することはできません。 null を許可: False 例: custom-healthcheck-production取得または入力方法: 同じ業務関連キーを追加で確認する必要がある場合に入力します。 |
|
| ruleUUIDs | array | オプションと宣言されていますが、実際には配列を必ず指定する必要があります。省略すると in_(None) により 500 になる可能性があります。refKey は配列の代替にはなりません。空でない配列を推奨し、他の種類のルールや別ワークスペースの UUID を混在させないでください。 null を許可: False 例: ["rul_self_example"]取得または入力方法: 本モジュールの一覧から、現在のワークスペースのセルフホストチェッカー UUID を項目ごとに確認します。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/self_built_checker/batch_delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"ruleUUIDs":["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 を提供してください。 |