自動検出設定を取得¶
GET /api/v1/issue_auto_discovery/{cfg_uuid}/get
概要¶
Issue 自動検出ルールとテンプレートを読み取ります。
呼び出し前と使用手順¶
本モジュールは従来のインシデント Issue 自動検出設定であり、インシデントセンターの Incidents オンコール/自動集約ではなく、エラーセンターの ErrorTrack ルールでもありません。現在、公開されている書き込みでは dqlNamespace に keyevent のみを指定できます。rum/tracing の旧サンプルは現在の宣言に適合しません。バックエンドで issueUpgrade=true に移行済みのワークスペースは、この v2 自動検出タスクをスキップします。設定の成功をもって、そのワークスペースで新しい Issue が生成されると保証することはできません。
権限は trace.issueDiscovery/rum.issueDiscovery/anomaly.issueDiscovery のいずれかに一致する必要があります。対象は現在のワークスペースの未削除ルールのみです。存在しない場合は 404 の履歴エラー ft.LogIndexCfgNoExists を返します。完全な設定と作成/更新主体の概要を返し、Issue の生成/タスク実行結果は展開しません。
設定を保存しても、すぐにクエリを実行したり、生成タスクを返したりすることはありません。スケジュール実行では、Asia/Shanghai のカレンダーに合わせた周期で直前の every 秒ウィンドウを処理します。タスクキュー/クエリの所要時間により遅延する場合があります。keyevent は monitor イベントから集約され、dimensions に従って最大 1000 個のグループを生成します。広範囲の完全なカバレッジは保証しません。グループ化ディメンションをソートした JSON が重複判定用の識別子を生成し、ルール UUID はこの識別子に含まれません。複数のルールが同一ワークスペースで同じディメンション値を持つ場合、同じ既存 Issue に関連付けられる可能性があります。ディメンション/フィルターを変更するとグループ結果が変わる可能性があります。これを、ルールごとに独立して決して交差しない Issue 集合と見なさないでください。Open/Pending の場合は返信を追加し、Resolved は再オープンして復帰でき、Closed は再利用しません。履歴上の Working 分岐は実際の実装に従って処理され、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 --get 'https://openapi.guance.com/api/v1/issue_auto_discovery/iatdc_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content | object | 完全な設定と主体の概要。 |
| content.id | integer または null | データベース行 ID。パス指定には使用しません。コミット前のスナップショットでは null の場合があります。 |
| content.uuid | string | 自動検出ルール UUID。iatdc_ プレフィックス付き。 |
| content.status | integer | 0 は有効、2 は無効、3 は論理削除。読み取り時は 3 を除外します。 |
| content.creator | string | 作成主体 UUID。現在の公開エントリでは通常 wsak_ です。 |
| content.updator | string または null | 更新主体。作成スナップショットでは空または null の場合があります。 |
| content.createAt | integer | Unix 秒の作成時刻。 |
| content.updateAt | integer または null | Unix 秒の更新時刻。コミット前の作成スナップショットでは null の場合があり、その後のデータベースのデフォルト値/更新値は -1 または実際の時刻になることがあります。 |
| content.deleteAt | integer | Unix 秒の削除時刻。未削除の場合は通常 -1 です。 |
| content.workspaceUUID | string | 現在の Key が属するワークスペース。 |
| content.name | string | ルール名。 |
| content.description | string | ルールの説明。Issue 本文のテンプレートではありません。 |
| content.dqlNamespace | string | 現在の公開書き込みは keyevent です。履歴レコードでは他の名前空間の場合がありますが、公開インターフェースで書き戻せることを意味しません。 |
| content.every | integer | 周期の秒数。 |
| content.conditions | string | 保存済みの DQL フィルター式。実行成功が検証済みであることを意味しません。 |
| content.dimensions | array<string> |
グループ化フィールド名の配列。履歴上の誤った型に対しては寛容に処理する必要があります。 |
| content.dimensions[] | string | 1 つのイベントフィールド名。 |
| content.config | object | Issue 生成定義のテンプレート。 |
| content.config.name | string | 必須の文字列で最大 256 文字。Issue タイトルのテンプレートであり、ルールの name とは異なります。{{service}}/{{count}} などの word 変数名をサポートします。未知の変数はそのまま保持されます。任意の Python/Jinja 式はサポートされず、ドット/ハイフンを含むフィールドは置換が保証されません。 |
| content.config.level | string | 任意のレベル UUID または空文字列。空でない場合は現在有効である必要があり、そうでない場合は 406 です。省略した場合はレベルを指定しません。インシデントセンターのレベル UUID の汎用代替フィールドではありません。 |
| content.config.channelUUIDs | array | 任意のチャンネル UUID 配列。明示的な項目は現在アクティブである必要があります。常に [] または有効な配列を渡すことを推奨します。省略しても保存はできますが、タスクが None を走査して失敗する可能性があります。タスクはデフォルトのチャンネル関連付けを自動補完します。保存自体には、[] であってもワークスペースに少なくとも 1 つのアクティブなチャンネルが存在することが依然として必要です。 |
| content.config.channelUUIDs[] | string | 単一のアクティブなチャンネル UUID。ディメンションフィールド/チーム UUID ではありません。未知または無効の場合は 404 です。 |
| content.config.description | string | 宣言上は任意の文字列ですが、後続タスクがこのキーを直接読み取るため、常に明示的に指定することを推奨します(空文字列でも可)。config の変更は全体置換であり、サブキーを省略しても旧値は保持されません。 |
| content.config.extend.text | string | 明示的な文字列を推奨します。タスクが読み取ってテンプレート置換を行います。欠落/文字列以外の場合は非同期で失敗することがあります。config.description とはそれぞれ別に保存されるテキストフィールドです。 |
| content.config.extend.manager | array | 任意の担当者文字列配列。有効な acnt_/このワークスペースのチーム/メールアドレス/dutyPerson は保持されます。未知のアカウント/未知の値は暗黙的に除外される可能性があり、項目ごとのエラー報告は保証されません。無料/体験プランのワークスペースでは外部メールアドレスをサポートしておらず、400 になる場合があります。担当者が欠落している場合は未割り当てのエスカレーションフローに入る可能性があります。 |
| content.config.extend.manager[] | string | 有効な主体、メールアドレス、または dutyPerson のいずれか。文字列以外の場合は文字列の startswith 処理時に 500 になる可能性があります。 |
| content.config.extend.conditionsInputFilters | any | 任意の JSON(任意指定)。履歴 Issue/通知イベントへのジャンプ時に補足フィルターを表示するためのものです。実際のクエリでは引き続きトップレベルの conditions を使用するため、このキーだけを変更して代用することはできません。 |
| content.config.extend.variable | json | リクエストでの指定は推奨しません。タスクが実際のクエリ列でこのオブジェクトを上書きします。一般的な count はウィンドウ内の件数です。 |
| content.config.extend.variable.count | integer | 実行時の出現回数。呼び出し元の入力は信頼できる固定値として有効にはなりません。 |
| content.config.extend.tags | json | リクエストでの指定は推奨しません。タスクが実際のグループ化 tags で上書きし、Issue の重複排除およびテンプレート変数に使用されます。 |
| content.config.extend.tags.字段 | any | 動的な JSON タグ値。呼び出し元が手入力した値に基づいてグループ生成を固定することはできません。 |
| content.config.extend.channelUUIDs | array | 実行時に有効な設定チャンネルで上書きされます。この拡張フィールドで config.channelUUIDs を代替しないでください。 |
| content.config.extend.channelUUIDs[] | string | 実行時に有効な 1 つのチャンネル識別子。 |
| content.config.extend.自定义键 | any | 任意の JSON 保存値。このページで公開されている追加の実行保証はありません。認証情報を格納しないでください。 |
| content.config.extend | object または null | 保存済みの拡張。新しいリクエストではオブジェクトを使用する必要があります。null は同期監査または後続タスクの異常を引き起こします。 |
| content.creatorInfo | object | 一覧/詳細に付加される主体の概要。一致しない場合は {}。 |
| content.creatorInfo.uuid | string | 主体 UUID。アカウント、Key、またはシステム識別子の場合があります。 |
| content.creatorInfo.status | integer | 主体のステータス。 |
| content.creatorInfo.wsAccountStatus | integer | 現在のワークスペースのメンバー関係ステータスの概要。 |
| content.creatorInfo.username | string | ログイン名または Key 名。 |
| content.creatorInfo.name | string | 表示名。 |
| content.creatorInfo.iconUrl | string | アバター URL。空の場合があります。 |
| content.creatorInfo.email | string | メールアドレス。Key 主体の場合は自身の UUID となることがあり、配信可能であることは保証されません。 |
| content.creatorInfo.mobile | string | 携帯電話番号。空の場合があります。 |
| content.creatorInfo.countryCode | string | 電話の国番号。空の場合があります。 |
| content.creatorInfo.acntWsNickname | string | 現在のワークスペースのニックネーム。空の場合があります。 |
| content.updatorInfo | object | 一覧/詳細に付加される主体の概要。一致しない場合は {}。 |
| content.updatorInfo.uuid | string | 主体 UUID。アカウント、Key、またはシステム識別子の場合があります。 |
| content.updatorInfo.status | integer | 主体のステータス。 |
| content.updatorInfo.wsAccountStatus | integer | 現在のワークスペースのメンバー関係ステータスの概要。 |
| content.updatorInfo.username | string | ログイン名または Key 名。 |
| content.updatorInfo.name | string | 表示名。 |
| content.updatorInfo.iconUrl | string | アバター URL。空の場合があります。 |
| content.updatorInfo.email | string | メールアドレス。Key 主体の場合は自身の UUID となることがあり、配信可能であることは保証されません。 |
| content.updatorInfo.mobile | string | 携帯電話番号。空の場合があります。 |
| content.updatorInfo.countryCode | string | 電話の国番号。空の場合があります。 |
| content.updatorInfo.acntWsNickname | string | 現在のワークスペースのニックネーム。空の場合があります。 |
| content.declaration | object または null | 現在のワークスペースの共通宣言。 |
{
"code": 200,
"content": {
"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"
}
エラー応答¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンスの説明 | 対処方法 |
|---|---|---|---|---|
| 404 | ft.LogIndexCfgNoExists | 現在のワークスペースの未削除自動検出ルールが存在しない/削除済み/別ワークスペース | 指定されたログインデックス設定が存在しません | このワークスペースの自動検出一覧から iatdc_ UUID を再取得してください。これは履歴で再利用されているエラーメッセージであり、新しいログインデックスを作成する方向に進まないでください。 |
| 500 | ft.InternalServerError | データベース読み取り、履歴構造、または主体概要の構築時の異常 | 内部エラー | フィールドと traceId を確認し、バックオフして再試行してください。管理者に履歴設定の確認を依頼してください。 |