置換インポート¶
POST /api/v1/checker/{rule_uuid}/replace
概要¶
単一の移行テンプレートを使用して指定したモニターを全体置換し、UUID を保持します。
呼び出し前の確認と使用手順¶
まず対象を get し、バックアップし、テンプレートの type と対象エンティティタイプが一致することを確認します。V2 では checker に現在の configVersion を追加する必要があり、旧エクスポートがトップレベルバージョンを含むことは保証されません。実行バージョンを変更できません。この入口は UUID を保持しますが、ルールを全体置換します: monitorName は省略時 default、tags は tagInfo を取り省略時 []、alertPolicyNames は省略時クリア、dashboardName は省略/不一致時に参照を削除、extend は省略時 {}、権限は省略時 false/[]、is_disable は省略時に有効へ戻します。これを部分パッチとして扱わないでください。
グループ名が存在しない場合は新しいグループを作成できます。ポリシー名が存在しない場合は新しいポリシー定義を作成できますが、対象ダッシュボードは既に存在している必要があります。外部イベントの secret は省略/空文字列の場合に旧値を保持し、空でない場合のみ置換して一意性を検証します。エクスポートで secret が削除されていても、置換によって新しい Webhook が生成されるわけではありません。テンプレートの generationId は最終的な rule_modify に引き継がれません。本 API で AI prompt の再生成フローを完了せず、prompt を変更する場合は専用の生成 + modify を使用してください。
事前のタイプ/YAML/バージョンチェックは関連リソース作成より先に行われます。その後は rule_modify のスケジューリング/データベース/タグ/キャッシュ/参照の副作用を踏襲し、公開 modify ルートの高コストなチェックと extend_format 注入は経由しません。テンプレートの複数ソース targetWorkspaceUUIDs は通常の公開 modify のネスト許可リスト制限を受けません。空でない配列は単数より優先され、一部ソースの認可失敗でも元の入力配列を保存し、有効なソースのみにスケジュールを作成できます。すべて失敗した場合は CheckerAuthorizationVerificationFailed を返します。送信後は crontabInfo.multiWsCrontabInfo に従って実際の範囲を項目ごとに検証し、保存された配列を実行成功リストとして扱わないでください。この入口もリソースタグインポートのコンテキストにあり、スコープ競合はスキップされ skippedTags で報告される場合があります。成功はすべてのタグがバインドされたことを保証しません。送信後に参照同期タスクを投入します。現在の update タスクはこれに基づいて SLO を再計算しません。タイムアウト/エラーの場合はまず対象と関連を読み戻してください。すべての下流同期が完了することを保証しません。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| rule_uuid | string | Y | 保持する現在の UUID。エクスポート signId や履歴 UUID ではない。 例: rul_checker_example取得または入力方法: モニター一覧および get で現在の対象を確認します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、当該操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| checker.type | string | trigger/smartMonitor/aiMonitor。今回の import トップレベル type と一致する場合のみ実際にインポートされ、replace では旧オブジェクトの正規化カテゴリと一致する必要がある。 例: trigger取得または入力方法: エクスポートテンプレートのエンティティカテゴリを踏襲します。 |
|
| checker.signId | string | エクスポートでは元 UUID のダイジェストであり、認証情報ではない。インポートでは UUID の事前割り当ておよび複合メンバー参照の書き換えに使用し、同一バッチ内で一意である必要があり、ファイル間で独自に再利用しない。replace ではこれによって対象 UUID を変更しない。 例: sign_example取得または入力方法: 同じエクスポート内の透過署名をそのまま保持します。 |
|
| checker.jsonScript | json | 完全な定義。セマンティクスと任意フィールドは本ページの展開と同じ。インポートは通常の add Body ではなく、その完全なネスト宣言チェックを経由せず、不正な形状は 500 になり得る。V2 の完全な yamlConfig は有効である必要があり、インポート前にすべての候補を同期的に検証する場合がある。 例: {"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]}]}]}}取得または入力方法: export が返す単一テンプレートの jsonScript から取得し、対応する検出タイプに応じて対象データソースを確認します。 |
|
| checker.extend | json | 省略時/旧テンプレートでは {} を推奨し、null は提供しない。インポートは完全な定義で保存し、replace で省略して {} にすると旧拡張を上書きし、保持ではない。各ネストの意味は下表を参照。 例: {}取得または入力方法: 同じエクスポートテンプレートから完全なエコーバック/インシデント関連オブジェクトを取得し、対象ワークスペースの実際のリソース識別子に置き換えます。 |
|
| checker.is_disable | boolean | 任意、デフォルト有効。テンプレートプロトコルのアンダースコア付き is_disable を保持し、isDisable ではない。replace で省略すると旧無効ルールが有効になる。 例: false取得または入力方法: インポート後に無効化する場合は true、通常有効の場合は false。 |
|
| checker.tagInfo | array | 任意、デフォルト []。name に従ってタグを作成または再利用し、トップレベルの tags はテンプレートインポートでは同等の役割を果たさない。replace で省略すると旧タグ関連付けがクリアされる。 例: [{"name": "production"}]取得または入力方法: エクスポートテンプレートからタグ名を取得し、対象ワークスペースで monitor/all スコープが適用されることを確認します。 |
|
| checker.tagInfo[*] | json | name のみ必要。ソースタグ UUID を対象ワークスペースの識別子として使用しない。 例: {"name": "production"}取得または入力方法: 各項目に 1 つの業務タグ名を指定します。 |
|
| checker.tagInfo[*].name | string | 空でないことを推奨。monitor スコープで検証し、競合時は skippedTags で報告される場合がある。スキップをタグバインド成功とみなさない。 例: production取得または入力方法: 対象ワークスペースで適用可能な業務タグ名。 |
|
| checker.secret | string | インポートはソース secret を継承しない。OuterEventChecker のエクスポートではこのフィールドが削除され、インポートすると新しい secret が生成されるため、移行後は Webhook を再取得する必要がある。replace で省略/空文字列の場合は元の secret を保持し、空でない値に置き換える場合はグローバルに一意である必要がある。 例: `` 取得または入力方法: replace で外部イベントアドレスを変更する必要がある場合のみ、信頼できる元の詳細または新しいランダム secret から取得します。 |
|
| checker.monitorName | string | 任意、デフォルトは default、空でも default として扱う。存在しない場合は新しいグループを作成する場合がある。monitorUUID ではない。replace で省略すると default に切り替わり、旧グループを保持しない。 例: default取得または入力方法: 対象のモニターグループ名またはエクスポートテンプレートから取得します。 |
|
| checker.alertPolicyNames | array | 任意、デフォルト []。存在しない名前はポリシー定義を作成し、通知先/ルールがソースポリシーと一緒に移行されるとは想定できない。replace で省略すると旧ポリシー参照がクリアされる。 例: ["生产告警"]取得または入力方法: 対象ワークスペースの既存アラートポリシー名から取得するか、エクスポートされた同名ポリシーを使用します。 |
|
| checker.alertPolicyNames[*] | string | UUID ではない。インポート後に実際のアラート対象設定を確認する。 例: 生产告警取得または入力方法: 単一の業務ポリシー名。 |
|
| checker.dashboardName | string | 任意。name のみで既存の node ダッシュボードを解決し、ダッシュボードを自動インポートしない。一致しない場合は関連付けを作成しない。replace で省略/不一致の場合は旧ダッシュボード参照を削除する。 例: 生产总览取得または入力方法: 対象ワークスペースの既存ダッシュボード名から取得します。 |
|
| checker.openPermissionSet | boolean | export に含まれず、通常の import はこれら 2 つの権限設定を継承しない。replace のデフォルトは false で、必要な権限を明示的に完全復元する必要がある。 例: false取得または入力方法: replace でカスタム操作権限を保持する場合のみ旧詳細から取得します。 |
|
| checker.permissionSet | array | export に含まれず、import 共有の新規追加はデフォルト []。replace で省略して [] にすると旧主体がクリアされる。 例: ["wsAdmin"]取得または入力方法: replace のみ対象ワークスペースのロール/メンバー/チームから選択します。 |
|
| checker.permissionSet[*] | string | ソースワークスペースではない無効な主体。 例: wsAdmin取得または入力方法: 対象ワークスペースの有効な操作主体。 |
|
| checker.configVersion | integer | 既存 V2 の置換時のみ必須の現在バージョン。エクスポートされた履歴バージョンではない。export テンプレート自体がこのトップレベルフィールドを含むことは保証されないため、呼び出し前に追加する必要がある。通常の import は新バージョンを作成し、元のバージョン番号を保持しない。 例: 1取得または入力方法: V2 replace では呼び出し前の現在のオブジェクト get から configVersion を読み取ります。 |
|
| checker.jsonScript.atAccounts | array | 任意の配列、デフォルト []。channels はインシデント連携に使用され、直接の通知先ではない。サーバー側でデフォルトチャンネルを補完/無効チャンネルを除外する場合がある。@外部メールアドレスは無料/体験版で制限される。保存は通知送信済みを意味しない。 例: ["acnt_example"]取得または入力方法: チャンネルはチャンネル一覧から uuid を取得し、@対象はメンバー一覧からアカウント uuid またはサポートされるメールアドレスを取得します。 |
|
| checker.jsonScript.atNoDataAccounts | array | 任意の配列、デフォルト []。channels はインシデント連携に使用され、直接の通知先ではない。サーバー側でデフォルトチャンネルを補完/無効チャンネルを除外する場合がある。@外部メールアドレスは無料/体験版で制限される。保存は通知送信済みを意味しない。 例: ["acnt_example"]取得または入力方法: チャンネルはチャンネル一覧から uuid を取得し、@対象はメンバー一覧からアカウント uuid またはサポートされるメールアドレスを取得します。 |
|
| checker.jsonScript.channels | array | 任意の配列、デフォルト []。channels はインシデント連携に使用され、直接の通知先ではない。サーバー側でデフォルトチャンネルを補完/無効チャンネルを除外する場合がある。@外部メールアドレスは無料/体験版で制限される。保存は通知送信済みを意味しない。 例: ["chan_example"]取得または入力方法: チャンネルはチャンネル一覧から uuid を取得し、@対象はメンバー一覧からアカウント uuid またはサポートされるメールアドレスを取得します。 |
|
| checker.jsonScript.checkFuncs | array | 任意。通常のしきい値では提供不要。seniorCheck は先頭項目の funcId/kwargs を使用し、すべての関数を汎用パラメータとして扱わない。 例: []取得または入力方法: この互換カスタム関数構造を使用する履歴チェックタイプのみを維持し、元の詳細/関数定義から取得します。 |
|
| checker.jsonScript.checkerOpt | json | 通常のルールでは rules をよく使用し、高度なタイプは対応するアルゴリズムに従って入力し、V2 は yamlConfig、AI セマンティクスは userPrompt などを使用する。宣言されていない子フィールドは公開検証で拒否され、内部 SDK のパラメータ全体をそのまま流用できない。 例: {"rules": [{"status": "warning", "conditionLogic": "and", "conditions": [{"alias": "Result", "operator": "<", "operands": [10]}]}]}取得または入力方法: jsonScript.type に応じて以下のトリガー/アルゴリズム/AI 設定を選択します。 |
|
| checker.jsonScript.checkerOpt.category | string | AI セマンティクス専用。AI セマンティクス分類のメタ情報、任意の文字列。 例: custom取得または入力方法: 本ワークスペースの AI セマンティクスモニタリング能力と業務予算に応じて設定し、任意項目を省略した場合は AI サービスのデフォルトポリシーに任せます。 |
|
| checker.jsonScript.checkerOpt.combineExpr | string | タイプ専用パラメータ。複合メンバーの alias 式。複合タイプでは空でないことが必須で、Result をメンバー別名の代わりにしない。 例: A && B取得または入力方法: 現在の検出タイプに応じてエディター/元の詳細で具体的なアルゴリズムの意味を確認します。 |
|
| checker.jsonScript.checkerOpt.confidenceInterval | integer | タイプ専用パラメータ。範囲 V2 の信頼区間 1..100。実際のアルゴリズムに従って設定。 例: 90取得または入力方法: 現在の検出タイプに応じてエディター/元の詳細で具体的なアルゴリズムの意味を確認します。 |
|
| checker.jsonScript.checkerOpt.contextWindowLimit | integer | AI セマンティクス専用。正の整数の Token コンテキスト制限、1 以上。 例: 8192取得または入力方法: 本ワークスペースの AI セマンティクスモニタリング能力と業務予算に応じて設定し、任意項目を省略した場合は AI サービスのデフォルトポリシーに任せます。 |
|
| checker.jsonScript.checkerOpt.creditSoftBudget | number | AI セマンティクス専用。1 回あたりの Credit ソフトバジェット、有限数 >0。API 実行タイムアウトではない。 例: 10取得または入力方法: 本ワークスペースの AI セマンティクスモニタリング能力と業務予算に応じて設定し、任意項目を省略した場合は AI サービスのデフォルトポリシーに任せます。 |
|
| checker.jsonScript.checkerOpt.diffMode | string | タイプ専用パラメータ。高度な変化の value 差分/percent パーセント。明示的に指定が必要。 例: percent取得または入力方法: 現在の検出タイプに応じてエディター/元の詳細で具体的なアルゴリズムの意味を確認します。 |
|
| checker.jsonScript.checkerOpt.direction | string | タイプ専用パラメータ。高度な変化/範囲の up/down/both。明示的に指定が必要。 例: both取得または入力方法: 現在の検出タイプに応じてエディター/元の詳細で具体的なアルゴリズムの意味を確認します。 |
|
| checker.jsonScript.checkerOpt.disableLargeScaleEventProtect | boolean | 任意のブール値。true で大規模イベント保護を無効化、デフォルト false で保護を維持。 例: false取得または入力方法: 業務要件に応じて当該アラート/イベント処理動作を確認します。 |
|
| checker.jsonScript.checkerOpt.enableStreamingAggregation | boolean | 任意の三状態。サポートされるタイプのストリーミング集約高速化のみを制御し、モニターの有効/無効や DQL の意味変更ではない。 例: true取得または入力方法: 独立したスイッチが必要な場合は true/false、ワークスペース設定に従う場合は省略または null。 |
|
| checker.jsonScript.checkerOpt.eps | float | タイプ専用パラメータ。外れ値では必須、数値 0..3.0。このアルゴリズムでは通常の rules 条件検証を使用しない。 例: 0.5取得または入力方法: 現在の検出タイプに応じてエディター/元の詳細で具体的なアルゴリズムの意味を確認します。 |
|
| checker.jsonScript.checkerOpt.ignoreNodata | boolean | 任意のブール値。複合モニタリングのみ true でデータなしを無視、デフォルト false。 例: false取得または入力方法: 業務要件に応じて当該アラート/イベント処理動作を確認します。 |
|
| checker.jsonScript.checkerOpt.infoEvent | boolean | 任意のブール値。true で正常継続時に info を生成、デフォルト false。infoEventCondition はタイプに応じて条件を制御。 例: false取得または入力方法: 業務要件に応じて当該アラート/イベント処理動作を確認します。 |
|
| checker.jsonScript.checkerOpt.infoEventCondition | json | 任意、{} は無条件 Info を表す。通常のしきい値/ログ/アプリケーションとアクセス指標/可用性/プロセス/ネットワーク/変化/範囲などサポートされるタイプのみ適用。外れ値/複合/生存V2/変更/プログラマブル/インテリジェント/SLO は非対応で、指定すると UnsupportTriggerFields を返す。空でない場合は alias/operator/operands が完全かつ有効である必要がある。 例: {"alias": "Result", "operator": ">=", "operands": [60]}取得または入力方法: 実際のクエリ結果と正常な業務しきい値から構築します。 |
|
| checker.jsonScript.checkerOpt.infoEventCondition.alias | string | 空でない Info 条件内で構造に従って入力。targets の別名に対応。 例: Result取得または入力方法: 実際のクエリ対象およびしきい値と一致させます。 |
|
| checker.jsonScript.checkerOpt.infoEventCondition.operands | array | 空でない Info 条件内で構造に従って入力。比較値の配列、要素は文字列/数値、オブジェクトは指定しない。 例: [60]取得または入力方法: 実際のクエリ対象およびしきい値と一致させます。 |
|
| checker.jsonScript.checkerOpt.infoEventCondition.operator | string | 空でない Info 条件内で構造に従って入力。本ページの通常条件演算子から選択。 例: >=取得または入力方法: 実際のクエリ対象およびしきい値と一致させます。 |
|
| checker.jsonScript.checkerOpt.maxChatRounds | integer | AI セマンティクス専用。最大会話ラウンド数、整数 1 以上。 例: 3取得または入力方法: 本ワークスペースの AI セマンティクスモニタリング能力と業務予算に応じて設定し、任意項目を省略した場合は AI サービスのデフォルトポリシーに任せます。 |
|
| checker.jsonScript.checkerOpt.maxDQLQueries | integer | AI セマンティクス専用。最大 DQL 呼び出し回数、整数 0 以上。 例: 3取得または入力方法: 本ワークスペースの AI セマンティクスモニタリング能力と業務予算に応じて設定し、任意項目を省略した場合は AI サービスのデフォルトポリシーに任せます。 |
|
| checker.jsonScript.checkerOpt.mentions | array | AI セマンティクスでは任意、デフォルト []。各項目は type=dql、namespace/datasource は空でないこと、index は任意で指定する場合は空でないこと。正規化 JSON シリアライズの総長 ≤20000 文字。データクエリ認可の代わりにはならない。 例: [{"type": "dql", "namespace": "logging", "index": "default", "datasource": "nginx"}]取得または入力方法: 実際の DQL 名前空間、ログインデックス、ソースから参照メタ情報を取得します。 |
|
| checker.jsonScript.checkerOpt.mentions[*] | json | type/namespace/datasource は必須、index は任意。4 フィールドのみ宣言。 例: {"type": "dql", "namespace": "logging", "index": "default", "datasource": "nginx"}取得または入力方法: 各項目に 1 つの DQL 参照を指定します。 |
|
| checker.jsonScript.checkerOpt.mentions[*].datasource | string | 参照項目内の実際のデータソース名(例: ログ source/メジャーメント)。名前空間に応じて解釈。 例: nginx取得または入力方法: 同じ対象ワークスペースの実際のデータから選択します。 |
|
| checker.jsonScript.checkerOpt.mentions[*].index | string | 参照項目内のログ参照には実際のインデックス名/識別子を入力。他のタイプでは省略可能。 例: default取得または入力方法: 同じ対象ワークスペースの実際のデータから選択します。 |
|
| checker.jsonScript.checkerOpt.mentions[*].namespace | string | 参照項目内の実際の DQL 名前空間。エンティティ type ではない。 例: logging取得または入力方法: 同じ対象ワークスペースの実際のデータから選択します。 |
|
| checker.jsonScript.checkerOpt.mentions[*].type | string | 参照項目内で固定の dql。 例: dql取得または入力方法: 同じ対象ワークスペースの実際のデータから選択します。 |
|
| checker.jsonScript.checkerOpt.model | string | AI セマンティクス専用。AI セマンティクスの任意モデル名。サイトがサポートするモデル設定から取得し、ドキュメント例のリテラル値を使用してはならない。 例: example-model取得または入力方法: 本ワークスペースの AI セマンティクスモニタリング能力と業務予算に応じて設定し、任意項目を省略した場合は AI サービスのデフォルトポリシーに任せます。 |
|
| checker.jsonScript.checkerOpt.openMatchTimes | boolean | 任意のブール値。true で連続トリガー一致を有効化、デフォルト false。rules[].matchTimes と組み合わせる。 例: false取得または入力方法: 業務要件に応じて当該アラート/イベント処理動作を確認します。 |
|
| checker.jsonScript.checkerOpt.openOkConditions | boolean | 任意のブール値。true で段階的復旧を有効化、デフォルト false。okConditions はトリガーと復旧の境界を満たす必要がある。 例: false取得または入力方法: 業務要件に応じて当該アラート/イベント処理動作を確認します。 |
|
| checker.jsonScript.checkerOpt.rules | array | 通常ルールの条件配列。各項目は status/conditionLogic/conditions を持ち、復旧には okConditions を使用。誤ったメンバー/演算形状は通常例外を送出して最終的に 500 になる場合があり、一概に 406 ではない。operands が空の条件はスケジュール構築前にフィルタされるため、「すべて」を表現するために使用しない。 例: [{"status": "warning", "conditionLogic": "and", "conditions": [{"alias": "Result", "operator": "<", "operands": [10]}]}]取得または入力方法: トリガーを許可するイベントレベルと対象 Result に従って構築します。 |
|
| checker.jsonScript.checkerOpt.script | string | タイプ専用パラメータ。プログラマブル検出スクリプトのテキスト。このタイプがサポートする構文を使用し、本 API はスクリプトテストを 1 回実行しない。 例: return {}取得または入力方法: 現在の検出タイプに応じてエディター/元の詳細で具体的なアルゴリズムの意味を確認します。 |
|
| checker.jsonScript.checkerOpt.systemPrompt | string | AI セマンティクス専用。AI セマンティクスでは任意、指定時は空でないこと、Python 文字数 ≤20000。 例: 结合实际查询结果判断,不臆测缺失数据。取得または入力方法: 本ワークスペースの AI セマンティクスモニタリング能力と業務予算に応じて設定し、任意項目を省略した場合は AI サービスのデフォルトポリシーに任せます。 |
|
| checker.jsonScript.checkerOpt.threshold | json | 任意のオブジェクト。指定時は status/operator/value がすべて必須として宣言される。status=false で前提判定を無効化、value は null を許可するがアルゴリズムの実際の意味に従って入力する。 例: {"status": false, "operator": ">", "value": 90}取得または入力方法: 高度な変化のトリガー前提を、実際の業務しきい値で決定します。 |
|
| checker.jsonScript.checkerOpt.threshold.operator | string | 親オブジェクトが存在する場合に必須。前提比較演算子(例: >)。実際の高度な検出の互換集合に従う。 例: >取得または入力方法: 高度な変化の前提条件定義に従って入力します。 |
|
| checker.jsonScript.checkerOpt.threshold.status | boolean | 親オブジェクトが存在する場合に必須。前提条件を有効にするか。 例: false取得または入力方法: 高度な変化の前提条件定義に従って入力します。 |
|
| checker.jsonScript.checkerOpt.threshold.value | float | 親オブジェクトが存在する場合に必須。前提数値。status=false では null を許可、status=true では数値が必須、そうでなければ IllegalMutationParameters。単位はクエリ結果と一致。 例: 90取得または入力方法: 高度な変化の前提条件定義に従って入力します。 |
|
| checker.jsonScript.checkerOpt.userPrompt | string | AI セマンティクス専用。AI セマンティクスの条件では必須で空でないこと、Python 文字数 ≤20000。空文字列を宣言できるが、業務上空白は受け付けない。 例: 分析最近5分钟生产服务错误率是否异常。取得または入力方法: 本ワークスペースの AI セマンティクスモニタリング能力と業務予算に応じて設定し、任意項目を省略した場合は AI サービスのデフォルトポリシーに任せます。 |
|
| checker.jsonScript.checkerOpt.yamlConfig | string | V2 のみ必須。空でない UTF-8 YAML テキスト ≤256KiB で、JSON オブジェクトや Markdown フェンスではない。構造は本ページの YAML 表を参照。アンカー/別名/明示的タグ/重複キーは禁止。変更は既存の 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 を取得し、許可された範囲で編集します。 |
|
| checker.jsonScript.customCrontab | string | 任意。空でない場合は every より優先。5 フィールドまたは秒付き 6 フィールドをサポートし、秒ステップ形式は 20 未満にできない。複合モニタリングおよび複合対象メンバーにはカスタム頻度の競合制限がある。V2 では禁止。検出タイムゾーンは現在のワークスペース/サービス設定に依存し、文字列内のタイムゾーン名でフィールドを代替しない。 例: 0 */5 * * * *取得または入力方法: カスタム頻度の場合は Cron エディターに従って完全な式を入力します。 |
|
| checker.jsonScript.delaySeconds | integer | 任意の通常モニタリングのデータ待機ウィンドウ、単位は秒、0 は待機なし、省略時 0。ブール値は整数として扱わない。インテリジェント/AI は通常の待機設定を使用せず、これでインテリジェント実行遅延を調整できない。 例: 60取得または入力方法: データ到着遅延に応じて 0/60/120/180/300/600/900/1800 を選択します。 |
|
| checker.jsonScript.disableCheckEndTime | boolean | 任意の互換ブール値、デフォルト false、実際のサポートは検出タイプに依存。 例: false取得または入力方法: チェック終了時間制限を解除する場合に true。 |
|
| checker.jsonScript.eventChartEnable | boolean | 任意、デフォルト false。サポートされる Doris ログ主ストレージ処理のみ。保存成功はグラフ生成済みを証明しない。 例: false取得または入力方法: イベントグラフをサポートするデータストレージ能力の下で選択します。 |
|
| checker.jsonScript.eventCharts | array | 任意のグラフ設定配列。イベントグラフを有効にする場合に併せて指定し、具体的な結果はイベント処理チェーンで生成され、書き込みレスポンスでは返されない。 例: [{"dql": "M::cpu:(avg(usage_idle)) BY host"}]取得または入力方法: 実際のデータでイベント表示用クエリを検証します。 |
|
| checker.jsonScript.eventCharts[*] | json | dql サブフィールドのみを宣言。 例: {"dql": "M::cpu:(avg(usage_idle)) BY host"}取得または入力方法: 検証済みの単一グラフクエリ。 |
|
| checker.jsonScript.eventCharts[*].dql | string | 任意のクエリテキスト。グラフ UUID ではなく、保存時にグラフクエリを実行しない。 例: M::cpu:(avg(usage_idle)) BY host取得または入力方法: サポートされるデータソースから実際のメトリクス/フィールドに従って DQL を作成します。 |
|
| checker.jsonScript.every | string | 通常のテンプレートは every または customCrontab を使用し、互換 fixedCrontab が空でない場合は共通の every 事前チェックをスキップできる。every を一律にテンプレート必須とは言えず、実際の Cron 生成およびアルゴリズムには引き続きタイプ制約がある。通常は正の整数 + s/m/h かつ ≤24h を推奨、V2 は固定 10m。 例: 1m取得または入力方法: 業務の検出頻度に応じて正の整数 + s/m/h を選択します(例: 1m、5m、1h)。 |
|
| checker.jsonScript.groupBy | array | 任意のディメンション名配列。通常 [] は追加ディメンションでグループ化しないことを表し、タグ値ではない。複合モニタリングメンバーのディメンションは互換である必要がある。 例: ["host"]取得または入力方法: 実際の DQL が返すグループ化フィールドから選択し、BY ディメンションと一致させます。 |
|
| checker.jsonScript.interval | integer | 通常 targets がある場合は 1..2592000 秒(30 日)が必要。every の検出頻度とは異なる。複合モニタリングはこの共通チェックをスキップし、V2 は YAML query.interval/lookback を使用。 例: 300取得または入力方法: 検出に必要な時間範囲に応じて正の整数秒を選択し、実際のデータ粒度と調整します。 |
|
| checker.jsonScript.isChangeEvent | boolean | OuterEventChecker では任意、デフォルト false。他のタイプでは使用しない。 例: false取得または入力方法: 外部イベントが変更イベントの場合に true。 |
|
| checker.jsonScript.message | string | event 内容。対応するチェックタイプに応じて任意入力。変更時に省略を保持とみなすことはできず、設定全体を復元する必要がある。任意で、省略時は独立したテキストを提供しない。現在の共通構築では title/message とデータなしテキストが主なソースであり、旧 recover 専用フィールドがあらゆる検出を個別にカバーすることを保証しない。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されない。 例: 主机 {{host}} 检测结果 {{Result}}取得または入力方法: 実際の検出ディメンションと結果変数に従ってイベント/通知テンプレートを作成し、同タイプの検証済みイベントから再利用できます。 |
|
| checker.jsonScript.noDataAction | string | 任意。none/checkAs0/noDataEvent/noDataEventRepeat/fatalEvent/criticalEvent/errorEvent/warningEvent/okEvent/noData/recover。noDataEventRepeat は適用可能なタイプのみサポートし、正の整数の noDataInterval が必要。省略/空の互換値と正の継続時間には専用の履歴処理があり、デフォルト実装に依存して繰り返しアラートを実現しない。 例: noDataEvent取得または入力方法: データなしの業務上の意味に応じて本パラメータの列挙から選択します。 |
|
| checker.jsonScript.noDataInterval | integer | タイプに応じて任意入力。データなし継続時間(秒)。通常頻度では検出周期全体に切り上げて換算され、カスタム頻度では直接秒。repeat のデータなしは正の整数が必須。変更時は適用設定を完全に保持し、単位を混在させない。 例: 600取得または入力方法: 業務要件でウィンドウ/オフセット/継続時間を決定し、まず対応するタイプの詳細と実際のイベントで確認します。 |
|
| checker.jsonScript.noDataMessage | string | データなしイベント情報テンプレートを出力。対応するチェックタイプに応じて任意入力。変更時に省略を保持とみなすことはできず、設定全体を復元する必要がある。任意で、省略時は独立したテキストを提供しない。現在の共通構築では title/message とデータなしテキストが主なソースであり、旧 recover 専用フィールドがあらゆる検出を個別にカバーすることを保証しない。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されない。 例: 主机 {{host}} 检测结果 {{Result}}取得または入力方法: 実際の検出ディメンションと結果変数に従ってイベント/通知テンプレートを作成し、同タイプの検証済みイベントから再利用できます。 |
|
| checker.jsonScript.noDataNotificationMessage | string | データ欠損イベントの通知内容。対応するチェックタイプに応じて任意入力。変更時に省略を保持とみなすことはできず、設定全体を復元する必要がある。任意で、省略時は独立したテキストを提供しない。現在の共通構築では title/message とデータなしテキストが主なソースであり、旧 recover 専用フィールドがあらゆる検出を個別にカバーすることを保証しない。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されない。 例: 主机 {{host}} 检测结果 {{Result}}取得または入力方法: 実際の検出ディメンションと結果変数に従ってイベント/通知テンプレートを作成し、同タイプの検証済みイベントから再利用できます。 |
|
| checker.jsonScript.noDataRecoverMessage | string | データなし復旧アップロードイベント情報テンプレートを出力。対応するチェックタイプに応じて任意入力。変更時に省略を保持とみなすことはできず、設定全体を復元する必要がある。任意で、省略時は独立したテキストを提供しない。現在の共通構築では title/message とデータなしテキストが主なソースであり、旧 recover 専用フィールドがあらゆる検出を個別にカバーすることを保証しない。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されない。 例: 主机 {{host}} 检测结果 {{Result}}取得または入力方法: 実際の検出ディメンションと結果変数に従ってイベント/通知テンプレートを作成し、同タイプの検証済みイベントから再利用できます。 |
|
| checker.jsonScript.noDataRecoverTitle | string | データなし復旧アップロードイベントタイトルテンプレートを出力。対応するチェックタイプに応じて任意入力。変更時に省略を保持とみなすことはできず、設定全体を復元する必要がある。任意で、省略時は独立したテキストを提供しない。現在の共通構築では title/message とデータなしテキストが主なソースであり、旧 recover 専用フィールドがあらゆる検出を個別にカバーすることを保証しない。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されない。 例: 主机 {{host}} 检测结果 {{Result}}取得または入力方法: 実際の検出ディメンションと結果変数に従ってイベント/通知テンプレートを作成し、同タイプの検証済みイベントから再利用できます。 |
|
| checker.jsonScript.noDataTitle | string | データなしイベントタイトルテンプレートを出力。対応するチェックタイプに応じて任意入力。変更時に省略を保持とみなすことはできず、設定全体を復元する必要がある。任意で、省略時は独立したテキストを提供しない。現在の共通構築では title/message とデータなしテキストが主なソースであり、旧 recover 専用フィールドがあらゆる検出を個別にカバーすることを保証しない。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されない。 例: 主机 {{host}} 检测结果 {{Result}}取得または入力方法: 実際の検出ディメンションと結果変数に従ってイベント/通知テンプレートを作成し、同タイプの検証済みイベントから再利用できます。 |
|
| checker.jsonScript.notificationMessage | string | イベント通知内容。対応するチェックタイプに応じて任意入力。変更時に省略を保持とみなすことはできず、設定全体を復元する必要がある。任意で、省略時は独立したテキストを提供しない。現在の共通構築では title/message とデータなしテキストが主なソースであり、旧 recover 専用フィールドがあらゆる検出を個別にカバーすることを保証しない。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されない。 例: 主机 {{host}} 检测结果 {{Result}}取得または入力方法: 実際の検出ディメンションと結果変数に従ってイベント/通知テンプレートを作成し、同タイプの検証済みイベントから再利用できます。 |
|
| checker.jsonScript.openNoDataNotificationMessage | boolean | 任意、デフォルト false。無効時は対応するイベント内容を使用し、有効時は対応する notificationMessage/noDataNotificationMessage も提供。 例: false取得または入力方法: 通知専用内容を別途使用する場合に true。 |
|
| checker.jsonScript.openNotificationMessage | boolean | 任意、デフォルト false。無効時は対応するイベント内容を使用し、有効時は対応する notificationMessage/noDataNotificationMessage も提供。 例: false取得または入力方法: 通知専用内容を別途使用する場合に true。 |
|
| checker.jsonScript.periodBefore | integer | タイプに応じて任意入力。高度な変化の比較オフセット秒数(例: 昨日 86400)。range/range_2 と合わせて完全に入力。変更時は適用設定を完全に保持し、単位を混在させない。 例: 86400取得または入力方法: 業務要件でウィンドウ/オフセット/継続時間を決定し、まず対応するタイプの詳細と実際のイベントで確認します。 |
|
| checker.jsonScript.range | integer | タイプに応じて任意入力。高度な変化の現在の比較ウィンドウ、正の整数秒。変更時は適用設定を完全に保持し、単位を混在させない。 例: 3600取得または入力方法: 業務要件でウィンドウ/オフセット/継続時間を決定し、まず対応するタイプの詳細と実際のイベントで確認します。 |
|
| checker.jsonScript.range_2 | integer | タイプに応じて任意入力。高度な変化の比較ウィンドウ設定。-1 は前期比、0 は periodBefore に従い、その他は対応する高度な検出定義の秒ウィンドウに従う。変更時は適用設定を完全に保持し、単位を混在させない。 例: -1取得または入力方法: 業務要件でウィンドウ/オフセット/継続時間を決定し、まず対応するタイプの詳細と実際のイベントで確認します。 |
|
| checker.jsonScript.recoverMessage | string | 復旧イベント情報テンプレートを出力。対応するチェックタイプに応じて任意入力。変更時に省略を保持とみなすことはできず、設定全体を復元する必要がある。任意で、省略時は独立したテキストを提供しない。現在の共通構築では title/message とデータなしテキストが主なソースであり、旧 recover 専用フィールドがあらゆる検出を個別にカバーすることを保証しない。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されない。 例: 主机 {{host}} 检测结果 {{Result}}取得または入力方法: 実際の検出ディメンションと結果変数に従ってイベント/通知テンプレートを作成し、同タイプの検証済みイベントから再利用できます。 |
|
| checker.jsonScript.recoverNeedPeriodCount | integer | タイプに応じて任意入力。通常頻度では連続復旧周期数、customCrontab では直接秒単位の復旧時間、省略時 0。変更時は適用設定を完全に保持し、単位を混在させない。 例: 1取得または入力方法: 業務要件でウィンドウ/オフセット/継続時間を決定し、まず対応するタイプの詳細と実際のイベントで確認します。 |
|
| checker.jsonScript.recoverTitle | string | 復旧イベントタイトルテンプレートを出力。対応するチェックタイプに応じて任意入力。変更時に省略を保持とみなすことはできず、設定全体を復元する必要がある。任意で、省略時は独立したテキストを提供しない。現在の共通構築では title/message とデータなしテキストが主なソースであり、旧 recover 専用フィールドがあらゆる検出を個別にカバーすることを保証しない。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されない。 例: 主机 {{host}} 检测结果 {{Result}}取得または入力方法: 実際の検出ディメンションと結果変数に従ってイベント/通知テンプレートを作成し、同タイプの検証済みイベントから再利用できます。 |
|
| checker.jsonScript.subUri | string | OuterEventChecker の新規追加では必須の空でない文字列。公開受信 URL は単一のパスセグメントで、/ を含められない(%2F にエンコードしても 404 になる)。英数字とハイフンを推奨。複数ルールで同じサフィックスを許可し、一意性は secret が担当。通常の検出では入力しない。 例: datakit-push取得または入力方法: 現在の外部イベント連携用に Webhook サフィックスを選択します。 |
|
| checker.jsonScript.targetWorkspaceUUID | string | 任意の単一ソース。空でない targetWorkspaceUUIDs が優先。単一ソースの認可失敗は import が捕捉して failCount に計上可能。複数ソースの一部失敗は実行範囲を縮小するが全体として成功に計上可能であり、このフィールドからすべてのソースが実行されたと推測できない。V2 では禁止。 例: wksp_source_example取得または入力方法: 有効なクロスワークスペース認可から単一のソースワークスペースを取得します。 |
|
| checker.jsonScript.targets | array | 通常のクエリ対象配列。DQL/PromQL の実際の実行文は dql に置く。通常の共通プラグインの alias は Result または空のみ受け付け、別名の一意性をチェックし、単一対象 Result を推奨。複合モニタリングでは monitorCheckerId/alias でメンバーを関連付け、V2 では targets を禁止し、すべて YAML に置く。 例: [{"dql": "M::cpu:(avg(usage_idle)) BY host", "alias": "Result", "qtype": "dql"}]取得または入力方法: まず対象ワークスペースの同じデータソースでクエリを検証し、フィールド/インデックスが実際に存在する必要があります。 |
|
| checker.jsonScript.title | string | テンプレート入口には通常の add のような統一必須/256 加重長の事前チェックがない。空でない文字列を推奨し、通常ルールの推奨長を採用するが、具体的にはプラグイン/下流の制限を受ける。title がないと必ず事前拒否されると想定してはならない。 例: 生产CPU阈值取得または入力方法: 元テンプレートのイベントタイトルから取得することを推奨。インポート名は title が空でない場合に優先し、そうでなければ name を使用します。 |
|
| checker.jsonScript.type | string | 必須のプラグイン識別子。mutationsCheck/rangeCheck/seniorCheck などの履歴互換および旧 smart* は引き続き元の設定に従って維持し、エンティティ type で代替しない。具体的なフィールドはそのタイプにのみ適用され、混在できない。V2 と旧版は相互に切り替えられない。 例: simpleCheck取得または入力方法: 検出方法に応じて選択。通常は simpleCheck しきい値、apmCheck/rumCheck/processCheck/cloudDialCheck/networkCheck/objectCheck。高度は seniorMutationsCheck/seniorRangeCheck/seniorRangeV2Check/outlierCheck。combinedCheck は複合、OuterEventChecker は外部イベント、programmableCheck はプログラマブル。インテリジェント V2 は smartMonitorV2Check、AI セマンティクスは aiMonitor(エンティティ type と同名だがフィールド階層が異なる)。 |
|
| checker.jsonScript.windowDql | string | 任意の互換ウィンドウクエリテキスト。イベントの追加情報として透過し、targets 内の実際の検出クエリを代替しない。省略時は提供しない。 例: M::cpu:(avg(usage_idle)) BY host取得または入力方法: 検証済みの元の検出ウィンドウ表示クエリまたは同タイプの詳細から取得します。 |
|
| checker.jsonScript.targets[*] | json | タイプに応じて下位構造を使用。 例: {"dql": "M::cpu:(avg(usage_idle)) BY host", "alias": "Result", "qtype": "dql"}取得または入力方法: 1 つのクエリまたは複合メンバー。 |
|
| checker.jsonScript.targets[*].dql | string | DQL または PromQL テキスト。qtype で指定。 例: M::cpu:(avg(usage_idle)) BY host取得または入力方法: 対象ワークスペースの実際のデータから作成して検証します。 |
|
| checker.jsonScript.targets[*].qtype | string | 任意、通常は dql。 例: dql取得または入力方法: DQL は dql、PromQL は promql を選択します。 |
|
| checker.jsonScript.targets[*].alias | string | 通常のプラグインは Result または空のみ受け付け、重複しない。 例: Result取得または入力方法: 通常の単一クエリは Result、複合メンバーは A/B などで割り当てます。 |
|
| checker.jsonScript.targets[*].monitorCheckerId | string | combinedCheck のみ。メンバーは Cron 競合があるルールにできない。 例: rul_checker_example取得または入力方法: 現在のワークスペースのモニター一覧から利用可能なメンバー UUID を取得します。 |
|
| checker.jsonScript.groupBy[*] | string | 単一ディメンション。 例: host取得または入力方法: 実際の DQL BY フィールド。 |
|
| checker.jsonScript.checkFuncs[*] | json | seniorCheck は先頭項目を使用。 例: {"funcId": "example.func", "kwargs": {}}取得または入力方法: 元の互換カスタム関数設定から取得します。 |
|
| checker.jsonScript.checkFuncs[*].funcId | string | 互換関数識別子。 例: example.func取得または入力方法: 実際に利用可能な関数 ID。 |
|
| checker.jsonScript.checkFuncs[*].kwargs | json | 動的オブジェクト、統一された必須サブキーなし。 例: {}取得または入力方法: その関数固有のパラメータ構造。 |
|
| checker.jsonScript.checkFuncs[*].kwargs.パラメータ名 | any | 単一の関数専用値。 例: 1取得または入力方法: 対応する関数ドキュメントから名前/タイプ/ソースを取得します。 |
|
| checker.jsonScript.checkerOpt.rules[*] | json | アルゴリズムごとに異なる条件構造を使用可能。 例: {"status": "warning", "conditionLogic": "and", "conditions": [{"alias": "Result", "operator": "<", "operands": [10]}]}取得または入力方法: 単一のアラートレベル条件。 |
|
| checker.jsonScript.checkerOpt.rules[*].status | string | 共通プラグインの許可集合。実際の検出タイプに応じて使用。 例: warning取得または入力方法: イベントレベルに応じて fatal/critical/error/warning/info/ok/ALL を選択します。 |
|
| checker.jsonScript.checkerOpt.rules[*].conditionLogic | string | 共通条件では必須。 例: and取得または入力方法: and/or。 |
|
| checker.jsonScript.checkerOpt.rules[*].conditions | array | 共通条件では必須の配列。 例: [{"alias": "Result", "operator": "<", "operands": [10]}]取得または入力方法: 実際のクエリ結果としきい値から構築します。 |
|
| checker.jsonScript.checkerOpt.rules[*].okConditions | array | 任意、openOkConditions と併用。しきい値比較方向はトリガーと逆で、境界が有効である必要がある。 例: [{"alias": "Result", "operator": ">=", "operands": [20]}]取得または入力方法: 段階的復旧用に独立した境界を設定します。 |
|
| checker.jsonScript.checkerOpt.rules[*].matchTimes | integer | 任意、openMatchTimes と併用。有効時はデフォルト 1、実際の範囲は 1..100、超過時は ErrorContinuousTriggerCfgCount を返す。 例: 2取得または入力方法: 業務上、何回連続で異常になったらトリガーするかを指定します。 |
|
| checker.jsonScript.checkerOpt.rules[*].conditions[*] | json | 単一の比較条件。 例: {"alias": "Result", "operator": "<", "operands": [10]}取得または入力方法: 実際のクエリ Result としきい値で構築します。 |
|
| checker.jsonScript.checkerOpt.rules[*].conditions[*].alias | string | 対象 alias と一致。 例: Result取得または入力方法: 同じクエリ対象、データ単位、業務境界に従って設定します。 |
|
| checker.jsonScript.checkerOpt.rules[*].conditions[*].operator | string | 共通演算 =、!=、>、>=、<、<=、between、notBetween、like、notLike、in、notIn、regExp、notRegExp、isTrue、isFalse、likeTrue、likeFalse。具体的なアルゴリズムでは絞り込む場合がある。 例: <取得または入力方法: 同じクエリ対象、データ単位、業務境界に従って設定します。 |
|
| checker.jsonScript.checkerOpt.rules[*].conditions[*].operands | array | 文字列/数値の配列、実際の結果単位を保持。ブール値/オブジェクトは指定せず、空値条件はフィルタされる場合がある。 例: [10]取得または入力方法: 同じクエリ対象、データ単位、業務境界に従って設定します。 |
|
| checker.jsonScript.checkerOpt.rules[*].conditions[*].operands[*] | JSON | 単一のしきい値。数値比較では JSON 数値、正規表現/集合では実際のルールに応じて文字列を指定。 例: 10取得または入力方法: 同じクエリ対象、データ単位、業務境界に従って設定します。 |
|
| checker.jsonScript.checkerOpt.rules[*].okConditions[*] | json | 単一の比較条件。 例: {"alias": "Result", "operator": "<", "operands": [10]}取得または入力方法: 実際のクエリ Result としきい値で構築します。 |
|
| checker.jsonScript.checkerOpt.rules[*].okConditions[*].alias | string | 対象 alias と一致。 例: Result取得または入力方法: 同じクエリ対象、データ単位、業務境界に従って設定します。 |
|
| checker.jsonScript.checkerOpt.rules[*].okConditions[*].operator | string | 共通演算 =、!=、>、>=、<、<=、between、notBetween、like、notLike、in、notIn、regExp、notRegExp、isTrue、isFalse、likeTrue、likeFalse。具体的なアルゴリズムでは絞り込む場合がある。 例: <取得または入力方法: 同じクエリ対象、データ単位、業務境界に従って設定します。 |
|
| checker.jsonScript.checkerOpt.rules[*].okConditions[*].operands | array | 文字列/数値の配列、実際の結果単位を保持。ブール値/オブジェクトは指定せず、空値条件はフィルタされる場合がある。 例: [10]取得または入力方法: 同じクエリ対象、データ単位、業務境界に従って設定します。 |
|
| checker.jsonScript.checkerOpt.rules[*].okConditions[*].operands[*] | JSON | 単一のしきい値。数値比較では JSON 数値、正規表現/集合では実際のルールに応じて文字列を指定。 例: 10取得または入力方法: 同じクエリ対象、データ単位、業務境界に従って設定します。 |
|
| checker.jsonScript.channels[*] | string | 配列内の単一の有効値。 例: chan_example取得または入力方法: 上位説明のチャンネルまたはアカウント識別子を取得します。 |
|
| checker.jsonScript.atAccounts[*] | string | 配列内の単一の有効値。 例: acnt_example取得または入力方法: 上位説明のチャンネルまたはアカウント識別子を取得します。 |
|
| checker.jsonScript.atNoDataAccounts[*] | string | 配列内の単一の有効値。 例: acnt_example取得または入力方法: 上位説明のチャンネルまたはアカウント識別子を取得します。 |
|
| checker.jsonScript.checkerOpt.infoEventCondition.operands[*] | JSON | 文字列または数値。 例: 60取得または入力方法: クエリ Result と同じ単位の比較値。 |
|
| checker.jsonScript.checkerOpt.rules[*].strength | integer | 履歴タイプ専用、旧 mutationsCheck の強度 1/2/3。新しい高度なタイプは対応する checkerOpt フィールドを使用し、混用しない。 例: 2取得または入力方法: 既存の旧アルゴリズムを維持する場合、元の詳細から読み取ります。 |
|
| checker.jsonScript.checkerOpt.rules[*].direction | string | 履歴タイプ専用、旧 mutationsCheck/rangeCheck の方向 up/down/both。新しい高度なタイプは対応する checkerOpt フィールドを使用し、混用しない。 例: both取得または入力方法: 既存の旧アルゴリズムを維持する場合、元の詳細から読み取ります。 |
|
| checker.jsonScript.checkerOpt.rules[*].checkCount | integer | 履歴タイプ専用、旧変化検出のチェック回数、整数。新しい高度なタイプは対応する checkerOpt フィールドを使用し、混用しない。 例: 3取得または入力方法: 既存の旧アルゴリズムを維持する場合、元の詳細から読み取ります。 |
|
| checker.jsonScript.checkerOpt.rules[*].periodNum | integer | 履歴タイプ専用、旧変化/範囲の周期数、整数。新しい高度なタイプは対応する checkerOpt フィールドを使用し、混用しない。 例: 3取得または入力方法: 既存の旧アルゴリズムを維持する場合、元の詳細から読み取ります。 |
|
| checker.extend.isNeedCreateIssue | boolean | デフォルト false。有効時はチャンネル/担当者/ステータス/レベルマッピングも検証。 例: false取得または入力方法: イベントから Issue を自動生成する場合に true。 |
|
| checker.extend.issueLevelUUID | string | 履歴互換レベル。無効な場合は空にクリアされる可能性があり、成功はレベルが有効であることを証明しない。 例: issl_example取得または入力方法: 有効な Issue レベル一覧から uuid を取得します。 |
|
| checker.extend.issueDfStatus | array | 要素は fatal/critical/error/warning/nodata に限る。 例: ["critical", "error"]取得または入力方法: どの異常レベルで Issue をトリガーするか選択します。 |
|
| checker.extend.issueDfStatus[*] | string | 単一の許可ステータス。 例: error取得または入力方法: 実際のアラートレベル。 |
|
| checker.extend.manager | array | 担当者リストは具体的な対象に正規化される。オンコール担当者はワークスペースのタイムゾーンにおける当日のカレンダーで解決され、今回の書き込み後はシフト交代で自動変化しない。 例: ["acnt_example"]取得または入力方法: ワークスペースのメンバー/チーム/通知スケジュールから担当者対象を取得します。 |
|
| checker.extend.manager[*] | string | 単一の担当者。まずソースが有効であることを確認。 例: acnt_example取得または入力方法: メンバー/チームまたはサポートされる当日オンコール対象識別子。 |
|
| checker.extend.incidentsTags | array | Issue 関連タグに使用され、ルールに応じてタグを作成/検証する場合がある。 例: ["production"]取得または入力方法: monitor に適用されるタグ名から取得します。 |
|
| checker.extend.incidentsTags[*] | string | UUID ではない。 例: production取得または入力方法: 実際の業務タグ名。 |
|
| checker.extend.faultMappingMode | string | Issue 有効時はデフォルト custom。existing では有効な levelMappingUUID が必要。 例: custom取得または入力方法: カスタムマッピングは custom、既存マッピング参照は existing。 |
|
| checker.extend.levelMappingUUID | string | existing 条件では有効な UUID が必須。custom 分岐ではこの参照フィールドを削除するが、履歴のカスタム行は保持。 例: islm_example取得または入力方法: 本ワークスペースで利用可能な異常レベルマッピング設定から取得します。 |
|
| checker.extend.bindIncidentsInfo | array | custom マッピング行。custom に戻してこのキーを省略した場合、コントローラーは旧行を保持できるが、公開 extend の全体復元には依然として注意が必要。 例: [{"incidentsLevelUUID": "issl_example", "incidentsDfStatus": ["error"]}]取得または入力方法: イベントレベルに対応する Issue レベルで構築します。 |
|
| checker.extend.bindIncidentsInfo[*] | json | 1 つのマッピングオブジェクト。 例: {"incidentsLevelUUID": "issl_example", "incidentsDfStatus": ["error"]}取得または入力方法: 単一ステータスからレベルへのマッピング。 |
|
| checker.extend.bindIncidentsInfo[*].incidentsLevelUUID | string | 無効なレベルはクリアされる場合がある。 例: issl_example取得または入力方法: 有効な Issue レベル一覧から取得します。 |
|
| checker.extend.bindIncidentsInfo[*].incidentsDfStatus | array | 許可ステータス配列。 例: ["error"]取得または入力方法: fatal/critical/error/warning/nodata から選択します。 |
|
| checker.extend.bindIncidentsInfo[*].incidentsDfStatus[*] | string | 単一の許可値。 例: error取得または入力方法: 実際のイベントレベル。 |
|
| checker.extend.smartMonitor.source | string | ai/builtin。新規 OpenAPI では生成認証情報なしで完全で有効な設定を直接送信可能。 例: ai取得または入力方法: 対応する生成結果/組み込みテンプレートのメタ情報から取得し、サイトの実際のテンプレート ID を捏造しない。 |
|
| checker.extend.smartMonitor.category | string | ソース分類。V2 の変更では変更できない。 例: custom取得または入力方法: 対応する生成結果/組み込みテンプレートのメタ情報から取得し、サイトの実際のテンプレート ID を捏造しない。 |
|
| checker.extend.smartMonitor.prompt | string | AI プロンプト。既存 prompt を変更する場合は候補を再生成する必要がある。 例: 检测生产主机异常。取得または入力方法: 対応する生成結果/組み込みテンプレートのメタ情報から取得し、サイトの実際のテンプレート ID を捏造しない。 |
|
| checker.extend.smartMonitor.templateId | string | builtin ソースのテンプレート識別子。変更では変更できない。 例: template_example取得または入力方法: 対応する生成結果/組み込みテンプレートのメタ情報から取得し、サイトの実際のテンプレート ID を捏造しない。 |
|
| checker.extend.smartMonitor.templateVersion | string | builtin テンプレートバージョン。変更では変更できない。 例: 1取得または入力方法: 対応する生成結果/組み込みテンプレートのメタ情報から取得し、サイトの実際のテンプレート ID を捏造しない。 |
|
| checker.extend.smartMonitor | json | V2 専用。サーバー側で偽造された実行/バージョン状態をクリアし、engineVersion/configVersion を書き込む。許可されたフィールドを保持し、旧ソース分類は不変。 例: {"source": "ai", "category": "custom", "prompt": "检测生产主机异常。"}取得または入力方法: 生成またはテンプレート選択フローからソースメタ情報を取得します。 |
|
| checker.extend.querylist | array | 任意。存在する場合は保持し、queryType の自動注入より優先。targets の実際の DQL を代替せず、誤ったエコーバック構造は検出が正常であることを証明しない。 例: []取得または入力方法: 既存のクライアントエコーバック設定は元の詳細から完全な配列を直接取得します。 |
|
| checker.extend.querylist[*] | json | 動的エディターオブジェクト。クライアントバージョンごとに保存。実際の検出は targets のみに基づく。 例: {"qtype": "dql", "query": {"q": "M::cpu:(avg(usage_idle)) BY host"}}取得または入力方法: クライアントエディターが生成した単一クエリのエコーバック。 |
|
| checker.extend.querylist[*].qtype | string | 実行クエリを自動変換しない。 例: dql取得または入力方法: dql/promql クエリタイプのエコーバック。 |
|
| checker.extend.querylist[*].query | json | simple/dql モードの詳細を含む場合があるが、targets の代替にはできない。 例: {"q": "M::cpu:(avg(usage_idle)) BY host"}取得または入力方法: クライアント生成のクエリ編集構造。 |
|
| checker.extend.querylist[*].query.q | string | 完全な DQL/PromQL エコーバック。 例: M::cpu:(avg(usage_idle)) BY host取得または入力方法: 実際の targets クエリテキストと一致させます。 |
|
| checker.jsonScript.targetWorkspaceUUIDs | array | 任意の空でない配列は単数の targetWorkspaceUUID より優先。ソースごとに AuthorizationVerificationFailed のみスキップし、少なくとも 1 つ有効なら実際に有効なソースのスケジュールを作成できるが、元の完全な配列を保存する。すべて失敗した場合は CheckerAuthorizationVerificationFailed、その他の例外は中断可能。crontabInfo.multiWsCrontabInfo を読み取って実際の実行範囲を確認する必要がある。 例: ["wksp_source_a", "wksp_source_b"]取得または入力方法: 対象ワークスペースの有効なクロスワークスペース認可からソース UUID を取得します。テンプレートはこのフィールドを持て、通常の add ネスト許可リストの制限を受けません。 |
|
| checker.jsonScript.targetWorkspaceUUIDs[*] | string | 入力保持値や成功件数を、そのソースが認可済み/スケジュール作成済みとみなすことはできない。V2 では引き続きクロスワークスペースフィールドを禁止。 例: wksp_source_a取得または入力方法: 単一の実際に有効なソースワークスペース UUID を使用します。 |
|
| checker.jsonScript.name | string | 任意の旧テンプレートフィールド。空でない title は name を上書きする。有効な名前を提供することを推奨し、プラグイン統一名称チェックがコメントアウトされていることを無制限サポートとみなしてはならない。 例: 生产CPU阈值取得または入力方法: 旧エクスポートテンプレートの互換名。空でない title がない場合にインポート名のソースとして使用します。 |
|
| checker.jsonScript.fixedCrontab | string | テンプレートはこの互換フィールドを保存できるが、通常の公開 add/modify には同じ許可リストがない。空でない場合、共通頻度事前チェックは every 検証をスキップし、実際の make_crontab は引き続き customCrontab を先に取得し、every がある場合は every に従って生成する。競合する頻度を同時に指定しないこと。インポート後は crontabInfo の実際の Cron で確認し、V2 ではこのフィールドを禁止。 例: 0 */5 * * * *取得または入力方法: 信頼できる旧エクスポートテンプレートの固定 Cron のみを保持し、内部スケジュールフィールドを独自に組み立てません。 |
|
| checker | json | Y | 必須の単一テンプレートオブジェクト。エンティティタイプは旧オブジェクトの正規化タイプと一致する必要がある。checkers 配列ではなく、対象 UUID を変更しない。 null 許可: False 例: {"type": "trigger", "signId": "sign_example", "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]}]}]}}, "extend": {}, "is_disable": false, "tagInfo": [{"name": "production"}], "secret": "", "monitorName": "default", "alertPolicyNames": ["生产告警"], "configVersion": 1}取得または入力方法: 同バージョンの export から単一テンプレートを取得し、置換前に対象を get して元の設定をバックアップします。 |
パラメータ補足説明¶
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/rul_checker_example/replace' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"checker":{"type":"trigger","signId":"sign_example","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]}]}]}},"extend":{},"is_disable":false,"tagInfo":[{"name":"production"}],"secret":"","monitorName":"default","alertPolicyNames":["生产告警"]}}'
レスポンス¶
HTTP 200、application/json。以下の例は直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer または null | インポート作成では送信前にレスポンスを構築するため null の場合があり、置換では現在のレコード番号。 |
| content.uuid | string | 現在の rul_ ルール UUID。履歴 UUID やエクスポート signId ではない。 |
| 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.atAccounts | array | 任意の配列、デフォルト []。channels はインシデント連携に使用され、直接の通知先ではない。サーバー側でデフォルトチャンネルを補完/無効チャンネルを除外する場合がある。@外部メールアドレスは無料/体験版で制限される。保存は通知送信済みを意味しない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.atNoDataAccounts | array | 任意の配列、デフォルト []。channels はインシデント連携に使用され、直接の通知先ではない。サーバー側でデフォルトチャンネルを補完/無効チャンネルを除外する場合がある。@外部メールアドレスは無料/体験版で制限される。保存は通知送信済みを意味しない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.channels | array | 任意の配列、デフォルト []。channels はインシデント連携に使用され、直接の通知先ではない。サーバー側でデフォルトチャンネルを補完/無効チャンネルを除外する場合がある。@外部メールアドレスは無料/体験版で制限される。保存は通知送信済みを意味しない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkFuncs | array | 任意。通常のしきい値では提供不要。seniorCheck は先頭項目の funcId/kwargs を使用し、すべての関数を汎用パラメータとして扱わない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt | json | 通常のルールでは rules をよく使用し、高度なタイプは対応するアルゴリズムに従って入力し、V2 は yamlConfig、AI セマンティクスは userPrompt などを使用する。宣言されていない子フィールドは公開検証で拒否され、内部 SDK のパラメータ全体をそのまま流用できない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.category | string | AI セマンティクス専用。AI セマンティクス分類のメタ情報、任意の文字列。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.combineExpr | string | タイプ専用パラメータ。複合メンバーの alias 式。複合タイプでは空でないことが必須で、Result をメンバー別名の代わりにしない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.confidenceInterval | integer | タイプ専用パラメータ。範囲 V2 の信頼区間 1..100。実際のアルゴリズムに従って設定。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.contextWindowLimit | integer | AI セマンティクス専用。正の整数の Token コンテキスト制限、1 以上。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.creditSoftBudget | number | AI セマンティクス専用。1 回あたりの Credit ソフトバジェット、有限数 >0。API 実行タイムアウトではない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.diffMode | string | タイプ専用パラメータ。高度な変化の value 差分/percent パーセント。明示的に指定が必要。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.direction | string | タイプ専用パラメータ。高度な変化/範囲の up/down/both。明示的に指定が必要。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.disableLargeScaleEventProtect | boolean | 任意のブール値。true で大規模イベント保護を無効化、デフォルト false で保護を維持。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.enableStreamingAggregation | boolean または null | 任意の三状態。サポートされるタイプのストリーミング集約高速化のみを制御し、モニターの有効/無効や DQL の意味変更ではない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.eps | float | タイプ専用パラメータ。外れ値では必須、数値 0..3.0。このアルゴリズムでは通常の rules 条件検証を使用しない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.ignoreNodata | boolean | 任意のブール値。複合モニタリングのみ true でデータなしを無視、デフォルト false。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.infoEvent | boolean | 任意のブール値。true で正常継続時に info を生成、デフォルト false。infoEventCondition はタイプに応じて条件を制御。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.infoEventCondition | json | 任意、{} は無条件 Info を表す。通常のしきい値/ログ/アプリケーションとアクセス指標/可用性/プロセス/ネットワーク/変化/範囲などサポートされるタイプのみ適用。外れ値/複合/生存V2/変更/プログラマブル/インテリジェント/SLO は非対応で、指定すると UnsupportTriggerFields を返す。空でない場合は alias/operator/operands が完全かつ有効である必要がある。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.infoEventCondition.alias | string | 空でない Info 条件内で構造に従って入力。targets の別名に対応。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.infoEventCondition.operands | array | 空でない Info 条件内で構造に従って入力。比較値の配列、要素は文字列/数値、オブジェクトは指定しない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.infoEventCondition.operator | string | 空でない Info 条件内で構造に従って入力。本ページの通常条件演算子から選択。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.maxChatRounds | integer | AI セマンティクス専用。最大会話ラウンド数、整数 1 以上。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.maxDQLQueries | integer | AI セマンティクス専用。最大 DQL 呼び出し回数、整数 0 以上。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.mentions | array | AI セマンティクスでは任意、デフォルト []。各項目は type=dql、namespace/datasource は空でないこと、index は任意で指定する場合は空でないこと。正規化 JSON シリアライズの総長 ≤20000 文字。データクエリ認可の代わりにはならない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.mentions[] | object | type/namespace/datasource は必須、index は任意。4 フィールドのみ宣言。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.mentions[].datasource | string | 参照項目内の実際のデータソース名(例: ログ source/メジャーメント)。名前空間に応じて解釈。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.mentions[].index | string | 参照項目内のログ参照には実際のインデックス名/識別子を入力。他のタイプでは省略可能。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.mentions[].namespace | string | 参照項目内の実際の DQL 名前空間。エンティティ type ではない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.mentions[].type | string | 参照項目内で固定の dql。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.model | string | AI セマンティクス専用。AI セマンティクスの任意モデル名。サイトがサポートするモデル設定から取得し、ドキュメント例のリテラル値を使用してはならない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.openMatchTimes | boolean | 任意のブール値。true で連続トリガー一致を有効化、デフォルト false。rules[].matchTimes と組み合わせる。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.openOkConditions | boolean | 任意のブール値。true で段階的復旧を有効化、デフォルト false。okConditions はトリガーと復旧の境界を満たす必要がある。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.rules | array | 通常ルールの条件配列。各項目は status/conditionLogic/conditions を持ち、復旧には okConditions を使用。誤ったメンバー/演算形状は通常例外を送出して最終的に 500 になる場合があり、一概に 406 ではない。operands が空の条件はスケジュール構築前にフィルタされるため、「すべて」を表現するために使用しない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.script | string | タイプ専用パラメータ。プログラマブル検出スクリプトのテキスト。このタイプがサポートする構文を使用し、本 API はスクリプトテストを 1 回実行しない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.systemPrompt | string | AI セマンティクス専用。AI セマンティクスでは任意、指定時は空でないこと、Python 文字数 ≤20000。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.threshold | json | 任意のオブジェクト。指定時は status/operator/value がすべて必須として宣言される。status=false で前提判定を無効化、value は null を許可するがアルゴリズムの実際の意味に従って入力する。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.threshold.operator | string | 親オブジェクトが存在する場合に必須。前提比較演算子(例: >)。実際の高度な検出の互換集合に従う。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.threshold.status | boolean | 親オブジェクトが存在する場合に必須。前提条件を有効にするか。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.threshold.value | float または null | 親オブジェクトが存在する場合に必須。前提数値。status=false では null を許可、status=true では数値が必須、そうでなければ IllegalMutationParameters。単位はクエリ結果と一致。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.userPrompt | string | AI セマンティクス専用。AI セマンティクスの条件では必須で空でないこと、Python 文字数 ≤20000。空文字列を宣言できるが、業務上空白は受け付けない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.checkerOpt.yamlConfig | string | V2 のみ必須。空でない UTF-8 YAML テキスト ≤256KiB で、JSON オブジェクトや Markdown フェンスではない。構造は本ページの YAML 表を参照。アンカー/別名/明示的タグ/重複キーは禁止。変更は既存の DQL、threshold 設定、アルゴリズム params のみ許可され、ルール集合/名前/実行構造は変更できない。保存時にプロトコル/予算を検証し、検出クエリのデータドメイン権限を解析するが、DQL を実行したり、データ存在/ソース認可が完全に再確認済みであることを保証しない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.customCrontab | string | 任意。空でない場合は every より優先。5 フィールドまたは秒付き 6 フィールドをサポートし、秒ステップ形式は 20 未満にできない。複合モニタリングおよび複合対象メンバーにはカスタム頻度の競合制限がある。V2 では禁止。検出タイムゾーンは現在のワークスペース/サービス設定に依存し、文字列内のタイムゾーン名でフィールドを代替しない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.delaySeconds | integer | 任意の通常モニタリングのデータ待機ウィンドウ、単位は秒、0 は待機なし、省略時 0。ブール値は整数として扱わない。インテリジェント/AI は通常の待機設定を使用せず、これでインテリジェント実行遅延を調整できない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.disableCheckEndTime | boolean | 任意の互換ブール値、デフォルト false、実際のサポートは検出タイプに依存。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.eventChartEnable | boolean | 任意、デフォルト false。サポートされる Doris ログ主ストレージ処理のみ。保存成功はグラフ生成済みを証明しない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.eventCharts | array | 任意のグラフ設定配列。イベントグラフを有効にする場合に併せて指定し、具体的な結果はイベント処理チェーンで生成され、書き込みレスポンスでは返されない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.eventCharts[] | object | dql サブフィールドのみを宣言。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.eventCharts[].dql | string | 任意のクエリテキスト。グラフ UUID ではなく、保存時にグラフクエリを実行しない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.every | string | 通常の共通プラグインでは every または customCrontab が必要。最大 24h、最小 20s を推奨。有効な正の整数形式を使用し、0/負値や d/w は使用できない。一部の形式問題は 500 になる場合がある。V2 は固定 10m で、サーバー側が every を上書きする。AI セマンティクスは自身の検出頻度に従う。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.groupBy | array | 任意のディメンション名配列。通常 [] は追加ディメンションでグループ化しないことを表し、タグ値ではない。複合モニタリングメンバーのディメンションは互換である必要がある。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.interval | integer | 通常 targets がある場合は 1..2592000 秒(30 日)が必要。every の検出頻度とは異なる。複合モニタリングはこの共通チェックをスキップし、V2 は YAML query.interval/lookback を使用。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.isChangeEvent | boolean | OuterEventChecker では任意、デフォルト false。他のタイプでは使用しない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.message | string | event 内容。対応するチェックタイプに応じて任意入力。変更時に省略を保持とみなすことはできず、設定全体を復元する必要がある。任意で、省略時は独立したテキストを提供しない。現在の共通構築では title/message とデータなしテキストが主なソースであり、旧 recover 専用フィールドがあらゆる検出を個別にカバーすることを保証しない。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.noDataAction | string | 任意。none/checkAs0/noDataEvent/noDataEventRepeat/fatalEvent/criticalEvent/errorEvent/warningEvent/okEvent/noData/recover。noDataEventRepeat は適用可能なタイプのみサポートし、正の整数の noDataInterval が必要。省略/空の互換値と正の継続時間には専用の履歴処理があり、デフォルト実装に依存して繰り返しアラートを実現しない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.noDataInterval | integer | タイプに応じて任意入力。データなし継続時間(秒)。通常頻度では検出周期全体に切り上げて換算され、カスタム頻度では直接秒。repeat のデータなしは正の整数が必須。変更時は適用設定を完全に保持し、単位を混在させない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.noDataMessage | string | データなしイベント情報テンプレートを出力。対応するチェックタイプに応じて任意入力。変更時に省略を保持とみなすことはできず、設定全体を復元する必要がある。任意で、省略時は独立したテキストを提供しない。現在の共通構築では title/message とデータなしテキストが主なソースであり、旧 recover 専用フィールドがあらゆる検出を個別にカバーすることを保証しない。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.noDataNotificationMessage | string | データ欠損イベントの通知内容。対応するチェックタイプに応じて任意入力。変更時に省略を保持とみなすことはできず、設定全体を復元する必要がある。任意で、省略時は独立したテキストを提供しない。現在の共通構築では title/message とデータなしテキストが主なソースであり、旧 recover 専用フィールドがあらゆる検出を個別にカバーすることを保証しない。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.noDataRecoverMessage | string | データなし復旧アップロードイベント情報テンプレートを出力。対応するチェックタイプに応じて任意入力。変更時に省略を保持とみなすことはできず、設定全体を復元する必要がある。任意で、省略時は独立したテキストを提供しない。現在の共通構築では title/message とデータなしテキストが主なソースであり、旧 recover 専用フィールドがあらゆる検出を個別にカバーすることを保証しない。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.noDataRecoverTitle | string | データなし復旧アップロードイベントタイトルテンプレートを出力。対応するチェックタイプに応じて任意入力。変更時に省略を保持とみなすことはできず、設定全体を復元する必要がある。任意で、省略時は独立したテキストを提供しない。現在の共通構築では title/message とデータなしテキストが主なソースであり、旧 recover 専用フィールドがあらゆる検出を個別にカバーすることを保証しない。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.noDataTitle | string | データなしイベントタイトルテンプレートを出力。対応するチェックタイプに応じて任意入力。変更時に省略を保持とみなすことはできず、設定全体を復元する必要がある。任意で、省略時は独立したテキストを提供しない。現在の共通構築では title/message とデータなしテキストが主なソースであり、旧 recover 専用フィールドがあらゆる検出を個別にカバーすることを保証しない。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.notificationMessage | string | イベント通知内容。対応するチェックタイプに応じて任意入力。変更時に省略を保持とみなすことはできず、設定全体を復元する必要がある。任意で、省略時は独立したテキストを提供しない。現在の共通構築では title/message とデータなしテキストが主なソースであり、旧 recover 専用フィールドがあらゆる検出を個別にカバーすることを保証しない。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.openNoDataNotificationMessage | boolean | 任意、デフォルト false。無効時は対応するイベント内容を使用し、有効時は対応する notificationMessage/noDataNotificationMessage も提供。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.openNotificationMessage | boolean | 任意、デフォルト false。無効時は対応するイベント内容を使用し、有効時は対応する notificationMessage/noDataNotificationMessage も提供。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.periodBefore | integer | タイプに応じて任意入力。高度な変化の比較オフセット秒数(例: 昨日 86400)。range/range_2 と合わせて完全に入力。変更時は適用設定を完全に保持し、単位を混在させない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.range | integer | タイプに応じて任意入力。高度な変化の現在の比較ウィンドウ、正の整数秒。変更時は適用設定を完全に保持し、単位を混在させない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.range_2 | integer | タイプに応じて任意入力。高度な変化の比較ウィンドウ設定。-1 は前期比、0 は periodBefore に従い、その他は対応する高度な検出定義の秒ウィンドウに従う。変更時は適用設定を完全に保持し、単位を混在させない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.recoverMessage | string | 復旧イベント情報テンプレートを出力。対応するチェックタイプに応じて任意入力。変更時に省略を保持とみなすことはできず、設定全体を復元する必要がある。任意で、省略時は独立したテキストを提供しない。現在の共通構築では title/message とデータなしテキストが主なソースであり、旧 recover 専用フィールドがあらゆる検出を個別にカバーすることを保証しない。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.recoverNeedPeriodCount | integer | タイプに応じて任意入力。通常頻度では連続復旧周期数、customCrontab では直接秒単位の復旧時間、省略時 0。変更時は適用設定を完全に保持し、単位を混在させない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.recoverTitle | string | 復旧イベントタイトルテンプレートを出力。対応するチェックタイプに応じて任意入力。変更時に省略を保持とみなすことはできず、設定全体を復元する必要がある。任意で、省略時は独立したテキストを提供しない。現在の共通構築では title/message とデータなしテキストが主なソースであり、旧 recover 専用フィールドがあらゆる検出を個別にカバーすることを保証しない。message およびサポートされるタイプの noDataMessage は先に Jinja 構文解析が行われ、未知の変数の実行値は検証されない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.subUri | string | OuterEventChecker の新規追加では必須の空でない文字列。公開受信 URL は単一のパスセグメントで、/ を含められない(%2F にエンコードしても 404 になる)。英数字とハイフンを推奨。複数ルールで同じサフィックスを許可し、一意性は secret が担当。通常の検出では入力しない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.targetWorkspaceUUID | string | 任意、デフォルトは本ワークスペース。simpleCheck、seniorMutationsCheck、seniorRangeCheck、seniorRangeV2Check、outlierCheck のクロスワークスペースクエリ消費に適用。書き込みは候補 index_list を生成し、呼び出し身份のデータドメイン権限を検証するのみで、保存成功はソース認可が完全に再確認済み、またはデータがクエリ可能であることを意味しない。呼び出し前に実際の対象認可を確認する必要がある。V2 では禁止、認可されたワークスペース内の YAML クエリを使用。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.targets | array | 通常のクエリ対象配列。DQL/PromQL の実際の実行文は dql に置く。通常の共通プラグインの alias は Result または空のみ受け付け、別名の一意性をチェックし、単一対象 Result を推奨。複合モニタリングでは monitorCheckerId/alias でメンバーを関連付け、V2 では targets を禁止し、すべて YAML に置く。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.title | string | 必須の文字列、空でないことを推奨。最大 256 は ASCII/半角カタカナを 1、その他の文字を 2 としてカウント。空でない値はルール name にコピーされ、重複名チェックに参加する。通常/セルフホストインスペクションは重複名グループを共有し、インテリジェント/AI はそれぞれ別グループ。テンプレート実行時に変数が存在するかは実際のイベントで検証する必要がある。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.type | string | 必須のプラグイン識別子。mutationsCheck/rangeCheck/seniorCheck などの履歴互換および旧 smart* は引き続き元の設定に従って維持し、エンティティ type で代替しない。具体的なフィールドはそのタイプにのみ適用され、混在できない。V2 と旧版は相互に切り替えられない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| content.jsonScript.windowDql | string | 任意の互換ウィンドウクエリテキスト。イベントの追加情報として透過し、targets 内の実際の検出クエリを代替しない。省略時は提供しない。これは保存済み設定であり、実際に有効かは検出タイプと組み合わせて確認する必要がある。書き込みはモニターを作成を参照。 |
| 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> |
テンプレートがサポートする複数ソース入力の保存集合。空でない場合は単数より優先。実際に作成された実行ワークスペースは crontabInfo.multiWsCrontabInfo に従い、認可失敗により縮小される場合がある。 |
| content.jsonScript.targetWorkspaceUUIDs[] | string | 単一の対象ワークスペース UUID。 |
| content.jsonScript.targets[].extraOptions | object | 保存時または実行構築時のクエリオプション。現在の認可の完全な保証ではなく、一覧のエコーバックを新しいクエリ認可として直接扱わない。 |
| 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 | 通知で @ される身份識別子。履歴ではメールアドレスの場合がある。 |
| 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.jsonScript.name | string | 互換名。空でない title はコピー/上書きされ、title がない場合はインポート名のフォールバックに使用。 |
| content.jsonScript.fixedCrontab | string | 保持される互換固定 Cron。実際の実行は crontabInfo に従い、every/customCrontab と競合させない。 |
| 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 互換 id。 |
| content.tagInfo[].uuid | string | タグ UUID。 |
| content.tagInfo[].name | string | 名前。 |
| content.tagInfo[].scope | array<string> |
正規化スコープ。 |
| content.tagInfo[].scope[] | string | 単一スコープ。 |
| content.dashboardUUID | string | 解決済みダッシュボード関連。省略可能。 |
| content.skippedTags | array<object> |
リソースタグインポートのコンテキストでスコープ競合時にスキップされた摘要。省略可能。ルール成功はタグがバインド済みであることを保証しない。 |
| content.skippedTags[].name | string | スキップされたタグ名。 |
| content.skippedTags[].scope | array<string> |
タグの実際のスコープ。 |
| content.skippedTags[].scope[] | string | 単一の実際のスコープ。 |
| content.skippedTags[].expectedScope | string | 期待される monitor。 |
| content.skippedTags[].reason | string | scope_mismatch。 |
| content.skippedTags[].resourceUUID | string | 対応するリソース UUID。省略可能。 |
| content.monitorName | string | 置換後のグループ名。条件付きで返却。 |
| content.declaration | object | 共通宣言。 |
{
"code": 200,
"content": {
"id": 100,
"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": "wsak_example",
"createAt": 1785427200,
"updateAt": 1785427300,
"deleteAt": -1,
"tagInfo": [],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーは共通エラー定義を参照してください。
| HTTP ステータス | errorCode | 発生条件 | メッセージまたはレスポンス説明 | 対応方法 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールド欠落、またはフィールド値が宣言された検証条件に違反 | パラメータ解析失敗 | パラメータの位置、フィールド名、型、値を確認。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON 形式エラー | content.reason、line、column に従って JSON を修正。 |
| 404 | ft.NotFoundRuleInspector | 対象が現在のワークスペースに存在しない(削除済みでない)ルール | 指定されたルール/チェッカーが見つかりません | 対応する一覧から有効な UUID を取得。 |
| 404 | ft.NotFoundCheckerRule | 置換中に対象が同時に存在しなくなった | 指定されたモニターが見つかりません | 対象を再読み取り。 |
| 403 | ft.ForbiddenCheckerOperation | 対象の通常ルール操作権限がない | モニター【{}】の操作権限がありません | 許可された主体が実行。 |
| 403 | ft.ForbiddenSmartCheckerOperation | 対象のインテリジェント/AI ルール操作権限がない | インテリジェントモニター【{}】の操作権限がありません | カスタム権限主体を確認。 |
| 409 | ft.SmartMonitorVersionConflict | V2 対象バージョンが checker.configVersion と一致しない | Smart monitor configuration version conflict | 現在バージョンを再読み取りし、テンプレートをマージして再送信。 |
| 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 の解析時に呼び出し身份に対応する名前空間クエリ権限がない | あなたには{}権限がありません | 現在の API Key/身份に必要なデータドメインクエリ権限を設定。モニター設定権限だけでは不十分。 |
| 406 | ft.DqlParseError | 対象クエリ、eval サブ式、または V2 YAML 内の DQL が権限/インデックス解析時に失敗 | dql parser 解析失敗: {} | 実際のクエリ構文と名前空間を修正して再試行。これはクエリ実行済みを意味しない。 |
| 400 | ft.JsonFormatError | JSON Body のトップレベルがオブジェクトでない(配列/文字列など) | 一部の json ファイル形式エラー | 例に従って JSON オブジェクトを送信し、checkers や event 配列を直接送信しない。 |
| 400 | ft.repeatCheckerSecret | 外部イベント secret が他のルール(他ワークスペース/履歴レコードを含む)で使用済み | 外部イベントモニターの secret が既に存在します | グローバルに一意なランダム secret を使用。変更時は自身の元 secret を先に確認。 |
| 400 | ft.ParamsValidateError | queryType、データ待機、AI プロンプト/参照/予算フィールドなどの業務パラメータが無効 | パラメータ検証失敗: {} | 具体的な message フィールドパスに従って修正。AI プロンプトを空白にしない。 |
| 406 | ft.InvalidParameter | イベント message/noDataMessage が文字列でない、または異常レベルマッピングなどの業務フィールドが不一致 | パラメータ{}が無効 |
具体的なフィールドと有効なソースを確認。 |
| 406 | ft.InvalidParameterV2 | 検査対象イベントテンプレートの Jinja 構文が無効 | パラメータ{}の値{}が無効 |
content.field/line/reason に基づいて修正。未知のテンプレート変数が必ず有効であることを意味しない。 |
| 400 | ft.InvalidAlertPolicyUUID | 名前解決後の対象アラートポリシーが変更検証時に無効/同時削除済み | 無効なアラートポリシー UUID | 対象ポリシー名の解決と現在有効なポリシーを確認し、再読み取りして処理。本 Body では alertPolicyUUIDs を直接渡さない。 |
| 400 | ft.UnsupportExternalEmail | 無料/体験版で @ 対象に外部メールアドレスが含まれる | 体験版ワークスペースでは通知先に外部メールアドレスをサポートしません | 本ワークスペースの有効な身份を使用するか、バージョンサポートを確認。 |
| 406 | ft.UnsupportRuleType | 検出プラグインタイプが非対応 | サポートされていないルールタイプ:{} |