コンテンツにスキップ

自動検出設定の削除



POST /api/v1/issue_auto_discovery/{cfg_uuid}/delete

概要

Issue 自動検出ルールをソフト削除します。

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

本モジュールは旧インシデントの Issue 自動検出設定であり、インシデントセンターの Incidents オンコールシフト/自動集約でも、エラーセンターの ErrorTrack ルールでもありません。現在公開されている書き込み可能な dqlNamespace は keyevent のみです。rum/tracing の旧例は現在の宣言に適合しません。バックエンドで issueUpgrade=true に移行済みのワークスペースは、この v2 自動検出タスクをスキップします。設定の成功をもって、そのワークスペースで新しい Issue が生成されることを保証することはできません。

権限は trace.issueDiscovery/rum.issueDiscovery/anomaly.issueDiscovery のいずれかに一致する必要があります。対象は、現在のワークスペース内の未削除ルールである必要があります。不明な削除や重複削除は冪等な成功ではなく、404 ft.LogIndexCfgNoExists を返します。ソフト削除は status3 で、生成済み Issue/過去の返信/チャンネルは削除しません。この公開 API では復元できず、再作成すると新しい iatdc_ が付与されます。既存 Issue の後続イベントのリンク/通知には、このルールから条件を追加できなくなります。同一ディメンションの重複排除識別子にはルール UUID が含まれないため、再作成しても完全に新しい独立した Issue が生成されるとは限りません。削除は先にコミットされ、その後で重要度/チャンネル/担当者の監査情報を整えます。そのため後続の 404/400/500 でも削除済みの可能性があり、まず読み戻して確認してください。

true を返し、ヒット件数/実行タスク/通知状態は返しません。設定の保存ではクエリを即時実行せず、生成タスクも返しません。定期実行は Asia/Shanghai のカレンダーに合わせた周期で、直前の every 秒ウィンドウを処理します。タスクキューやクエリの所要時間により遅延する場合があります。keyevent は monitor イベントから集約し、dimensions に従って最大 1000 グループを生成します。広範囲を完全にカバーすることは保証しません。グループ化ディメンションをソートした JSON で重複識別子を生成しますが、ルール UUID はその識別子に含まれません。同一ワークスペース内で同じディメンション値を持つ複数のルールが同じ既存 Issue に関連付けられる可能性があり、ディメンション/フィルターの変更によりグループ化結果が変わる場合があります。これを、ルールごとに独立して決して交差しない Issue 集合として扱わないでください。Open/Pending は返信を追加し、Resolved は再オープンして復帰でき、Closed は再利用しません。過去の Working ブランチは実際の実装に従って処理され、作業中に完全に分離されることは保証しません。通知は非同期であり、HTTP 200 はデータクエリの成功/新しい Issue の生成/通知の配信を意味しません。

ルートパラメータ

パラメータ名 型 必須 説明
cfg_uuid string Y 現在の Key ワークスペースの未削除ルール。状態 0(有効)または 2(無効)のいずれでも読み取り/変更できます。存在しない場合は履歴互換の ft.LogIndexCfgNoExists を使用します。メッセージはログインデックスと表示しますが、実際にはこのルール UUID を確認する必要があります。
例: iatdc_example
取得または入力方法: Issue 自動検出ルール一覧 から content.data[].uuid(iatdc_)を取得します。Issue UUID や ErrorTrack ルール UUID は使用しないでください。

リクエストヘッダー

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

パラメータの補足説明

現在の公開範囲は keyevent です。設定の保存、定期実行、通知の配信は異なる段階であり、パラメータと完全なレスポンス/エラーの境界は以下を参照してください。

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/issue_auto_discovery/iatdc_example/delete' \
  -H 'DF-API-KEY: <DF-API-KEY>'

レスポンス

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

フィールド 型 説明
content boolean 成功時は true。declaration やタスク/項目ごとの情報は含みません。
{
  "code": 200,
  "content": true,
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE"
}

エラーレスポンス

認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
404 ft.LogIndexCfgNoExists 現在のワークスペースに未削除の自動検出ルールが存在しない/削除済み/ワークスペースが異なる 指定されたログインデックス設定が存在しません このワークスペースの自動検出一覧から iatdc_ UUID を再取得してください。これは履歴で再利用されているエラーメッセージであり、ログインデックスの新規作成に進まないでください。
500 ft.InternalServerError 設定のソフト削除後、またはコミット後に重要度/チャンネル/担当者の監査情報の構築で未処理の例外が発生 内部エラー まず読み戻してルールが削除済みか確認し、その後で過去のテンプレート/チャンネル/担当者を確認してください。500 に基づいて削除のロールバックを判断せず、traceId を保持してください。
404 ft.NotFoundChannel 削除コミット後にチャンネル情報を読み取ったが、ワークスペースに有効なチャンネルが存在しない 指定されたチャンネルが見つかりません まずルールが削除済みか確認してください。管理者はチャンネルを修復し、結果が不明な削除を繰り返さないでください。
400 ft.UnsupportFreeIssueManager 削除コミット後に過去の担当者を整理する際、無料/無料プランのワークスペースに外部メールアドレスが残っている 無料プランのワークスペースでは、インシデントの担当者に外部メールアドレスを使用できません まず削除状態を読み戻し、管理者は旧担当者/製品プランを確認してください。エラーは削除のロールバックを示すものではありません。

フィードバック

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