自動検出設定の無効化/有効化¶
POST /api/v1/issue_auto_discovery/{cfg_uuid}/set_disable
概要¶
Issue 自動検出ルールを有効化または無効化します。
呼び出し前の確認と使用手順¶
本モジュールは旧インシデント(異常追跡)の Issue 自動検出設定であり、インシデントセンターの Incidents シフト/自動集約ではなく、エラーセンターの ErrorTrack ルールでもありません。現在公開されている書き込み dqlNamespace は keyevent のみです。rum/tracing の旧サンプルは現在の宣言に適合しません。バックエンドで移行済み(issueUpgrade=true)のワークスペースでは、この v2 自動検出タスクはスキップされ、設定が成功したからといってそのワークスペースで新しい Issue が生成されることを保証できません。
権限は trace.issueDiscovery/rum.issueDiscovery/anomaly.issueDiscovery のいずれかに該当する必要があります。対象は現在のワークスペース内の未削除のルールである必要があり、未知の削除や重複した削除は冪等な成功ではなく、404 ft.LogIndexCfgNoExists となります。無効化はルールの status を 2 に設定するだけです。以降の定期クエリ/生成は現在の状態を確認して実行されます。実行済みのクエリや送信済みの通知を取り消すことはできず、処理中のタスクが直ちにキャンセルされることも保証しません。有効化すると定期実行への参加が復元されますが、ワークスペースがインシデントセンターへ移行済みである場合のスキップ条件は引き続き適用されます。
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 を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| isDisable | boolean | Y | 必須の真偽値。欠落/null/文字列の場合は事前に 406 となります。true は status 2、false は 0 を設定します。同じ値でも更新日時は更新されます。 null を許可: False 例: true取得または入力方法: 呼び出し元が明示的に無効化(true)または有効化(false)を決定します。 |
パラメータ補足説明¶
現在の公開範囲は keyevent です。設定の保存、定期実行、通知の到達はそれぞれ異なる段階です。パラメータおよび完全なレスポンス/エラーの境界については以下を参照してください。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/issue_auto_discovery/iatdc_example/set_disable' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"isDisable":true}'
レスポンス¶
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 ファイル形式エラー | isDisable の真偽値オブジェクトを送信してください。 |
| 404 | ft.LogIndexCfgNoExists | 現在のワークスペース内の未削除の自動検出ルールが存在しない/削除済み/別ワークスペース | 指定されたログインデックス設定が存在しません | 本ワークスペースの自動検出一覧から iatdc_ UUID を再取得してください。これは過去のエラーメッセージの再利用であり、ログインデックスの新規作成に切り替えないでください。 |
| 500 | ft.InternalServerError | ルール状態の保存/送信、または未処理の状態更新の異常 | 内部エラー | まずルール詳細で status が既に 0/2 になっていないか確認し、traceId を保持してください。そのうえで同じ状態で再試行するか判断します。再作成やイベントカウントのリセットは伴いません。 |