削除¶
POST /api/v1/error_track_rule/delete
概要¶
エラー追跡ルールを一括でソフト削除します。
呼び出し前の確認と使用手順¶
現在の Key には errorCenter.errorTrackRuleManage が必要で、現在のワークスペースのみが対象です。一括 UUID では、まず未削除の項目を絞り込みます。無効化済みルールも含まれます。不明/クロスワークスペース/削除済みの項目は直接無視されます。[] またはすべて無効でも true のままで、ヒット数/項目ごとの結果はありません。成功しても各入力が有効になったことを証明するわけではないため、一覧/詳細を読み戻して確認する必要があります。
ソフト削除では status=3 とし、削除日時を記録します。その後、このルールの一覧/詳細は読み取れなくなります。履歴テレメトリ、エラー処理メタデータ、コメントは削除しません。復元 API は提供されないため、削除前に設定を保存してください。再作成すると新しい UUID が付与されます。フロントエンドの初回ガイダンスは、過去にルールを作成した履歴に引き続き基づき、すべて削除しても自動的にガイダンスが復元されることはありません。
このコントローラーは同期タスク/ダウンストリームの確認を返しません。失敗後はまず読み戻して確認し、ネットワークエラーを未更新と誤認しないようにしてください。不明な項目が無視されることは、バッチ全体のアトミックな保証を意味しません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得してください。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| ruleUUIDs[*] | any | 単一ルールの UUID。文字列を推奨します。元の宣言には要素ごとの型/非 null 検証がないため、クライアント側で確認する必要があります。 例: issetrule_example取得または入力方法: 現在のワークスペースのルール一覧の uuid。 |
|
| ruleUUIDs | array | Y | 必須の配列。[] はヒットなし。現在のワークスペースの status!=3 の項目のみが対象で、不明/クロスワークスペース/削除済みの項目は無視され、項目ごとの失敗リストはありません。 null を許可: False 例: ["issetrule_example"]取得または入力方法: ルール一覧 から content.data[].uuid を取得し、現在の状態/型を確認してください。 |
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/error_track_rule/delete' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"ruleUUIDs":["issetrule_example"]}'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | boolean | 成功時は true(ヒットなしの場合も含む)。declaration、ヒット数、項目ごとの状態は含まれません。 |
{
"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 ファイルの形式エラー | ruleUUIDs を含むオブジェクトを送信してください。 |
| 500 | ft.InternalServerError | データベースや履歴ルールの形式など、未処理の例外 | 内部エラー | ルール状態を読み戻してから再試行するか判断してください。traceId を保持し、失敗によってすべての項目が保存されなかったと確認することはできません。 |