自動検出設定の一覧¶
GET /api/v1/issue_auto_discovery/list
概要¶
Issue 自動検出設定をページングして一覧表示します。
呼び出し前の手順と使用手順¶
このモジュールは従来のインシデント Issue 自動検出設定であり、インシデントセンターの Incidents シフト/自動集約ではなく、エラーセンターの ErrorTrack ルールでもありません。現在公開されている書き込み先の dqlNamespace は keyevent のみです。rum/tracing の旧サンプルは現在の宣言に適合しません。バックエンドで issueUpgrade=true に移行済みのワークスペースはこの v2 自動検出タスクをスキップするため、設定の成功をもって当該ワークスペースで新しい Issue が生成されると約束することはできません。
権限は routine.defaultAccess/anomaly.channelManage/anomaly.issueDiscovery のいずれかに一致する必要があります。createAt の降順で未削除のルールを読み取り、無効化された項目も含みます。現在 dqlNamespace/isDisable パラメータは存在しますが実装では無視されるため、必ず各項目のフィールドを読み取って自身で絞り込んでください。content={data,declaration} であり、pageInfo はトップレベルにあります。data 項目には宣言が再帰的に追加されません。
設定を保存しても即時にクエリが実行されたり、生成タスクが返されたりすることはありません。Asia/Shanghai のカレンダーに合わせて周期的に、直前の every 秒ウィンドウを処理します。タスクキューやクエリの所要時間により遅延する場合があります。keyevent は monitor イベントから集約され、dimensions に従って最大 1000 グループを生成しますが、広範囲を完全にカバーすることは約束しません。グループ化ディメンションのソート済み JSON が重複識別子を生成し、ルール UUID はこの識別子に参加しません。複数のルールが同一ワークスペース・同一ディメンション値を持つ場合、同じ既存 Issue に関連付けられる可能性があり、ディメンション/フィルターを変更するとグループ化結果が変わる可能性があります。これをルールごとに独立し、決して交差しない Issue 集合として扱わないでください。Open/Pending は返信が追加され、Resolved は再オープンして回帰し、Closed は再利用されません。履歴の Working ブランチは実際の実装に従って処理され、作業中に完全に分離されることは約束しません。通知は非同期であり、HTTP 200 はデータクエリの成功/新しい Issue の生成/通知の到達を意味しません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証資格情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| dqlNamespace | string | 宣言されていますが、現在の一覧実装ではこのフィルターは追加されず、渡してもデータ範囲は制限されません。返却項目の dqlNamespace を必ず確認してください。 null 許可: False 例: keyevent取得または入力方法: 旧互換のクエリパラメータです。 |
|
| isDisable | string | 現在の一覧実装では有効/無効のフィルターは追加されていません。true/false を渡しても対応する状態に絞り込まれる保証はないため、返却された status に基づいて自身でフィルターしてください。 null 許可: False 指定可能な値: ['true', 'false'] 例: false取得または入力方法: 旧互換の文字列パラメータ true/false です。 |
|
| pageIndex | integer | 省略可能な整数です。省略時は 1 です。宣言では正数/上限は設定されていません。クライアントは正の値のみを使用してください。 null 許可: False 例: 1取得または入力方法: 先頭ページからトップレベルの pageInfo に従ってページングします。 |
|
| pageSize | integer | 省略可能な整数です。省略時は 20 です(例の 10 はデフォルトではありません)。宣言では上限は設定されていません。小さめの妥当な正数を推奨します。 null 許可: False 例: 20取得または入力方法: 読み取り量に応じてページサイズを制御します。 |
|
| search | string | 省略可能です。先頭と末尾の空白は除去され、SQL ILIKE のあいまい一致を行います。省略または空白のみの場合はフィルターされません。%/_ はワイルドカードの意味を保持します。 空文字列の許可: True null 許可: False 例: 生产取得または入力方法: ルール名で検索します。 |
パラメータ補足¶
現在の公開範囲は keyevent です。設定の保存、定期実行、通知の配信は異なる段階です。パラメータおよび完全なレスポンス/エラーの境界については以下を参照してください。
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/issue_auto_discovery/list' \
-H 'DF-API-KEY: <DF-API-KEY>' \
--data-urlencode pageIndex=1 \
--data-urlencode pageSize=20
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | ページングされたコンテンツオブジェクト。 |
| content.data | array<object> |
本ページのルール。一致なしの場合は []。 |
| content.data[].id | integer または null | データベース行 ID。パス特定には使用しません。送信前スナップショットでは null になる場合があります。 |
| content.data[].uuid | string | 自動検出ルール UUID。iatdc_ プレフィックス。 |
| content.data[].status | integer | 0 有効、2 無効、3 論理削除。読み取り時は 3 を除外します。 |
| content.data[].creator | string | 作成主体 UUID。現在の公開入口では通常 wsak_。 |
| content.data[].updator | string または null | 更新主体。作成スナップショットでは空または null になる場合があります。 |
| content.data[].createAt | integer | Unix 秒の作成時刻。 |
| content.data[].updateAt | integer または null | Unix 秒の更新時刻。送信前の作成スナップショットでは null になる場合があり、その後のデータベースのデフォルト値/更新値は -1 または実際の時刻になることがあります。 |
| content.data[].deleteAt | integer | Unix 秒の削除時刻。未削除の場合は通常 -1。 |
| content.data[].workspaceUUID | string | 現在の Key が属するワークスペース。 |
| content.data[].name | string | ルール名。 |
| content.data[].description | string | ルール説明。Issue 本文テンプレートではありません。 |
| content.data[].dqlNamespace | string | 現在の公開書き込み先は keyevent。履歴レコードは他の名前空間である可能性がありますが、公開インターフェースで書き戻せることを意味しません。 |
| content.data[].every | integer | 周期の秒数。 |
| content.data[].conditions | string | 保存済みの DQL フィルター式。実行検証に成功したことを意味しません。 |
| content.data[].dimensions | array<string> |
グループ化フィールド名の配列。履歴上の誤った型は許容する必要があります。 |
| content.data[].dimensions[] | string | 1 つのイベントフィールド名。 |
| content.data[].config | object | Issue 生成定義テンプレート。 |
| content.data[].config.name | string | 必須の文字列で最大 256 文字。Issue タイトルテンプレートであり、ルールの name とは異なります。{{service}}/{{count}} などの word 変数名をサポートします。未知の変数はそのまま保持されます。任意の Python/Jinja 式はサポートされず、ドット/ハイフンを含むフィールドは置換を保証しません。 |
| content.data[].config.level | string | 省略可能なレベル UUID または空文字列。非空の場合は現在有効である必要があり、そうでない場合は 406。省略時はレベル指定なし。インシデントセンターのレベル UUID の汎用代替フィールドではありません。 |
| content.data[].config.channelUUIDs | array | 省略可能なチャンネル UUID 配列。明示的な項目は現在有効である必要があります。常に [] または有効な配列を渡すことを推奨します。省略しても保存は可能ですが、タスクが None を走査して失敗する可能性があります。タスクはデフォルトチャンネルの関連付けを自動補完します。保存自体は [] であっても、ワークスペースに少なくとも 1 つの有効なチャンネルが存在することを要求します。 |
| content.data[].config.channelUUIDs[] | string | 単一の有効なチャンネル UUID。ディメンションフィールド/チーム UUID ではありません。未知または無効の場合は 404。 |
| content.data[].config.description | string | 宣言上は省略可能な文字列ですが、後続タスクがこのキーを直接読み取るため、常に明示的に指定することを推奨します(空文字列でも可)。config の変更は全体置換であり、サブキーを省略しても以前の値は保持されません。 |
| content.data[].config.extend.text | string | 明示的な文字列を推奨します。タスクは読み取ってテンプレート置換を行います。欠落/文字列以外の場合は非同期で失敗する可能性があります。config.description とはそれぞれ別に保存されるテキストフィールドです。 |
| content.data[].config.extend.manager | array | 省略可能な担当者文字列配列。有効な acnt_/本ワークスペースのチーム/メールアドレス/dutyPerson は保持されます。未知のアカウント/未知の値は静かに除外される可能性があり、項目ごとのエラー報告は保証されません。無料/トライアルワークスペースは外部メールアドレスをサポートせず、400 になる場合があります。担当者が欠落すると未割り当てエスカレーションフローに入る可能性があります。 |
| content.data[].config.extend.manager[] | string | 1 つの有効な主体、メールアドレス、または dutyPerson。文字列以外の場合、文字列 startswith 処理時に 500 になる可能性があります。 |
| content.data[].config.extend.conditionsInputFilters | any | 省略可能な任意の JSON。履歴 Issue/通知イベントのジャンプ時に補足フィルターを表示するために使用します。実際のクエリでは引き続きトップレベルの conditions が使用され、このキーだけを変更して置き換えることはできません。 |
| content.data[].config.extend.variable | json | リクエストで入力することは推奨しません。タスクは実際のクエリ列でこのオブジェクトを上書きします。通常、count はウィンドウ内の件数です。 |
| content.data[].config.extend.variable.count | integer | 実行時の出現回数。呼び出し側の入力は信頼できる固定値として有効にはなりません。 |
| content.data[].config.extend.tags | json | リクエストで入力することは推奨しません。タスクは実際のグループ化 tags で上書きし、Issue の重複排除およびテンプレート変数に関与します。 |
| content.data[].config.extend.tags.字段 | any | 動的な JSON タグ値。呼び出し側が手入力した値に基づいてグループ化が固定生成されることはありません。 |
| content.data[].config.extend.channelUUIDs | array | 実行時には有効な設定済みチャンネルで上書きされます。この拡張フィールドで config.channelUUIDs を代替しないでください。 |
| content.data[].config.extend.channelUUIDs[] | string | 実行時に有効なチャンネル識別子。 |
| content.data[].config.extend.自定义键 | any | 任意の JSON 保存値。このページで公開されている追加の実行保証はありません。認証情報を入れないでください。 |
| content.data[].config.extend | object または null | 保存済みの拡張。新しいリクエストではオブジェクトを使用してください。null は同期監査または後続タスクの異常を引き起こします。 |
| content.data[].creatorInfo | object | 一覧/詳細に付加される主体サマリー。一致なしの場合は {}。 |
| content.data[].creatorInfo.uuid | string | 主体 UUID。アカウント、Key、またはシステム識別子の場合があります。 |
| content.data[].creatorInfo.status | integer | 主体ステータス。 |
| content.data[].creatorInfo.wsAccountStatus | integer | 現在のワークスペースメンバー関係のステータスサマリー。 |
| content.data[].creatorInfo.username | string | ログイン名または Key 名。 |
| content.data[].creatorInfo.name | string | 表示名。 |
| content.data[].creatorInfo.iconUrl | string | アバター URL。空の場合があります。 |
| content.data[].creatorInfo.email | string | メールアドレス。Key 主体の場合は自身の UUID になることがあり、配信可能であることは保証されません。 |
| content.data[].creatorInfo.mobile | string | 電話番号。空の場合があります。 |
| content.data[].creatorInfo.countryCode | string | 電話の国番号。空の場合があります。 |
| content.data[].creatorInfo.acntWsNickname | string | 現在のワークスペースでのニックネーム。空の場合があります。 |
| content.data[].updatorInfo | object | 一覧/詳細に付加される主体サマリー。一致なしの場合は {}。 |
| content.data[].updatorInfo.uuid | string | 主体 UUID。アカウント、Key、またはシステム識別子の場合があります。 |
| content.data[].updatorInfo.status | integer | 主体ステータス。 |
| content.data[].updatorInfo.wsAccountStatus | integer | 現在のワークスペースメンバー関係のステータスサマリー。 |
| content.data[].updatorInfo.username | string | ログイン名または Key 名。 |
| content.data[].updatorInfo.name | string | 表示名。 |
| content.data[].updatorInfo.iconUrl | string | アバター URL。空の場合があります。 |
| content.data[].updatorInfo.email | string | メールアドレス。Key 主体の場合は自身の UUID になることがあり、配信可能であることは保証されません。 |
| content.data[].updatorInfo.mobile | string | 電話番号。空の場合があります。 |
| content.data[].updatorInfo.countryCode | string | 電話の国番号。空の場合があります。 |
| content.data[].updatorInfo.acntWsNickname | string | 現在のワークスペースでのニックネーム。空の場合があります。 |
| pageInfo | object | ページングメタ情報。OpenAPI ではトップレベルにあり、content はオブジェクトのままです。 |
| pageInfo.count | integer | 本ページの実際の件数。 |
| pageInfo.totalCount | integer | 現在有効なフィルターに一致する自動検出設定の総数。生成済み Issue の数ではありません。 |
| pageInfo.pageIndex | integer | ページ番号。1 から開始します。 |
| pageInfo.pageSize | integer | 今回のページごとのリクエスト件数。 |
| content.declaration | object または null | 現在のワークスペースの共通宣言。content の親オブジェクトにのみ追加され、data 項目には再帰的に追加されません。 |
{
"code": 200,
"content": {
"data": [
{
"id": 7,
"uuid": "iatdc_example",
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": null,
"deleteAt": -1,
"workspaceUUID": "wksp_example",
"name": "生产事件自动发现",
"description": "按服务聚合生产告警",
"dqlNamespace": "keyevent",
"every": 300,
"conditions": "`df_status` = 'error'",
"dimensions": [
"service"
],
"config": {
"name": "服务{{service}}告警",
"description": "本窗口{{count}}条事件",
"channelUUIDs": [],
"extend": {
"text": "服务{{service}}发现{{count}}条事件",
"manager": []
}
},
"creatorInfo": {},
"updatorInfo": {}
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE",
"pageInfo": {
"count": 1,
"totalCount": 1,
"pageIndex": 1,
"pageSize": 20
}
}
エラー応答¶
認証、レート制限、および共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 処理方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | 宣言されていない Query パラメータを使用した、またはパラメータが規則に違反した | パラメータ解析失敗 | Query パラメータ表と例を確認してください。 |
| 500 | ft.InternalServerError | データベース読み取り、履歴構造、または主体サマリーの構築時の例外 | 内部エラー | フィールドと traceId を確認してバックオフしながら再試行し、管理者に履歴設定の確認を依頼してください。 |