作成¶
POST /api/v1/checker/add
概要¶
通常、インテリジェント、または AI セマンティックモニターを作成します。
呼び出し前の確認と使用手順¶
まず対象ワークスペースで DQL を検証し、アルゴリズムに応じて完全な jsonScript と有効な関連オブジェクトを入力します。通常ルールはデフォルトでデフォルトのモニターグループに追加され、新規ルールはデフォルトで有効になります。事前に無効化する必要がある場合は、明示的に status=2 を指定してください。作成時には高コスト DQL チェック、パラメータ検証、スケジューリング登録が同期的に行われます。1 回の検出結果は返さず、HTTP 200 を通知が到達済みであると見なしません。
API 呼び出し、スケジューリング、データベース、タグ/関連、キャッシュはサービス横断のアトミックトランザクションではありません。エラー時にはメインルール/スケジューリングが既に存在する可能性があります。再試行前に一覧/get で uuid、status、最終的な関連を確認し、重複タスクを避けてください。外部イベントでは、生成/保存された secret + subUri で Webhook を設定します。このリクエストではイベントをトリガーしません。インテリジェント V2 設定は 10 分固定のスケジューリングを使用し、YAML を同期検証します。AI セマンティック参照は引き続きデータ権限の制約を受け、予算制限は実際の消費を保証するものと見なせません。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| alertPolicyUUIDs[*] | string | 配列の各要素。 例: altpl_example取得または入力方法: アラートポリシー一覧から uuid を取得します。 |
|
| permissionSet[*] | string | 単一の操作主体。 例: wsAdmin取得または入力方法: このワークスペースのロール/メンバー/チームから取得します。 |
|
| jsonScript.targets[*] | json | タイプに応じて下位構造を使用します。 例: {"dql": "M::cpu:(avg(usage_idle)) BY host", "alias": "Result", "qtype": "dql"}取得または入力方法: 1 つのクエリまたは組み合わせメンバー。 |
|
| jsonScript.targets[*].dql | string | DQL または PromQL テキスト。qtype で指定します。 例: M::cpu:(avg(usage_idle)) BY host取得または入力方法: 対象ワークスペースの実際のデータから作成して検証します。 |
|
| jsonScript.targets[*].qtype | string | 通常は dql を指定します。 例: dql取得または入力方法: DQL なら dql、PromQL なら promql を選択します。 |
|
| jsonScript.targets[*].alias | string | 通常プラグインは Result または空のみを受け付け、重複は許可されません。 例: Result取得または入力方法: 通常の単一クエリでは Result、組み合わせメンバーでは A/B などで割り当てます。 |
|
| jsonScript.targets[*].monitorCheckerId | string | combinedCheck のみ。メンバーに Cron 競合が存在するルールは指定できません。 例: rul_checker_example取得または入力方法: 現在のワークスペースのモニター一覧から使用可能なメンバー UUID を取得します。 |
|
| jsonScript.groupBy[*] | string | 単一の次元。 例: host取得または入力方法: 実際の DQL の BY フィールド。 |
|
| jsonScript.checkFuncs[*] | json | seniorCheck では先頭項目を使用します。 例: {"funcId": "example.func", "kwargs": {}}取得または入力方法: 元の互換カスタム関数設定から取得します。 |
|
| jsonScript.checkFuncs[*].funcId | string | 互換関数の識別子。 例: example.func取得または入力方法: 実際に使用可能な関数 ID。 |
|
| jsonScript.checkFuncs[*].kwargs | json | 動的オブジェクト。共通の必須サブキーはありません。 例: {}取得または入力方法: その関数固有のパラメータ構造。 |
|
| jsonScript.checkFuncs[*].kwargs.パラメータ名 | any | 単一の関数専用値。 例: 1取得または入力方法: 対応する関数ドキュメントから名前/型/取得元を取得します。 |
|
| jsonScript.checkerOpt.rules[*] | json | アルゴリズムごとに異なる条件構造を使用できます。 例: {"status": "warning", "conditionLogic": "and", "conditions": [{"alias": "Result", "operator": "<", "operands": [10]}]}取得または入力方法: 単一のアラートレベルの条件。 |
|
| jsonScript.checkerOpt.rules[*].status | string | 共通プラグインで許可される集合。実際の検出タイプに応じて使用します。 例: warning取得または入力方法: イベントレベルに応じて fatal/critical/error/warning/info/ok/ALL を選択します。 |
|
| jsonScript.checkerOpt.rules[*].conditionLogic | string | 共通条件では必須です。 例: and取得または入力方法: and/or。 |
|
| jsonScript.checkerOpt.rules[*].conditions | array | 共通条件では必須の配列です。 例: [{"alias": "Result", "operator": "<", "operands": [10]}]取得または入力方法: 実際のクエリ結果としきい値に基づいて構築します。 |
|
| jsonScript.checkerOpt.rules[*].okConditions | array | 任意。openOkConditions と組み合わせます。しきい値比較の方向はトリガーと逆にし、境界を有効にする必要があります。 例: [{"alias": "Result", "operator": ">=", "operands": [20]}]取得または入力方法: 段階的復旧用に独立した境界を設定します。 |
|
| jsonScript.checkerOpt.rules[*].matchTimes | integer | 任意。openMatchTimes と組み合わせます。有効時はデフォルト 1、実際の範囲は 1..100 で、超過時は ErrorContinuousTriggerCfgCount を返します。 例: 2取得または入力方法: 業務上、何回連続で異常になればトリガーするかを指定します。 |
|
| jsonScript.checkerOpt.rules[*].conditions[*] | json | 単一の比較条件。 例: {"alias": "Result", "operator": "<", "operands": [10]}取得または入力方法: 実際のクエリ Result としきい値で構築します。 |
|
| jsonScript.checkerOpt.rules[*].conditions[*].alias | string | 対象の alias と一致させます。 例: Result取得または入力方法: 同じクエリ対象、データ単位、業務境界に従って設定します。 |
|
| jsonScript.checkerOpt.rules[*].conditions[*].operator | string | 共通演算 =、!=、>、>=、<、<=、between、notBetween、like、notLike、in、notIn、regExp、notRegExp、isTrue、isFalse、likeTrue、likeFalse。具体的なアルゴリズムで範囲が狭まる場合があります。 例: <取得または入力方法: 同じクエリ対象、データ単位、業務境界に従って設定します。 |
|
| jsonScript.checkerOpt.rules[*].conditions[*].operands | array | 文字列/数値の配列。実際の結果の単位を保持します。真偽値/オブジェクトは渡さず、空値の条件はフィルタリングされる可能性があります。 例: [10]取得または入力方法: 同じクエリ対象、データ単位、業務境界に従って設定します。 |
|
| jsonScript.checkerOpt.rules[*].conditions[*].operands[*] | JSON | 単一のしきい値。数値比較では JSON の数値を指定し、正規表現/集合では実際のルールに応じて文字列を指定します。 例: 10取得または入力方法: 同じクエリ対象、データ単位、業務境界に従って設定します。 |
|
| jsonScript.checkerOpt.rules[*].okConditions[*] | json | 単一の比較条件。 例: {"alias": "Result", "operator": "<", "operands": [10]}取得または入力方法: 実際のクエリ Result としきい値で構築します。 |
|
| jsonScript.checkerOpt.rules[*].okConditions[*].alias | string | 対象の alias と一致させます。 例: Result取得または入力方法: 同じクエリ対象、データ単位、業務境界に従って設定します。 |
|
| jsonScript.checkerOpt.rules[*].okConditions[*].operator | string | 共通演算 =、!=、>、>=、<、<=、between、notBetween、like、notLike、in、notIn、regExp、notRegExp、isTrue、isFalse、likeTrue、likeFalse。具体的なアルゴリズムで範囲が狭まる場合があります。 例: <取得または入力方法: 同じクエリ対象、データ単位、業務境界に従って設定します。 |
|
| jsonScript.checkerOpt.rules[*].okConditions[*].operands | array | 文字列/数値の配列。実際の結果の単位を保持します。真偽値/オブジェクトは渡さず、空値の条件はフィルタリングされる可能性があります。 例: [10]取得または入力方法: 同じクエリ対象、データ単位、業務境界に従って設定します。 |
|
| jsonScript.checkerOpt.rules[*].okConditions[*].operands[*] | JSON | 単一のしきい値。数値比較では JSON の数値を指定し、正規表現/集合では実際のルールに応じて文字列を指定します。 例: 10取得または入力方法: 同じクエリ対象、データ単位、業務境界に従って設定します。 |
|
| jsonScript.channels[*] | string | 配列内の単一の有効値。 例: chan_example取得または入力方法: 上位の説明にあるチャンネルまたはアカウント識別子を取得します。 |
|
| jsonScript.atAccounts[*] | string | 配列内の単一の有効値。 例: acnt_example取得または入力方法: 上位の説明にあるチャンネルまたはアカウント識別子を取得します。 |
|
| jsonScript.atNoDataAccounts[*] | string | 配列内の単一の有効値。 例: acnt_example取得または入力方法: 上位の説明にあるチャンネルまたはアカウント識別子を取得します。 |
|
| jsonScript.checkerOpt.infoEventCondition.operands[*] | JSON | 文字列または数値。 例: 60取得または入力方法: クエリ Result と同じ単位の比較値。 |
|
| jsonScript.checkerOpt.rules[*].strength | integer | 旧タイプ専用。旧 mutationsCheck の強度 1/2/3。新しい高度なタイプでは対応する checkerOpt フィールドを使用し、混在させません。 例: 2取得または入力方法: 既存の旧アルゴリズムを維持する場合は元の詳細から読み取ります。 |
|
| jsonScript.checkerOpt.rules[*].direction | string | 旧タイプ専用。旧 mutationsCheck/rangeCheck の方向 up/down/both。新しい高度なタイプでは対応する checkerOpt フィールドを使用し、混在させません。 例: both取得または入力方法: 既存の旧アルゴリズムを維持する場合は元の詳細から読み取ります。 |
|
| jsonScript.checkerOpt.rules[*].checkCount | integer | 旧タイプ専用。旧変化検出のチェック回数(整数)。新しい高度なタイプでは対応する checkerOpt フィールドを使用し、混在させません。 例: 3取得または入力方法: 既存の旧アルゴリズムを維持する場合は元の詳細から読み取ります。 |
|
| jsonScript.checkerOpt.rules[*].periodNum | integer | 旧タイプ専用。旧変化検出/区間の周期数(整数)。新しい高度なタイプでは対応する checkerOpt フィールドを使用し、混在させません。 例: 3取得または入力方法: 既存の旧アルゴリズムを維持する場合は元の詳細から読み取ります。 |
|
| extend.isNeedCreateIssue | boolean | デフォルト false。有効時はチャンネル/担当者/ステータス/レベルマッピングも同時に検証します。 例: false取得または入力方法: イベントから Issue を自動生成する必要がある場合に true。 |
|
| extend.issueLevelUUID | string | 旧互換のレベル。無効な場合は空にクリアされる可能性があり、成功してもレベルが有効であることを証明するものではありません。 例: issl_example取得または入力方法: 有効な Issue レベル一覧から uuid を取得します。 |
|
| extend.issueDfStatus | array | 要素は fatal/critical/error/warning/nodata に限られます。 例: ["critical", "error"]取得または入力方法: どの異常レベルで Issue をトリガーするかを選択します。 |
|
| extend.issueDfStatus[*] | string | 単一の許可ステータス。 例: error取得または入力方法: 実際のアラートレベル。 |
|
| extend.manager | array | 担当者リストは具体的なターゲットに正規化されます。オンコール担当者はワークスペースのタイムゾーンにおける当日のカレンダーに従って解決され、今回の書き込み後はシフト交代に伴って自動変更されません。 例: ["acnt_example"]取得または入力方法: ワークスペースのメンバー/チーム/通知スケジュールから担当者ターゲットを取得します。 |
|
| extend.manager[*] | string | 単一の担当者。事前に取得元が有効であることを確認します。 例: acnt_example取得または入力方法: メンバー/チーム、またはサポートされる当日のオンコールターゲット識別子。 |
|
| extend.incidentsTags | array | Issue 関連タグに使用され、ルールに従ってタグが作成/検証される場合があります。 例: ["production"]取得または入力方法: モニターで適用されるタグ名から取得します。 |
|
| extend.incidentsTags[*] | string | UUID ではありません。 例: production取得または入力方法: 実際の業務タグ名。 |
|
| extend.faultMappingMode | string | Issue 有効時のデフォルトは custom。existing には有効な levelMappingUUID が必要です。 例: custom取得または入力方法: カスタムマッピングは custom、既存マッピングの参照は existing。 |
|
| extend.levelMappingUUID | string | existing の条件では有効な UUID が必須です。custom 分岐ではこの参照フィールドを削除しますが、履歴のカスタム行は保持します。 例: islm_example取得または入力方法: このワークスペースで使用可能な異常レベルマッピング設定から取得します。 |
|
| extend.bindIncidentsInfo | array | custom マッピング行。custom に戻してこのキーを省略した場合、controller は旧行を保持できますが、公開 extend 全体の書き戻しには引き続き注意が必要です。 例: [{"incidentsLevelUUID": "issl_example", "incidentsDfStatus": ["error"]}]取得または入力方法: イベントレベルに対応する Issue レベルに従って構築します。 |
|
| extend.bindIncidentsInfo[*] | json | 1 つのマッピングオブジェクト。 例: {"incidentsLevelUUID": "issl_example", "incidentsDfStatus": ["error"]}取得または入力方法: 単一ステータスからレベルへのマッピング。 |
|
| extend.bindIncidentsInfo[*].incidentsLevelUUID | string | 無効なレベルは空になる可能性があります。 例: issl_example取得または入力方法: 有効な Issue レベル一覧から取得します。 |
|
| extend.bindIncidentsInfo[*].incidentsDfStatus | array | 許可されるステータスの配列。 例: ["error"]取得または入力方法: fatal/critical/error/warning/nodata から選択します。 |
|
| extend.bindIncidentsInfo[*].incidentsDfStatus[*] | string | 単一の許可値。 例: error取得または入力方法: 実際のイベントレベル。 |
|
| extend.smartMonitor.source | string | ai/builtin。新規 OpenAPI では生成資格情報なしで完全な有効設定を直接送信できます。 例: ai取得または入力方法: 対応する生成結果/組み込みテンプレートのメタ情報から取得します。サイトの実際のテンプレート ID を独自に作成しないでください。 |
|
| extend.smartMonitor.category | string | ソース分類。V2 の変更では変更できません。 例: custom取得または入力方法: 対応する生成結果/組み込みテンプレートのメタ情報から取得します。サイトの実際のテンプレート ID を独自に作成しないでください。 |
|
| extend.smartMonitor.prompt | string | AI プロンプト。既存の prompt を変更する場合は候補を再生成する必要があります。 例: 检测生产主机异常。取得または入力方法: 対応する生成結果/組み込みテンプレートのメタ情報から取得します。サイトの実際のテンプレート ID を独自に作成しないでください。 |
|
| extend.smartMonitor.templateId | string | builtin ソースのテンプレート識別子。変更では変更できません。 例: template_example取得または入力方法: 対応する生成結果/組み込みテンプレートのメタ情報から取得します。サイトの実際のテンプレート ID を独自に作成しないでください。 |
|
| extend.smartMonitor.templateVersion | string | builtin テンプレートのバージョン。変更では変更できません。 例: 1取得または入力方法: 対応する生成結果/組み込みテンプレートのメタ情報から取得します。サイトの実際のテンプレート ID を独自に作成しないでください。 |
|
| extend.smartMonitor | json | V2 専用。サーバー側で偽造された実行/バージョン状態をクリアし、engineVersion/configVersion を書き込みます。許可されたフィールドは保持し、旧ソース分類は変更できません。 例: {"source": "ai", "category": "custom", "prompt": "检测生产主机异常。"}取得または入力方法: 生成またはテンプレート選択フローからソースメタ情報を取得します。 |
|
| extend.querylist | array | 任意。存在する場合は保持され、queryType の自動注入より優先されます。targets の実際の DQL を代替するものではなく、誤ったエコー構造は検出が正常であることを証明しません。 例: []取得または入力方法: 既存のクライアントエコー設定がある場合は元の詳細から完全な配列を直接取得します。 |
|
| extend.querylist[*] | json | 動的エディターオブジェクト。クライアントバージョンごとに保存され、実際の検出は targets のみに基づきます。 例: {"qtype": "dql", "query": {"q": "M::cpu:(avg(usage_idle)) BY host"}}取得または入力方法: クライアントエディターが生成した単一クエリのエコー。 |
|
| extend.querylist[*].qtype | string | 実行クエリを自動変換しません。 例: dql取得または入力方法: dql/promql クエリタイプのエコー。 |
|
| extend.querylist[*].query | json | simple/dql モードの詳細を含む場合がありますが、targets の代替にはできません。 例: {"q": "M::cpu:(avg(usage_idle)) BY host"}取得または入力方法: クライアントが生成したクエリ編集構造。 |
|
| extend.querylist[*].query.q | string | 完全な DQL/PromQL のエコー。 例: M::cpu:(avg(usage_idle)) BY host取得または入力方法: 実際の targets クエリテキストと一致させます。 |
|
| alertPolicyUUIDs | array | 任意。新規で省略した場合は [] となりバインドされません。変更で省略した場合は元の関連を保持し、明示的な [] でクリアします。入力全体の有効性を検証し、暗黙的にフィルタリングはしません。ポリシーが無効でも、現在通知を送信できることを意味しません。 null を許可: False 例: ["altpl_example"]取得または入力方法: アラートポリシー一覧からこのワークスペースの未削除ポリシーの uuid を取得します。 |
|
| configVersion | integer | 旧版では省略可能。V2 の変更では現在の正の整数バージョンが必須で、期限切れの場合は HTTP 409 ft.SmartMonitorVersionConflict になります。新規作成では最終バージョンを独自指定しません。 $minValue: 1 例: 1取得または入力方法: 現在の V2 詳細 content.configVersion から取得します。 |
|
| dashboardUUID | string | 任意。新規で関連付ける場合は有効性をチェックします。変更時に省略/空文字列を指定すると既存のダッシュボード参照は削除され、保持されません。 null を許可: False 例: dsbd_example取得または入力方法: ダッシュボード一覧からこのワークスペースの有効なオブジェクト UUID を取得します。 |
|
| extend | json | 任意。null は OpenAPI により {} に正規化されます。公開の追加/変更では rules/querylist が注入されます。明示的なオブジェクトは全体設定として扱われ、深いマージは行われません。変更で完全に省略してもエコー正規化を経て書き込まれるため、旧 extend が自動的に完全保持されることに依存できません。重要なフィールドは書き戻す必要があります。 null を許可: True 例: {}取得または入力方法: 通常ルールの異常関連とクライアントエコーを、以下のネストフィールドに従って入力します。編集時は現在の詳細から取得します。 |
|
| generationId | string | 任意の候補資格情報。ワークスペース/ID/対象ルールおよび prompt にバインドされます。AI V2 で持参する場合は有効な候補と一致する必要があります。OpenAPI の信頼済み互換作成では資格情報なしでも可能です。既存 prompt を変更する場合は再生成してから持参する必要があり、偽造はできません。設定 UUID や実行タスク ID ではありません。 例: GENERATION-ID取得または入力方法: インテリジェントモニタリング生成レスポンスの X-Smart-Monitor-Generation-Id から取得します。 |
|
| jsonScript | json | ビジネス上は完全なオブジェクトを提供する必要があります(親では任意と宣言されています)。変更時は設定全体を書き戻します。V2 と AI セマンティック設定は通常の検出とは異なり、get レスポンス全体を Body として扱いません。本ページで宣言されたフィールドのみを使用し、内部固定 Cron/複数ワークスペース配列など未宣言のキーを追加しないでください。 null を許可: False 例: {"type": "simpleCheck", "title": "生产CPU阈值", "name": "生产CPU阈值", "every": "1m", "interval": 300, "groupBy": ["host"], "targets": [{"dql": "M::cpu:(avg(usage_idle)) BY host", "alias": "Result", "qtype": "dql"}], "checkerOpt": {"rules": [{"status": "warning", "conditionLogic": "and", "conditions": [{"alias": "Result", "operator": "<", "operands": [10]}]}]}}取得または入力方法: まず本ページでサポートされる検出タイプを選択し、その後に検出/テンプレート/クエリ/トリガー定義全体を入力します。 |
|
| jsonScript.atAccounts | array | 任意の配列でデフォルトは []。channels はインシデントの関連付けに使用され、直接の通知対象ではありません。サーバー側でデフォルトチャンネルを補完したり、無効なチャンネルをフィルタリングしたりする場合があります。@外部メールは無料プランでは制限されます。保存しても通知が送信済みであることを意味しません。 null を許可: False 例: ["acnt_example"]取得または入力方法: チャンネルはチャンネル一覧から uuid を取得します。@対象の ID はメンバー一覧からアカウント uuid またはサポート対象のメールアドレスを取得します。 |
|
| jsonScript.atNoDataAccounts | array | 任意の配列でデフォルトは []。channels はインシデントの関連付けに使用され、直接の通知対象ではありません。サーバー側でデフォルトチャンネルを補完したり、無効なチャンネルをフィルタリングしたりする場合があります。@外部メールは無料プランでは制限されます。保存しても通知が送信済みであることを意味しません。 null を許可: False 例: ["acnt_example"]取得または入力方法: チャンネルはチャンネル一覧から uuid を取得します。@対象の ID はメンバー一覧からアカウント uuid またはサポート対象のメールアドレスを取得します。 |
|
| jsonScript.channels | array | 任意の配列でデフォルトは []。channels はインシデントの関連付けに使用され、直接の通知対象ではありません。サーバー側でデフォルトチャンネルを補完したり、無効なチャンネルをフィルタリングしたりする場合があります。@外部メールは無料プランでは制限されます。保存しても通知が送信済みであることを意味しません。 null を許可: False 例: ["chan_example"]取得または入力方法: チャンネルはチャンネル一覧から uuid を取得します。@対象の ID はメンバー一覧からアカウント uuid またはサポート対象のメールアドレスを取得します。 |
|
| jsonScript.checkFuncs | array | 任意。通常のしきい値では不要です。seniorCheck では先頭の funcId/kwargs を使用し、すべての関数を汎用パラメータとして扱いません。 null を許可: False 例: []取得または入力方法: この互換カスタム関数構造を使用する履歴チェックタイプのみを維持し、元の詳細/関数定義から取得します。 |
|
| jsonScript.checkerOpt | json | 通常ルールでは rules が一般的です。高度なタイプは対応するアルゴリズムに従って入力し、V2 では yamlConfig、AI セマンティックでは userPrompt などを使用します。未宣言のサブフィールドは公開検証で拒否されるため、内部 SDK のパラメータ全体を流用しないでください。 null を許可: False 例: {"rules": [{"status": "warning", "conditionLogic": "and", "conditions": [{"alias": "Result", "operator": "<", "operands": [10]}]}]}取得または入力方法: jsonScript.type に応じて、以下のトリガー/アルゴリズム/AI 設定から選択します。 |
|
| jsonScript.checkerOpt.category | string | AI セマンティック専用。AI セマンティックの分類メタ情報(任意の文字列)。 null を許可: False 例: custom取得または入力方法: このワークスペースの AI セマンティックモニタリング機能と業務予算に応じて設定します。任意項目を省略した場合は AI サービスのデフォルトポリシーに委ねられます。 |
|
| jsonScript.checkerOpt.combineExpr | string | タイプ専用パラメータ。組み合わせメンバーの alias 式。組み合わせタイプでは非空が必須で、Result をメンバー別名の代わりに使用しません。 空文字列を許可: False 例: A && B取得または入力方法: 現在の検出タイプに応じて、エディター/元の詳細で具体的なアルゴリズムの意味を確認します。 |
|
| jsonScript.checkerOpt.confidenceInterval | integer | タイプ専用パラメータ。区間 V2 の信頼区間 1..100。実際のアルゴリズムに従って設定します。 例: 90取得または入力方法: 現在の検出タイプに応じて、エディター/元の詳細で具体的なアルゴリズムの意味を確認します。 |
|
| jsonScript.checkerOpt.contextWindowLimit | integer | AI セマンティック専用。正の整数の Token コンテキスト制限(≥1)。 null を許可: False $minValue: 1 例: 8192取得または入力方法: このワークスペースの AI セマンティックモニタリング機能と業務予算に応じて設定します。任意項目を省略した場合は AI サービスのデフォルトポリシーに委ねられます。 |
|
| jsonScript.checkerOpt.creditSoftBudget | number | AI セマンティック専用。1 回あたりの Credit ソフトバジェット。有限の数値 > 0。API 実行のタイムアウトではありません。 null を許可: False 例: 10取得または入力方法: このワークスペースの AI セマンティックモニタリング機能と業務予算に応じて設定します。任意項目を省略した場合は AI サービスのデフォルトポリシーに委ねられます。 |
|
| jsonScript.checkerOpt.diffMode | string | タイプ専用パラメータ。高度な変化検出の value(差分)/percent(パーセント)。明示的に指定する必要があります。 選択可能な値: ['value', 'percent'] 例: percent取得または入力方法: 現在の検出タイプに応じて、エディター/元の詳細で具体的なアルゴリズムの意味を確認します。 |
|
| jsonScript.checkerOpt.direction | string | タイプ専用パラメータ。高度な変化検出/区間の up/down/both。明示的に指定する必要があります。 選択可能な値: ['up', 'down', 'both'] 例: both取得または入力方法: 現在の検出タイプに応じて、エディター/元の詳細で具体的なアルゴリズムの意味を確認します。 |
|
| jsonScript.checkerOpt.disableLargeScaleEventProtect | boolean | 任意の真偽値。true で大規模イベント保護を無効化し、デフォルト false で保護を維持します。 例: false取得または入力方法: 業務上、このアラート/イベント処理動作を確認します。 |
|
| jsonScript.checkerOpt.enableStreamingAggregation | boolean | 任意の三状態。サポートされるタイプのストリーミング集約高速化のみを制御し、モニターの有効/無効や DQL の意味の変更を意味しません。 null を許可: True 例: true取得または入力方法: 独立したスイッチが必要な場合は true/false、ワークスペース設定に従う場合は省略または null。 |
|
| jsonScript.checkerOpt.eps | float | タイプ専用パラメータ。外れ値検出では必須で、数値 0..3.0。このアルゴリズムは通常の rules 条件検証を使用しません。 例: 0.5取得または入力方法: 現在の検出タイプに応じて、エディター/元の詳細で具体的なアルゴリズムの意味を確認します。 |
|
| jsonScript.checkerOpt.ignoreNodata | boolean | 任意の真偽値。組み合わせモニタリングでのみ true で無データを無視し、デフォルト false。 例: false取得または入力方法: 業務上、このアラート/イベント処理動作を確認します。 |
|
| jsonScript.checkerOpt.infoEvent | boolean | 任意の真偽値。true で正常が継続したときに info を生成し、デフォルト false。infoEventCondition はタイプに応じて条件を制御します。 例: false取得または入力方法: 業務上、このアラート/イベント処理動作を確認します。 |
|
| jsonScript.checkerOpt.infoEventCondition | json | 任意。{} は無条件の Info を表します。通常のしきい値/ログ/アプリケーションおよびユーザーアクセスメトリクス/可用性/プロセス/ネットワーク/変化/区間など、サポートされるタイプにのみ適用されます。外れ値/組み合わせ/生存 V2/変更/プログラマブル/インテリジェント/SLO はサポートされず、指定すると UnsupportTriggerFields を返します。非空の場合は alias/operator/operands が完全かつ有効である必要があります。 null を許可: False 例: {"alias": "Result", "operator": ">=", "operands": [60]}取得または入力方法: 実際のクエリ結果と正常業務のしきい値から構築します。 |
|
| jsonScript.checkerOpt.infoEventCondition.alias | string | 非空の Info 条件内で構造に従って入力します。targets の別名に対応します。 例: Result取得または入力方法: 実際のクエリ対象およびしきい値と一致させます。 |
|
| jsonScript.checkerOpt.infoEventCondition.operands | array | 非空の Info 条件内で構造に従って入力します。比較値の配列で、要素は文字列/数値です。オブジェクトは渡しません。 例: [60]取得または入力方法: 実際のクエリ対象およびしきい値と一致させます。 |
|
| jsonScript.checkerOpt.infoEventCondition.operator | string | 非空の Info 条件内で構造に従って入力します。本ページの通常条件演算子から選択します。 例: >=取得または入力方法: 実際のクエリ対象およびしきい値と一致させます。 |
|
| jsonScript.checkerOpt.maxChatRounds | integer | AI セマンティック専用。最大対話ラウンド数(整数 ≥1)。 null を許可: False $minValue: 1 例: 3取得または入力方法: このワークスペースの AI セマンティックモニタリング機能と業務予算に応じて設定します。任意項目を省略した場合は AI サービスのデフォルトポリシーに委ねられます。 |
|
| jsonScript.checkerOpt.maxDQLQueries | integer | AI セマンティック専用。DQL 呼び出し回数の上限(整数 ≥0)。 null を許可: False $minValue: 0 例: 3取得または入力方法: このワークスペースの AI セマンティックモニタリング機能と業務予算に応じて設定します。任意項目を省略した場合は AI サービスのデフォルトポリシーに委ねられます。 |
|
| jsonScript.checkerOpt.mentions | array | AI セマンティックでは任意で、デフォルトは []。各項目は type=dql、非空の namespace/datasource を持ち、index は任意ですが指定する場合は非空です。正規化後の JSON シリアライズ全長は 20000 文字以下です。データクエリの認可を代替しません。 null を許可: False 例: [{"type": "dql", "namespace": "logging", "index": "default", "datasource": "nginx"}]取得または入力方法: 実際の DQL 名前空間、ログインデックス、ソースから参照メタ情報を取得します。 |
|
| jsonScript.checkerOpt.mentions[*] | object | type/namespace/datasource は必須、index は任意です。宣言されている 4 つのフィールドのみを使用します。 例: {"type": "dql", "namespace": "logging", "index": "default", "datasource": "nginx"}取得または入力方法: 各項目に 1 つの DQL 参照。 |
|
| jsonScript.checkerOpt.mentions[*].datasource | string | 条件付き必須 | 参照項目内の実際のデータソース名(例: ログ source/メジャーメント)。名前空間に応じて解釈されます。 空文字列を許可: False 例: nginx取得または入力方法: 同じ対象ワークスペースの実際のデータから選択します。 |
| jsonScript.checkerOpt.mentions[*].index | string | 参照項目内のログ参照では実際のインデックス名/識別子を入力し、その他のタイプでは省略できます。 空文字列を許可: False 例: default取得または入力方法: 同じ対象ワークスペースの実際のデータから選択します。 |
|
| jsonScript.checkerOpt.mentions[*].namespace | string | 条件付き必須 | 参照項目内の実際の DQL 名前空間。エンティティタイプではありません。 空文字列を許可: False 例: logging取得または入力方法: 同じ対象ワークスペースの実際のデータから選択します。 |
| jsonScript.checkerOpt.mentions[*].type | string | 条件付き必須 | 参照項目内では固定で dql。 選択可能な値: ['dql'] 例: dql取得または入力方法: 同じ対象ワークスペースの実際のデータから選択します。 |
| jsonScript.checkerOpt.model | string | AI セマンティック専用。AI セマンティックの任意のモデル名。サイトでサポートされるモデル設定から取得する必要があり、ドキュメント例のリテラル値を使用できません。 null を許可: False 例: example-model取得または入力方法: このワークスペースの AI セマンティックモニタリング機能と業務予算に応じて設定します。任意項目を省略した場合は AI サービスのデフォルトポリシーに委ねられます。 |
|
| jsonScript.checkerOpt.openMatchTimes | boolean | 任意の真偽値。true で連続トリガー一致を有効化し、デフォルト false。rules[].matchTimes と組み合わせます。 例: false取得または入力方法: 業務上、このアラート/イベント処理動作を確認します。 |
|
| jsonScript.checkerOpt.openOkConditions | boolean | 任意の真偽値。true で段階的復旧を有効化し、デフォルト false。okConditions はトリガーと復旧の境界を満たす必要があります。 例: false取得または入力方法: 業務上、このアラート/イベント処理動作を確認します。 |
|
| jsonScript.checkerOpt.rules | array | 通常ルールの条件配列。各項目は status/conditionLogic/conditions を持ち、復旧には okConditions を使用します。誤ったメンバー/演算形状は通常例外をスローして最終的に 500 になる場合があり、一概に 406 ではありません。空の operands を持つ条件はスケジューリング構築前にフィルタリングされるため、「すべて」を表現する用途には使用しません。 null を許可: False 例: [{"status": "warning", "conditionLogic": "and", "conditions": [{"alias": "Result", "operator": "<", "operands": [10]}]}]取得または入力方法: イベントをトリガーできるレベルと対象 Result に基づいて構築します。 |
|
| jsonScript.checkerOpt.script | string | タイプ専用パラメータ。プログラマブル検出のスクリプトテキスト。このタイプでサポートされる構文を使用します。この API はスクリプトのテスト実行を行いません。 空文字列を許可: True null を許可: False 例: return {}取得または入力方法: 現在の検出タイプに応じて、エディター/元の詳細で具体的なアルゴリズムの意味を確認します。 |
|
| jsonScript.checkerOpt.systemPrompt | string | AI セマンティック専用。AI セマンティックでは任意。指定する場合は非空で、Python 文字数 ≤20000。 空文字列を許可: True null を許可: False 最大長: 20000 例: 结合实际查询结果判断,不臆测缺失数据。取得または入力方法: このワークスペースの AI セマンティックモニタリング機能と業務予算に応じて設定します。任意項目を省略した場合は AI サービスのデフォルトポリシーに委ねられます。 |
|
| jsonScript.checkerOpt.threshold | json | 任意のオブジェクト。指定する場合、status/operator/value はすべて必須と宣言されています。status=false で前提条件判定を無効化し、value は null を許可しますが、アルゴリズムの実際の意味に従って入力してください。 null を許可: False 例: {"status": false, "operator": ">", "value": 90}取得または入力方法: 高度な変化検出のトリガー前提。実際の業務しきい値によって決定します。 |
|
| jsonScript.checkerOpt.threshold.operator | string | 条件付き必須 | 親オブジェクトが存在する場合に必須。前提比較演算子(例: >)。実際の高度な検出の互換集合に従います。 例: >取得または入力方法: 高度な変化検出の前提条件定義に従って入力します。 |
| jsonScript.checkerOpt.threshold.status | boolean | 条件付き必須 | 親オブジェクトが存在する場合に必須。前提条件を有効にするかどうか。 例: false取得または入力方法: 高度な変化検出の前提条件定義に従って入力します。 |
| jsonScript.checkerOpt.threshold.value | float | 条件付き必須 | 親オブジェクトが存在する場合に必須。前提数値。status=false では null を許可し、status=true では数値が必須で、そうでない場合は IllegalMutationParameters。単位はクエリ結果と一致させます。 null を許可: True 例: 90取得または入力方法: 高度な変化検出の前提条件定義に従って入力します。 |
| jsonScript.checkerOpt.userPrompt | string | AI セマンティック専用。AI セマンティック条件では必須で非空、Python 文字数 ≤20000。空文字列を許可すると宣言されていますが、業務上は空白を受け付けません。 空文字列を許可: True null を許可: False 最大長: 20000 例: 分析最近5分钟生产服务错误率是否异常。取得または入力方法: このワークスペースの AI セマンティックモニタリング機能と業務予算に応じて設定します。任意項目を省略した場合は AI サービスのデフォルトポリシーに委ねられます。 |
|
| jsonScript.checkerOpt.yamlConfig | string | V2 でのみ必須。非空の UTF-8 YAML テキストで 256KiB 以下。JSON オブジェクトや Markdown フェンスではありません。構造は本ページの YAML 表を参照してください。アンカー/エイリアス/明示的 tag/重複キーは禁止です。変更では既存の DQL、threshold 設定、アルゴリズム params のみ許可され、ルール集合/名前/実行構造は変更できません。保存時にプロトコル/予算を検証し、チェッククエリのデータ領域権限を解析しますが、DQL を実行したり、データの存在/ソース認可が完全に再確認済みであることを保証したりしません。 例: "version: 1\nname: production\nevent:\n title: \"{{Scene.problem_title}}\"\n message: \"{{Scene.problem_message}}\"\nrules:\n - id: cpu_idle\n name: CPU idle\n query:\n dql: \"M::cpu:(avg(usage_idle)) BY host\"\n scene_by: [host]\n detect:\n threshold:\n operator: \"<\"\n operands: [10]\n display:\n signal: CPU idle\n"取得または入力方法: 生成 APIまたは組み込みテンプレートから完全で有効な YAML を取得し、許可された範囲で編集します。 |
|
| jsonScript.customCrontab | string | 任意。非空の場合は every より優先されます。5 段または秒付き 6 段をサポートし、秒のステップ形式は 20 未満にできません。組み合わせモニタリングおよび組み合わせメンバーにはカスタム頻度の競合制限があります。V2 では禁止です。検出タイムゾーンは現在のワークスペース/サービス設定に従い、文字列内のタイムゾーン名でフィールドを代替しません。 null を許可: False 例: 0 */5 * * * *取得または入力方法: カスタム頻度の場合は Cron エディターに従って完全な式を入力します。 |
|
| jsonScript.delaySeconds | integer | 任意。通常モニタリングのデータ待機ウィンドウ(秒)。0 は待機なし、省略時は 0。真偽値は整数として扱いません。インテリジェント/AI は通常の待機設定を使用せず、これでインテリジェント実行の遅延を調整することはできません。 null を許可: False 選択可能な値: [0, 60, 120, 180, 300, 600, 900, 1800] 例: 60取得または入力方法: データ到着遅延に応じて 0/60/120/180/300/600/900/1800 を選択します。 |
|
| jsonScript.disableCheckEndTime | boolean | 任意の互換真偽値。デフォルト false。実際のサポートは検出タイプに依存します。 null を許可: False 例: false取得または入力方法: チェック終了時間制限を解除する必要がある場合に true。 |
|
| jsonScript.eventChartEnable | boolean | 任意でデフォルト false。サポートされる Doris ログ主ストレージ処理のみです。保存成功はグラフが生成済みであることを証明しません。 null を許可: False 例: false取得または入力方法: イベントグラフをサポートするデータストレージ機能がある場合に選択します。 |
|
| jsonScript.eventCharts | array | 任意のグラフ設定配列。イベントグラフを有効にする場合に併せて指定します。具体的な結果はイベント処理チェーンで生成され、書き込みレスポンスでは返されません。 null を許可: False 例: [{"dql": "M::cpu:(avg(usage_idle)) BY host"}]取得または入力方法: 実際のデータからイベント表示用クエリを検証します。 |
|
| jsonScript.eventCharts[*] | object | 宣言されているのは dql サブフィールドのみです。 例: {"dql": "M::cpu:(avg(usage_idle)) BY host"}取得または入力方法: 検証済みの単一グラフクエリ。 |
|
| jsonScript.eventCharts[*].dql | string | 任意のクエリテキスト。グラフ UUID ではなく、保存時にグラフクエリを実行しません。 null を許可: False 例: M::cpu:(avg(usage_idle)) BY host取得または入力方法: サポートされるデータソースから実際のメトリクス/フィールドに基づいて DQL を作成します。 |
|
| jsonScript.every | string | 通常の共通プラグインでは every または customCrontab が必要です。最大 24h、最小 20s を推奨します。有効な正の整数形式を使用し、0/負値や d/w は使用できません。一部の形式問題は 500 になる可能性があります。V2 は固定 10m で、サーバー側が every を上書きします。AI セマンティックは独自の検出頻度に従います。 null を許可: False 例: 1m取得または入力方法: 業務上の検出頻度に応じて正の整数 + s/m/h(例: 1m、5m、1h)を選択します。 |
|
| jsonScript.groupBy | array | 任意の次元名の配列。通常 [] は追加次元でグループ化しないことを表し、タグ値ではありません。組み合わせモニタリングメンバーの次元は互換である必要があります。 null を許可: False 例: ["host"]取得または入力方法: 実際の DQL が返すグループ化フィールドから選択し、BY 次元と一致させます。 |
|
| jsonScript.interval | integer | 通常で targets がある場合は 1..2592000 秒(30 日)が必要です。every の検出頻度とは異なります。組み合わせモニタリングではこの共通チェックをスキップし、V2 では YAML の query.interval/lookback を使用します。 null を許可: False 例: 300取得または入力方法: 検出に必要な時間範囲に応じて正の整数秒を選択し、実際のデータ粒度と調整します。 |
|
| jsonScript.isChangeEvent | boolean | OuterEventChecker では任意でデフォルト false。その他のタイプでは使用しません。 null を許可: False 例: false取得または入力方法: 外部イベントが変更イベントの場合に true。 |
|
| jsonScript.message | string | event の内容。対応するチェックタイプに応じて任意入力です。変更時に省略を保持と見なすことはできず、設定全体を書き戻す必要があります。任意で、省略時は独立したテキストを提供しません。現在の共通構造では title/message と無データテキストが主なソースであり、旧 recover 専用フィールドは各検出を個別にカバーすることを保証しません。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されません。 空文字列を許可: True null を許可: False 例: 主机 {{host}} 检测结果 {{Result}}取得または入力方法: 実際の検出次元と結果変数に応じてイベント/通知テンプレートを作成します。同じタイプの検証済みイベントから再利用できます。 |
|
| jsonScript.noDataAction | string | 任意。none/checkAs0/noDataEvent/noDataEventRepeat/fatalEvent/criticalEvent/errorEvent/warningEvent/okEvent/noData/recover。noDataEventRepeat は適用されるタイプのみをサポートし、正の整数の noDataInterval が必要です。省略/空の互換値と正の継続時間には専用の履歴処理があり、デフォルト実装に依存して繰り返しアラートを出すことはありません。 null を許可: False 選択可能な値: ['none', 'checkAs0', 'noDataEvent', 'noDataEventRepeat', 'fatalEvent', 'criticalEvent', 'errorEvent', 'warningEvent', 'okEvent', 'noData', 'recover'] 例: noDataEvent取得または入力方法: 無データの業務上の意味に応じて本パラメータの列挙から選択します。 |
|
| jsonScript.noDataInterval | integer | タイプに応じて任意入力。無データの継続時間(秒)。通常頻度では整数の検出周期に切り上げられ、カスタム頻度では秒をそのまま使用します。repeat の無データでは正の整数が必須です。変更時は適用される設定を完全に保持し、単位を混在させないでください。 null を許可: False 例: 600取得または入力方法: 業務でウィンドウ/オフセット/継続時間を決定し、まず対応するタイプの詳細と実際のイベントで確認します。 |
|
| jsonScript.noDataMessage | string | 無データイベント情報テンプレートを出力。対応するチェックタイプに応じて任意入力です。変更時に省略を保持と見なすことはできず、設定全体を書き戻す必要があります。任意で、省略時は独立したテキストを提供しません。現在の共通構造では title/message と無データテキストが主なソースであり、旧 recover 専用フィールドは各検出を個別にカバーすることを保証しません。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されません。 空文字列を許可: True null を許可: False 例: 主机 {{host}} 检测结果 {{Result}}取得または入力方法: 実際の検出次元と結果変数に応じてイベント/通知テンプレートを作成します。同じタイプの検証済みイベントから再利用できます。 |
|
| jsonScript.noDataNotificationMessage | string | データ欠損イベントの通知内容。対応するチェックタイプに応じて任意入力です。変更時に省略を保持と見なすことはできず、設定全体を書き戻す必要があります。任意で、省略時は独立したテキストを提供しません。現在の共通構造では title/message と無データテキストが主なソースであり、旧 recover 専用フィールドは各検出を個別にカバーすることを保証しません。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されません。 空文字列を許可: True null を許可: False 例: 主机 {{host}} 检测结果 {{Result}}取得または入力方法: 実際の検出次元と結果変数に応じてイベント/通知テンプレートを作成します。同じタイプの検証済みイベントから再利用できます。 |
|
| jsonScript.noDataRecoverMessage | string | 無データ復旧アップロードイベント情報テンプレートを出力。対応するチェックタイプに応じて任意入力です。変更時に省略を保持と見なすことはできず、設定全体を書き戻す必要があります。任意で、省略時は独立したテキストを提供しません。現在の共通構造では title/message と無データテキストが主なソースであり、旧 recover 専用フィールドは各検出を個別にカバーすることを保証しません。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されません。 空文字列を許可: True null を許可: False 例: 主机 {{host}} 检测结果 {{Result}}取得または入力方法: 実際の検出次元と結果変数に応じてイベント/通知テンプレートを作成します。同じタイプの検証済みイベントから再利用できます。 |
|
| jsonScript.noDataRecoverTitle | string | 無データ復旧アップロードイベントタイトルテンプレートを出力。対応するチェックタイプに応じて任意入力です。変更時に省略を保持と見なすことはできず、設定全体を書き戻す必要があります。任意で、省略時は独立したテキストを提供しません。現在の共通構造では title/message と無データテキストが主なソースであり、旧 recover 専用フィールドは各検出を個別にカバーすることを保証しません。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されません。 空文字列を許可: True null を許可: False 例: 主机 {{host}} 检测结果 {{Result}}取得または入力方法: 実際の検出次元と結果変数に応じてイベント/通知テンプレートを作成します。同じタイプの検証済みイベントから再利用できます。 |
|
| jsonScript.noDataTitle | string | 無データイベントタイトルテンプレートを出力。対応するチェックタイプに応じて任意入力です。変更時に省略を保持と見なすことはできず、設定全体を書き戻す必要があります。任意で、省略時は独立したテキストを提供しません。現在の共通構造では title/message と無データテキストが主なソースであり、旧 recover 専用フィールドは各検出を個別にカバーすることを保証しません。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されません。 空文字列を許可: True null を許可: False 例: 主机 {{host}} 检测结果 {{Result}}取得または入力方法: 実際の検出次元と結果変数に応じてイベント/通知テンプレートを作成します。同じタイプの検証済みイベントから再利用できます。 |
|
| jsonScript.notificationMessage | string | イベントの通知内容。対応するチェックタイプに応じて任意入力です。変更時に省略を保持と見なすことはできず、設定全体を書き戻す必要があります。任意で、省略時は独立したテキストを提供しません。現在の共通構造では title/message と無データテキストが主なソースであり、旧 recover 専用フィールドは各検出を個別にカバーすることを保証しません。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されません。 空文字列を許可: True null を許可: False 例: 主机 {{host}} 检测结果 {{Result}}取得または入力方法: 実際の検出次元と結果変数に応じてイベント/通知テンプレートを作成します。同じタイプの検証済みイベントから再利用できます。 |
|
| jsonScript.openNoDataNotificationMessage | boolean | 任意でデフォルト false。無効時は対応するイベント内容を使用します。有効にする場合は対応する notificationMessage/noDataNotificationMessage も指定します。 null を許可: False 例: false取得または入力方法: 通知専用の内容を別途使用する必要がある場合に true。 |
|
| jsonScript.openNotificationMessage | boolean | 任意でデフォルト false。無効時は対応するイベント内容を使用します。有効にする場合は対応する notificationMessage/noDataNotificationMessage も指定します。 null を許可: False 例: false取得または入力方法: 通知専用の内容を別途使用する必要がある場合に true。 |
|
| jsonScript.periodBefore | integer | タイプに応じて任意入力。高度な変化検出の比較オフセット秒数(例: 昨日なら 86400)。range/range_2 と併せて完全に入力します。変更時は適用される設定を完全に保持し、単位を混在させないでください。 null を許可: False 例: 86400取得または入力方法: 業務でウィンドウ/オフセット/継続時間を決定し、まず対応するタイプの詳細と実際のイベントで確認します。 |
|
| jsonScript.range | integer | タイプに応じて任意入力。高度な変化検出の現在の比較ウィンドウ(正の整数秒)。変更時は適用される設定を完全に保持し、単位を混在させないでください。 null を許可: False 例: 3600取得または入力方法: 業務でウィンドウ/オフセット/継続時間を決定し、まず対応するタイプの詳細と実際のイベントで確認します。 |
|
| jsonScript.range_2 | integer | タイプに応じて任意入力。高度な変化検出の比較ウィンドウ設定。-1 は前周期比、0 は periodBefore に従い、その他は対応する高度な検出定義の秒ウィンドウに従います。変更時は適用される設定を完全に保持し、単位を混在させないでください。 null を許可: False 例: -1取得または入力方法: 業務でウィンドウ/オフセット/継続時間を決定し、まず対応するタイプの詳細と実際のイベントで確認します。 |
|
| jsonScript.recoverMessage | string | 復旧イベント情報テンプレートを出力。対応するチェックタイプに応じて任意入力です。変更時に省略を保持と見なすことはできず、設定全体を書き戻す必要があります。任意で、省略時は独立したテキストを提供しません。現在の共通構造では title/message と無データテキストが主なソースであり、旧 recover 専用フィールドは各検出を個別にカバーすることを保証しません。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されません。 空文字列を許可: True null を許可: False 例: 主机 {{host}} 检测结果 {{Result}}取得または入力方法: 実際の検出次元と結果変数に応じてイベント/通知テンプレートを作成します。同じタイプの検証済みイベントから再利用できます。 |
|
| jsonScript.recoverNeedPeriodCount | integer | タイプに応じて任意入力。通常頻度では連続復旧周期数、customCrontab では秒単位の復旧時間です。省略時は 0。変更時は適用される設定を完全に保持し、単位を混在させないでください。 null を許可: False 例: 1取得または入力方法: 業務でウィンドウ/オフセット/継続時間を決定し、まず対応するタイプの詳細と実際のイベントで確認します。 |
|
| jsonScript.recoverTitle | string | 復旧イベントタイトルテンプレートを出力。対応するチェックタイプに応じて任意入力です。変更時に省略を保持と見なすことはできず、設定全体を書き戻す必要があります。任意で、省略時は独立したテキストを提供しません。現在の共通構造では title/message と無データテキストが主なソースであり、旧 recover 専用フィールドは各検出を個別にカバーすることを保証しません。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されません。 空文字列を許可: True null を許可: False 例: 主机 {{host}} 检测结果 {{Result}}取得または入力方法: 実際の検出次元と結果変数に応じてイベント/通知テンプレートを作成します。同じタイプの検証済みイベントから再利用できます。 |
|
| jsonScript.subUri | string | OuterEventChecker の新規作成では必須の非空文字列。公開受信 URL は単一のパスセグメントで、/ を含めることはできません(%2F にエンコードしても 404 になります)。英数字とハイフンを推奨します。複数のルールで同じサフィックスを使用できますが、一意性は secret が担います。通常の検出では入力しません。 null を許可: False 例: datakit-push取得または入力方法: 現在の外部イベント連携用に Webhook サフィックスを選択します。 |
|
| jsonScript.targetWorkspaceUUID | string | 任意。デフォルトはこのワークスペース。simpleCheck、seniorMutationsCheck、seniorRangeCheck、seniorRangeV2Check、outlierCheck のクロスワークスペースクエリ消費に適用されます。書き込み時は候補 index_list を生成し、呼び出し ID のデータ領域権限を検証するのみで、保存成功はソース認可が完全に再確認済みであることやデータが照会可能であることを意味しません。呼び出し前に実際の対象認可を確認してください。V2 では禁止で、認可されたワークスペース内の YAML クエリを使用します。 空文字列を許可: False null を許可: False 例: wksp_source_example取得または入力方法: 有効なクロスワークスペース認可から単一のソースワークスペースを取得します。 |
|
| jsonScript.targets | array | 通常のクエリ対象配列。DQL/PromQL の実際の実行文は dql に置きます。通常の共通プラグインの alias は Result または空のみを受け付け、別名の一意性をチェックします。単一対象の Result を推奨します。組み合わせモニタリングでは monitorCheckerId/alias でメンバーを関連付けます。V2 では targets は禁止で、すべて YAML に置きます。 null を許可: False 例: [{"dql": "M::cpu:(avg(usage_idle)) BY host", "alias": "Result", "qtype": "dql"}]取得または入力方法: まず対象ワークスペースの同じデータソースでクエリを検証し、フィールド/インデックスが実在する必要があります。 |
|
| jsonScript.title | string | 条件付き必須 | 必須文字列。非空を推奨。最大 256 で、ASCII/半角カタカナは 1、その他の文字は 2 としてカウントします。非空値はルールの name にコピーされ、重複名チェックの対象になります。通常/セルフホストインスペクションは重複名グループを共有し、インテリジェント/AI はそれぞれ別グループです。テンプレート実行時に変数が存在するかは実際のイベントで受け入れる必要があります。 空文字列を許可: True null を許可: False 最大長: 256 例: 生产CPU阈值取得または入力方法: 業務側がルール/異常イベントのタイトルを定義します。検出結果のテンプレート変数を使用できます。 |
| jsonScript.type | string | 条件付き必須 | 必須のプラグイン識別子。mutationsCheck/rangeCheck/seniorCheck などの履歴互換および旧 smart* は引き続き元の設定に従って維持する必要があり、エンティティタイプで代替しません。具体的なフィールドはそのタイプにのみ適用され、混在できません。V2 と旧版は相互に切り替えできません。 null を許可: False 例: simpleCheck取得または入力方法: 検出方法に応じて選択します。通常は simpleCheck しきい値、apmCheck/rumCheck/processCheck/cloudDialCheck/networkCheck/objectCheck。高度は seniorMutationsCheck/seniorRangeCheck/seniorRangeV2Check/outlierCheck。combinedCheck は組み合わせ、OuterEventChecker は外部イベント、programmableCheck はプログラマブル。インテリジェント V2 は smartMonitorV2Check、AI セマンティックは aiMonitor(エンティティタイプと同名ですがフィールド階層が異なります)。 |
| jsonScript.windowDql | string | 任意の互換ウィンドウクエリテキスト。イベントの追加資料として透過的に渡され、targets 内の実際の検出クエリを代替しません。省略時は提供しません。 null を許可: False 例: M::cpu:(avg(usage_idle)) BY host取得または入力方法: 検証済みの元の検出ウィンドウ表示クエリまたは同じタイプの詳細から取得します。 |
|
| openPermissionSet | boolean | 任意でデフォルト false。変更時に省略すると false に戻ります。この権限はリソース操作のみを制約し、API 権限やデータクエリ認可を代替できません。 null を許可: False 例: false取得または入力方法: 指定した主体で操作を制限する必要がある場合に true。 |
|
| permissionSet | array | 任意でデフォルト []。変更時に省略すると [] に戻ります。主体には非 Owner ロール、acnt_ メンバー、group_ チームを指定でき、openPermissionSet と組み合わせます。事前に有効な ID を確認し、保存成功を各主体に実際のアクセス権があることと見なさないでください。 null を許可: False 例: ["wsAdmin"]取得または入力方法: このワークスペースのロール、メンバー、チーム管理から操作主体の識別子を取得します。 |
|
| queryType | string | 任意でデフォルト dql。simple/dql のみをサポートします。明示的な extend.querylist がある場合はそれを優先し、その注入セマンティクスを無視します。simple の解析に失敗すると dql にフォールバックし、実際の targets クエリは変更しません。 null を許可: False 例: dql取得または入力方法: 元の実行クエリは jsonScript.targets[].dql にあります。このフィールドはクライアントエディターのエコー変換のみを制御します。 |
|
| secret | string | 任意。外部イベントで未指定の場合はサーバー側で生成できます。現在のワークスペースだけでなく全体で一意です(他のワークスペース/履歴レコードを含む)。変更時に省略/空文字列を指定すると元の secret を保持し、非空値の場合のみ置換して全体一意性を検証します。変更すると Webhook アドレスに影響します。実際の secret をログや公開ドキュメントに書き込まないでください。 null を許可: False 例: SECRET-PLACEHOLDER取得または入力方法: OuterEventChecker でのみ使用し、推測不可能な一意のランダム識別子を生成します。その後、信頼できる詳細から Webhook アドレスを保管します。 |
|
| status | integer | 任意でデフォルト 0。変更時に省略すると有効として扱われ、無効状態を保持しません。設定のみを変更する無効ルールは明示的に status=2 を指定してください。 null を許可: False 選択可能な値: [0, 2] 例: 0取得または入力方法: 0 は有効、2 は無効。 |
|
| tags | array | 任意の名前配列。UUID ではありません。新規で省略すると [] となりタグなしです。変更時に省略すると [] として参照を更新し、旧タグがクリアされる可能性があります。タグスコープに従って検証され、monitor スコープに合わない場合は TagScopeMismatch を返すことがあります。 null を許可: False 例: ["production"]取得または入力方法: タグ一覧から monitor スコープに適用されるタグ名を取得します。新しい名前が必要な場合はタグ管理ルールに従って作成します。 |
|
| tags[*] | string | 単一の名前文字列。UUID ではありません。 null を許可: False 例: production取得または入力方法: タグ一覧から monitor/all スコープに適用される単一の業務タグ名を取得します。 |
|
| type | string | 新規では任意でデフォルト trigger。jsonScript.type をこのエンティティタイプの代わりにしません。インテリジェント V2 では smartMonitor が必要です。旧インテリジェントは引き続き OpenAPI 書き込み互換を保持します。変更時に type を宣言しない場合は元のカテゴリを引き継ぎ、インテリジェント実行バージョンを随意に切り替えることはできません。 null を許可: False 例: trigger取得または入力方法: 通常ルールは trigger、旧/新インテリジェントモニタリングは smartMonitor、AI セマンティックモニタリングは aiMonitor を選択します。 |
パラメータ補足説明¶
V2 yamlConfig 内部フィールド(完全な YAML 文字列として送信):
| YAML フィールド | 型 | 値、取得元、省略ルール |
|---|---|---|
version |
integer |
必須、固定値 1。 |
name |
string |
必須で非空。trim 後 128 文字以下。新規で定義した後は変更できません。 |
event.title / event.message |
string |
いずれも必須で非空、8000 文字以下。Scene. の公開変数のみ許可され、Jinja 制御ブロック/コメントはサポートしません。 |
rules |
array |
必須で 1..10 条。少なくとも 1 条は enabled=true です。 |
rules[].id |
string |
必須で一意。正規表現 [a-z][a-z0-9_]{2,63}。 |
rules[].name |
string |
必須で非空。trim 後 128 文字以下。 |
rules[].enabled |
boolean |
任意でデフォルト true。現在の変更では構造の有効/無効を変更できません。 |
rules[].query.dql |
string |
必須。実際に認可可能な DQL。UTF-8 全体は引き続き 256KiB の総量制限を受けます。変更可能です。 |
rules[].query.interval |
string |
任意。正の整数 + s/m/h/d、24h 以下。seasonal のデフォルトは 5m、その他は 1m。 |
rules[].query.lookback |
string |
任意。auto(デフォルト)または正の整数 + s/m/h/d。予算を超えることはできません。 |
rules[].scene_by |
array<string> |
必須で非空。空白除去後に一意な実際の次元フィールド。 |
rules[].detect |
object |
threshold と algorithm のいずれか一方。同時に指定できません。threshold 分岐では params を指定しません。 |
rules[].detect.threshold.operator |
string |
必須。>、>=、<、<=、==、!=、between、outside。 |
rules[].detect.threshold.operands |
array<number> |
有限の数値を 1 個比較します。between/outside はちょうど 2 個で、下限 ≤ 上限です。 |
rules[].detect.threshold.consecutive |
integer |
任意でデフォルト 1、1..60。 |
rules[].detect.algorithm |
string |
basic.robust_band@1、seasonal.robust_mad@2、seasonal.adaptive_mad@1、peer.robust_mad@1。seasonal.robust_mad@1 は既存設定の互換のみ。 |
rules[].detect.params |
object または null |
アルゴリズムごとに許可されるキー。未知のキーは受け付けません。basic および seasonal@2/adaptive では null を許可し、{} として検証します。 |
rules[].detect.params.band |
string |
basic では任意で mad/quantile。 |
rules[].detect.params.direction |
string |
対応するアルゴリズムがサポートする場合に high/low/both。 |
rules[].detect.params.score |
number |
対応するアルゴリズムで任意。有限の数値 1..20。 |
rules[].detect.params.period |
integer または null |
seasonal@2/adaptive では null または 2..10000 を任意指定。省略/空は 1 日分のサンプル点で推定します。旧 @1 は 2..10080 が必須。 |
rules[].detect.params.consecutive |
integer |
旧 seasonal@1 のみで 1..60 を使用可能。デフォルト 1。 |
rules[].detect.params.min_cycles |
integer |
旧 seasonal@1 のみ。デフォルト 3、2..12。 |
rules[].detect.params.peer_by |
array<string> |
peer では必須。空を許可しますが、各要素は空白除去後に一意で、scene_by の部分集合である必要があります。 |
rules[].no_data |
object または null |
任意。デフォルトは ignore/1。許可されるキーは action、consecutive。 |
rules[].no_data.action |
string |
ignore/anomaly。デフォルトは ignore。 |
rules[].no_data.consecutive |
integer |
デフォルト 1、1..60。 |
rules[].display.signal |
string |
必須で非空。trim 後 128 文字以下。 |
rules[].display.unit |
string または null |
任意。64 文字以下。単位表示は元のクエリ数値を変更しません。 |
Scene 変数は dimension_text、dimension_subject、matched_rule_count、matched_rules_markdown、primary_condition、primary_rule_name、primary_signal、primary_value、problem_message、problem_summary、problem_title のみです。サンプリング履歴の予算は同時に 10000 点以下かつ 60 日以下である必要があります。basic は日次サンプリングで最大 61 日です。アルゴリズムの履歴/証拠/連続トリガー要件も合算して予算に計上され、明示的な lookback で回避できません。変更では DQL、既存の threshold 設定、algorithm.params のみ許可され、その他の実行構造/ルールメタ情報は元の値を保持します。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/checker/add' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"queryType":"dql","status":0,"extend":{},"alertPolicyUUIDs":[],"tags":[],"jsonScript":{"type":"simpleCheck","title":"生产CPU阈值","every":"1m","interval":300,"groupBy":["host"],"targets":[{"dql":"M::cpu:(avg(usage_idle)) BY host","alias":"Result","qtype":"dql"}],"checkerOpt":{"rules":[{"status":"warning","conditionLogic":"and","conditions":[{"alias":"Result","operator":"<","operands":[10]}]}]}},"openPermissionSet":false,"permissionSet":[],"type":"trigger"}'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer | 現在のレコード番号。履歴分岐では履歴レコード番号。 |
| content.uuid | string | 現在の rul_ UUID。ruleHistory=1 で履歴レコードがある場合は ruleh_ 履歴 UUID となり、以降の変更でもリクエストの現在の UUID を使用します。 |
| content.ruleUUID | string | 履歴分岐のみ。所属する現在のモニター UUID。 |
| content.workspaceUUID | string | オブジェクトが属するワークスペース。 |
| content.monitorUUID | string | 関連するモニターグループ UUID。 |
| content.type | string | エンティティカテゴリ。通常は trigger/smartMonitor/aiMonitor で、jsonScript.type の検出アルゴリズムとは異なります。 |
| content.refKey | string | 互換業務関連キー。通常は空文字列。 |
| content.secret | string または null | 外部イベントの Webhook 識別子などの共有フィールド。一般の API Key として扱わず、機密の実値をログに書き込まないでください。 |
| content.jsonScript | object | 保存された検出設定。jsonScript.type およびバージョンに応じて解釈されます。読み取りでは検出を実行しません。 |
| content.crontabInfo | object | スケジューリング設定。フィールドは単一/複数ワークスペースおよびアルゴリズムによって変化し、{} の場合があります。 |
| content.crontabInfo.id | string | メインスケジューリング設定 ID。省略可能。 |
| content.crontabInfo.crontab | string または null | 実際に実行される Cron。明示的な null または省略(Cron のない組み合わせモニタリングなど)が可能で、入力の every とは異なります。 |
| content.crontabInfo.smartRelId | string | 一部のインテリジェントモニタリング付属スケジューリング ID。省略可能。 |
| content.crontabInfo.multiWsCrontabInfo | array<object> |
クロスワークスペースの各スケジューリング資料。履歴に存在する場合があり、省略可能。 |
| content.crontabInfo.multiWsCrontabInfo[].ws_uuid | string | 対象ワークスペース UUID。 |
| content.crontabInfo.multiWsCrontabInfo[].id | string | そのワークスペースのスケジューリング ID。 |
| content.crontabInfo.multiWsCrontabInfo[].crontab | string または null | そのワークスペースの実際の Cron。明示的な null または省略が可能。 |
| content.extend | object | 追加のエコー/インシデント関連設定。履歴のカスタムフィールドを含む場合があります。全体を盲目的に書き戻して変更しないでください。 |
| content.extend.カスタムフィールド | JSON | 履歴またはタイプ固有の保存値。現在のタイプ詳細および作成 API の公開構造に従います。 |
| content.createdWay | string | manual/import/template または履歴の空値。 |
| content.isLocked | integer または boolean | ロック状態。履歴分岐では省略される場合があります。 |
| content.openPermissionSet | boolean | カスタム操作権限スイッチ。読み取り成功から変更可能と推測できません。 |
| content.permissionSet | array<string> |
カスタム操作主体 UUID。 |
| content.permissionSet[] | string | アカウント/チーム/ロール識別子。 |
| content.status | integer | 0 は有効、2 は無効。未削除クエリには他の履歴状態が含まれる場合があり、直近の実行結果を表しません。 |
| content.creator | string | 作成者。 |
| content.updator | string | 更新者。 |
| content.createAt | integer | 作成 Unix 秒。 |
| content.updateAt | integer | 更新 Unix 秒。未更新は -1。 |
| content.deleteAt | integer | 削除 Unix 秒。未削除は -1。 |
| content.configVersion | integer | V2 の現在の設定バージョン追加フィールド。通常ルールでは省略可能。 |
| content.jsonScript.targetWorkspaceUUID | string | 対象ワークスペース。クロスワークスペースクエリ。しきい値検出タイプのみをサポートします(2025-08-13 のイテレーションで追加)。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.type | string | 検出方法タイプ。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.windowDql | string | window dql。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.title | string | event のタイトルを生成。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.message | string | event の内容。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.recoverTitle | string | 復旧イベントタイトルテンプレートを出力。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.recoverMessage | string | 復旧イベント情報テンプレートを出力。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.noDataTitle | string | 無データイベントタイトルテンプレートを出力。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.noDataMessage | string | 無データイベント情報テンプレートを出力。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.openNotificationMessage | boolean | 有効/無効。イベントの通知内容。デフォルトは無効(イベント内容を通知内容として使用)。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.notificationMessage | string | イベントの通知内容。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.openNoDataNotificationMessage | boolean | 有効/無効。データ欠損イベントの通知内容。デフォルトは無効(データ欠損イベント内容を通知内容として使用)。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.noDataNotificationMessage | string | データ欠損イベントの通知内容。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.noDataRecoverTitle | string | 無データ復旧アップロードイベントタイトルテンプレートを出力。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.noDataRecoverMessage | string | 無データ復旧アップロードイベント情報テンプレートを出力。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.every | string | 検出頻度。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.customCrontab | string | カスタム検出頻度。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.delaySeconds | integer | 通常モニターのデータ待機ウィンドウ(秒)。0 は待機なし。インテリジェントモニタリングはこの設定をサポートしません。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.interval | integer | クエリ区間。1 回のクエリの時間範囲の差。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.range | integer | 高度な検出、変化検出の range パラメータ(単位: 秒)。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.range_2 | integer | 高度な検出、変化検出の range_2 パラメータ(単位: 秒)。特記事項(-1 は前周期比、0 は periodBefore フィールドの使用を表す)。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.periodBefore | integer | 高度な検出、変化検出の(昨日/1 時間前)パラメータ(単位: 秒)。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.recoverNeedPeriodCount | integer | 異常が何チェック周期後に復旧イベントを生成するかを指定します。検出頻度がカスタム customCrontab の場合は時間長(単位: 秒)を表し、それ以外は検出頻度の回数を表します。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.noDataInterval | integer | どのくらいの時間データがない場合に無データイベントを生成するか。noDataEventRepeat の場合は正の整数秒が必須。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.noDataAction | string | 無データ処理操作。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkFuncs | array | 検出関数情報リスト。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.groupBy | array | トリガー次元。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.targets | array | 検出対象。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt | json | 検出条件設定。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.enableStreamingAggregation | boolean または null | モニタリングのストリーミング集約高速化。省略または null はワークスペース設定に従い、true は個別に有効化、false は個別に無効化。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.yamlConfig | string | V2 の完全なソース YAML テキスト。最大 256KiB。JSON オブジェクトではなく、Markdown フェンスも含みません。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.disableLargeScaleEventProtect | boolean | 大規模イベント保護を無効化するか。デフォルト false。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.script | string | プログラマブルモニタリングのスクリプト内容。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.rules | array | トリガー条件リスト。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.openOkConditions | boolean | 段階的復旧を有効化。デフォルトは無効 false。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.openMatchTimes | boolean | 連続トリガー判定を有効化。デフォルトは無効 false。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.infoEvent | boolean | 正常継続時に info イベントを生成するか。デフォルト false。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.infoEventCondition | json | 情報イベントの生成条件。通常ルール検出のしきい値、ログ、アプリケーション/ユーザーアクセスメトリクス、可用性、プロセス、ネットワーク、変化、区間および互換旧タイプをサポートします。外れ値、組み合わせ、生存 V2、変更、プログラマブル、インテリジェントおよび SLO はサポートしません。空のオブジェクトは無条件生成を表します。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.infoEventCondition.alias | string | 判定対象の別名。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.infoEventCondition.operator | string | 判定演算子。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.infoEventCondition.operands | array | 判定オペランドリスト。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.diffMode | string | 高度な検出における変化検出の差分モード。列挙値: value、percent。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.direction | string | 高度な検出における変化検出、区間検出のトリガー条件方向。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.eps | float | 距離パラメータ。値の範囲: 0 ~ 3.0。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.threshold | json | 変化検出のトリガー前提条件設定。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.threshold.status | boolean | 変化検出のトリガー前提条件を有効にするか。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.threshold.operator | string | 変化検出のトリガー前提条件演算子。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.threshold.value | float または null | 変化検出のトリガー前提条件の検出値。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.combineExpr | string | 組み合わせモニタリングの組み合わせ方式。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.ignoreNodata | boolean | 組み合わせモニタリングで無データ結果を無視するか(true は無視が必要)。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.confidenceInterval | integer | 区間検出 V2 の追加パラメータ。信頼区間の範囲は 1-100。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.category | string | AI モニタリングのカテゴリメタデータ。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.userPrompt | string | AI ユーザープロンプト。指定時は空にできず、最大 20000 文字。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.systemPrompt | string | AI システムプロンプト。指定時は空にできず、最大 20000 文字。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.mentions | array | DQL 参照リスト。各項目には type=dql、namespace、datasource が必須で、index は任意です。ログを選択する場合に入力し、シリアライズ後は最大 20000 文字。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.mentions[] | object | 配列内の単一オブジェクト。下位フィールドに従って解釈します。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.mentions[].type | string | データソースタイプ。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.mentions[].namespace | string | DQL 名前空間。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.mentions[].index | string | DQL インデックス。ログを選択する場合に入力。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.mentions[].datasource | string | DQL データソース。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.model | string | 今回の検出で使用するモデル。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.contextWindowLimit | integer | コンテキストウィンドウの Token 制限。0 より大きい必要があります。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.maxChatRounds | integer | 最大対話ラウンド数。1 以上である必要があります。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.maxDQLQueries | integer | 最大 DQL クエリ回数。0 以上である必要があります。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.creditSoftBudget | number | 1 回の検出あたりの Credit ソフトバジェット。0 より大きい必要があります。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.channels | array | チャンネル UUID リスト。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.atAccounts | array | 正常検出時に @ されるアカウント UUID リスト。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.atNoDataAccounts | array | 無データ時に @ されるアカウント UUID リスト。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.subUri | string | OuterEventChecker の Webhook アドレスサフィックス。新規作成時は必須で、一意である必要はありません。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.isChangeEvent | boolean | OuterEventChecker を変更イベントとして処理するか。デフォルト false。既存ルールで欠落している場合は false として扱います。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.disableCheckEndTime | boolean | 終了時間制限を無効化するか。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.eventChartEnable | boolean | イベントグラフを有効にするか。デフォルトは無効(主ストレージエンジン logging が doris の場合にのみ有効)。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.eventCharts | array | イベントグラフリスト。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.eventCharts[] | object | 配列内の単一オブジェクト。下位フィールドに従って解釈します。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.eventCharts[].dql | string | イベントグラフのクエリ文。これは保存済み設定であり、実際に有効かは検出タイプに応じて判断する必要があります。書き込みについてはモニターを作成を参照してください。 |
| content.jsonScript.targets[] | object | 単一の DQL/PromQL クエリ対象、または組み合わせモニタリングメンバー。 |
| content.jsonScript.targets[].dql | string | 実際に実行されるクエリ。qtype が構文を決定します。 |
| content.jsonScript.targets[].qtype | string | 通常は dql/promql。履歴では queryType で表される場合があります。 |
| content.jsonScript.targets[].queryType | string | 履歴クエリ構文のマーカー。 |
| content.jsonScript.targets[].alias | string | 通常の共通プラグインでは通常 Result が必要です。組み合わせモニタリングではメンバー別名に従います。 |
| content.jsonScript.targets[].monitorCheckerId | string | 組み合わせモニタリングの関連メンバー UUID のみ。 |
| content.jsonScript.targets[].groupBy | array<string> |
組み合わせメンバーの追加トリガー次元。 |
| content.jsonScript.targets[].groupBy[] | string | フィールド名。 |
| content.jsonScript.targetWorkspaceUUIDs | array<string> |
履歴/その他の入口で保存される可能性がある対象ワークスペース UUID 集合。公開の追加/変更では宣言されておらず、全体を書き戻しません。 |
| content.jsonScript.targetWorkspaceUUIDs[] | string | 単一の対象ワークスペース UUID。 |
| content.jsonScript.targets[].extraOptions | object | get では保存済み値をエコーします。list のクロスワークスペース認可確認で解析結果がある場合はその場で補完されることがあり、結果がない場合も履歴値を保持することがあります。クライアントが書き込めるリクエストや現在の完全な認可の証明として扱いません。 |
| content.jsonScript.targets[].extraOptions.workspace_uuids | array<string> |
保存済みまたはリストで今回解析された候補実行ワークスペース。履歴値を含む場合があり、現在すべてが認可済みであることを保証しません。 |
| content.jsonScript.targets[].extraOptions.workspace_uuids[] | string | 単一の保存済みまたは候補ワークスペース UUID。現在の認可を確認する必要があります。 |
| content.jsonScript.targets[].extraOptions.index_list | array<object> |
保存済みまたはリストで今回解析されたデータ領域/インデックスの候補範囲。履歴値を含む場合があり、現在の完全な認可の保証にはできません。 |
| content.jsonScript.targets[].extraOptions.index_list[].workspace_uuid | string | ソースワークスペース UUID。 |
| content.jsonScript.targets[].extraOptions.index_list[].namespace | string | クエリ名前空間。 |
| content.jsonScript.targets[].extraOptions.index_list[].index_name | string | 許可されるインデックス名。ログ以外では default の場合があります。 |
| content.jsonScript.targets[].extraOptions.index_list[].expr_name | string | 式サブクエリ名。省略可能。 |
| content.jsonScript.targets[].conditions | object または string | クエリの追加フィルター。保存構造に従って読み取り、統一タイプを仮定しません。 |
| content.jsonScript.groupBy[] | string | トリガー次元フィールド。 |
| content.jsonScript.checkFuncs[] | object | 互換検出関数の資料。 |
| content.jsonScript.checkFuncs[].funcId | string | 関数 ID。 |
| content.jsonScript.checkFuncs[].kwargs | object | 関数固有のパラメータ。すべてのアルゴリズムの共通入力ではありません。 |
| content.jsonScript.checkFuncs[].kwargs.パラメータ名 | JSON | 対応する関数ドキュメントに従って解釈します。 |
| content.jsonScript.channels[] | string | インシデントチャンネル UUID。 |
| content.jsonScript.atAccounts[] | string | 通知で @ される ID 識別子。履歴ではメールアドレスの場合があります。 |
| content.jsonScript.atNoDataAccounts[] | string | 無データ通知の @ 対象。 |
| content.jsonScript.checkerOpt.rules[] | object | レベルごとにトリガーと復旧条件を設定します。 |
| content.jsonScript.checkerOpt.rules[].status | string | fatal/critical/error/warning/info/ok/ALL などは検出タイプに応じて解釈されます。 |
| content.jsonScript.checkerOpt.rules[].conditionLogic | string | and/or。複数条件の組み合わせ。 |
| content.jsonScript.checkerOpt.rules[].matchTimes | integer | 連続一致回数。openMatchTimes と組み合わせる必要があります。 |
| content.jsonScript.checkerOpt.rules[].conditions | array<object> |
トリガー条件。 |
| content.jsonScript.checkerOpt.rules[].okConditions | array<object> |
段階的復旧条件。省略可能。 |
| content.jsonScript.checkerOpt.rules[].conditions[].alias | string | 対応するクエリ対象の別名。 |
| content.jsonScript.checkerOpt.rules[].conditions[].operator | string | 条件演算子。検出タイプごとのサポート集合に従います。 |
| content.jsonScript.checkerOpt.rules[].conditions[].operands | array | 比較値の配列。数値/文字列タイプを保持します。 |
| content.jsonScript.checkerOpt.rules[].conditions[].operands[] | string / number | 単一の比較値。 |
| content.jsonScript.checkerOpt.rules[].okConditions[].alias | string | 対応するクエリ対象の別名。 |
| content.jsonScript.checkerOpt.rules[].okConditions[].operator | string | 条件演算子。検出タイプごとのサポート集合に従います。 |
| content.jsonScript.checkerOpt.rules[].okConditions[].operands | array | 比較値の配列。数値/文字列タイプを保持します。 |
| content.jsonScript.checkerOpt.rules[].okConditions[].operands[] | string / number | 単一の比較値。 |
| content.extend.isNeedCreateIssue | boolean | 異常に基づいて Issue を作成するか。 |
| content.extend.issueLevelUUID | string | 履歴 Issue レベルの識別子。無効になっている場合があります。 |
| content.extend.issueDfStatus | array<string> |
Issue をトリガーする異常ステータス。 |
| content.extend.issueDfStatus[] | string | fatal/critical/error/warning/nodata。 |
| content.extend.manager | array<string> |
解決済みの担当者ターゲット。 |
| content.extend.manager[] | string | メンバー/チームなどのターゲット識別子。 |
| content.extend.incidentsTags | array<string> |
インシデント関連タグ名。 |
| content.extend.incidentsTags[] | string | 単一のタグ名。 |
| content.extend.faultMappingMode | string | custom/existing。現在のインシデントレベルマッピング方式。 |
| content.extend.levelMappingUUID | string | existing 時のレベルマッピング UUID。 |
| content.extend.bindIncidentsInfo | array<object> |
カスタムレベルマッピング行。 |
| content.extend.bindIncidentsInfo[].incidentsLevelUUID | string | マッピングされた Issue レベル UUID。 |
| content.extend.bindIncidentsInfo[].incidentsDfStatus | array<string> |
マッピングされた異常ステータス配列。 |
| content.extend.bindIncidentsInfo[].incidentsDfStatus[] | string | 単一の異常ステータス。 |
| content.extend.smartMonitor | object | V2 のソースと現在のバージョンメタ情報。 |
| content.extend.smartMonitor.source | string | ai/builtin ソース。 |
| content.extend.smartMonitor.engineVersion | integer | V2 では通常 2。 |
| content.extend.smartMonitor.configVersion | integer | V2 設定バージョン。 |
| content.extend.smartMonitor.category | string | インテリジェントモニタリング分類。 |
| content.extend.smartMonitor.prompt | string | AI 生成プロンプト。 |
| content.extend.smartMonitor.templateId | string | 組み込みテンプレート識別子。 |
| content.extend.smartMonitor.templateVersion | string | 組み込みテンプレートバージョン。 |
| content.extend.smartMonitor.generationRunId | string | 生成プロセスの追跡識別子。省略可能。 |
| content.tagInfo | array<object> |
書き込み後のタグ関連サマリー。タグなしは []。 |
| content.tagInfo[].id | string | タグ UUID。uuid と同じで、データベースの数値 id ではありません。 |
| content.tagInfo[].uuid | string | タグ UUID。 |
| content.tagInfo[].name | string | タグ名。 |
| content.tagInfo[].scope | array<string> |
正規化後のタグスコープ。 |
| content.tagInfo[].scope[] | string | 単一のスコープ。 |
| content.monitorName | string | 現在のグループ表示名。条件付きで返されます。 |
| content.dashboardUUID | string | 新規/変更で明示的に有効な関連がある場合に返され、省略される場合があります。 |
| content.alertPolicyUUIDs | array<string> |
作成時に非空の関連がある場合にのみ返されるポリシー UUID。変更レスポンスでは自動的に展開されません。 |
| content.alertPolicyUUIDs[] | string | ポリシー UUID。 |
| content.__operation_info | object | 正常な新規追加の追加操作サマリー。 |
| content.__operation_info.uuid | string | 今回のルール UUID。 |
| content.declaration | object | 共通宣言。 |
{
"code": 200,
"content": {
"id": null,
"uuid": "rul_checker_example",
"workspaceUUID": "wksp_example",
"monitorUUID": "monitor_example",
"type": "trigger",
"refKey": "",
"secret": "",
"jsonScript": {
"type": "simpleCheck",
"title": "生产CPU阈值",
"name": "生产CPU阈值",
"every": "1m",
"interval": 300,
"groupBy": [
"host"
],
"targets": [
{
"dql": "M::cpu:(avg(usage_idle)) BY host",
"alias": "Result",
"qtype": "dql"
}
],
"checkerOpt": {
"rules": [
{
"status": "warning",
"conditionLogic": "and",
"conditions": [
{
"alias": "Result",
"operator": "<",
"operands": [
10
]
}
]
}
]
}
},
"extend": {},
"crontabInfo": {
"id": "cron_example",
"crontab": "0 * * * * *"
},
"createdWay": "manual",
"isLocked": 0,
"openPermissionSet": false,
"permissionSet": [],
"status": 0,
"creator": "wsak_example",
"updator": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"monitorName": null,
"tagInfo": [],
"__operation_info": {
"uuid": "rul_checker_example"
},
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラー応答¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | トリガー条件 | メッセージまたはレスポンス説明 | 処理方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 | パラメータ解析失敗 | パラメータの位置、フィールド名、型、値を確認します。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正します。 |
| 406 | ft.InvalidParameterValidation | noDataAction=noDataEventRepeat だが noDataInterval が欠落/正の整数でない | {} の値が無効です。現在の値: {} |
サポートされる検出タイプに対して正の整数秒の継続ウィンドウを明示的に指定します。 |
| 400 | ft.ErrorContinuousTriggerCfgCount | openMatchTimes=true で、いずれかの matchTimes が 1..100 にない | 連続トリガー設定の回数は {} である必要があります | 連続回数を 1..100 に調整し、無効時はこのフィールドを使用しません。 |
| 406 | ft.IllegalMutationParameters | 高度な変化検出の前提で threshold.status=true だが value が数値でない(null を含む) | トリガー条件の検出値検証に失敗 | 結果の単位と一致する数値を指定するか、前提条件を無効化します。 |
| 403 | ft.ForbiddenQuery | 検出 DQL の解析時に呼び出し ID に対応する名前空間のクエリ権限がない | あなたには {} 権限がありません | 現在の API Key/ID に必要なデータ領域のクエリ権限を設定します。モニター設定権限だけでは足りません。 |
| 406 | ft.DqlParseError | 対象クエリ、eval サブ式、または V2 YAML 内の DQL が権限/インデックス解析時に失敗 | dql parser 解析失敗: {} | 実際のクエリ構文と名前空間を修正して再試行します。これはクエリが実行済みであることを意味しません。 |