エクスポート¶
POST /api/v1/checker/export
概要¶
モニターおよびその直接の複合メンバーを、移行可能なテンプレート JSON としてエクスポートします。
呼び出し前の確認と使用手順¶
統一 JSON の content.checkers 配列を返します。圧縮ファイル/ファイルダウンロードや非同期タスクではありません。現在のワークスペース内の削除されていない一致対象のみを読み取り、すべて一致しない場合でも空配列で成功する可能性があります。空入力でも空配列で成功します。共有クエリは Rule カテゴリを限定せず、モニター一覧の UUID のみを使用します。複合モニターをエクスポートすると、直接参照しているメンバーも追加で含まれ、signId を使用して複合参照を書き換えます。任意の多層依存関係を再帰的に補完することは保証しません。
エクスポートでは名前を使用してグループ/アラートポリシー/ダッシュボードおよびタグを関連付けます。これらのリソースの完全な設定やカスタム操作権限はエクスポートせず、すべての履歴も保持しません。OuterEventChecker では secret を削除し、インポート後に新しい Webhook を生成します。isNeedCreateIssue が有効でない場合、テンプレートはチャネル/レベル/担当者/タグなどの Issue 関連フィールドをクリアし、また、一部の旧無データ周期プロトコルを変換します。移行前に元の詳細をバックアップし、移行先のデータソース、認可、通知先を確認してください。
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Body リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| checkers[*] | string | 他の Rule リソースタイプを混在させません。メソッド自体は type を追加で限定しません。 例: rul_checker_example取得または入力方法: 現在のワークスペース内の単一モニター UUID。 |
|
| checkers | array | Y | 必須の UUID 配列。空配列でも成功し content.checkers=[] を返します。削除されていない一致項目のみをエクスポートします。 null を許可: False 例: ["rul_checker_example"]取得または入力方法: モニター一覧からエンティティ type ごとに本ワークスペースの UUID を選択します。 |
パラメータ補足説明¶
関連インターフェース:1 つまたは複数のモニターをインポート
モニターインポートインターフェースの checkers パラメータは、モニターのエクスポート成功時に返される content.checkers の内容そのものです。
OuterEventChecker のエクスポートでは subUri/isChangeEvent を保持し、再利用可能な secret はエクスポートしません。
リクエスト例¶
curl --request POST 'https://openapi.guance.com/api/v1/checker/export' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json' \
--data-raw '{"checkers":["rul_checker_example"]}'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。
| フィールド | 型 | 説明 |
|---|---|---|
| content.checkers | array<object> |
エクスポートテンプレート配列。 |
| content.checkers[].type | string | trigger/smartMonitor/aiMonitor。今回の import のトップレベル type と一致する場合のみ実際にインポートされます。replace は旧オブジェクトの正規化カテゴリと一致する必要があります。 |
| content.checkers[].signId | string | エクスポート時は元 UUID のダイジェストとして出力され、認証情報ではありません。インポート時は UUID の事前割り当ておよび複合メンバー参照の書き換えに使用され、同一バッチ内で一意である必要があり、ファイルをまたいで自己再利用しないでください。replace ではこれによって対象 UUID を変更しません。 |
| content.checkers[].jsonScript | json | 完全な定義。セマンティクスおよび任意フィールドは本ページの展開と同じです。インポートは通常の add Body ではなく、その完全なネスト宣言の検証を経ません。誤った形状は 500 になる可能性があります。V2 の完全な yamlConfig は有効である必要があり、インポート前にすべての候補を同期的に検証する場合があります。 |
| content.checkers[].extend | json | 省略時/旧テンプレートでは {} を推奨し、null は提供しません。インポートは完全な定義に従って保存されます。replace で省略して {} にすると旧拡張を上書きし、保持はしません。各ネストの意味は下表を参照してください。 |
| content.checkers[].is_disable | boolean | 任意でデフォルトは有効です。テンプレートプロトコルのアンダースコア付き is_disable を保持し、isDisable ではありません。replace で省略すると旧無効化ルールが有効になります。 |
| content.checkers[].tagInfo | array | 任意でデフォルトは [] です。name に従ってタグを作成または再利用します。トップレベルの tags はテンプレートインポートでは同等の役割を果たしません。replace で省略すると旧タグ関連付けがクリアされます。 |
| content.checkers[].tagInfo[] | json | name のみが必要で、ソースタグ UUID を移行先ワークスペースの識別子として使用しません。 |
| content.checkers[].tagInfo[].name | string | エクスポートされたタグ名。移行前に移行先ワークスペースでスコープを確認してください。 |
| content.checkers[].secret | string | インポートではソースの secret を継承しません。OuterEventChecker のエクスポートではこのフィールドを削除し、インポート時に新しい secret を生成するため、移行後に Webhook を再取得する必要があります。replace で省略/空文字列の場合は元の secret を保持し、空でない値で置き換える場合はグローバルに一意である必要があります。 |
| content.checkers[].monitorName | string | 任意でデフォルトは default です。空の場合も default として扱います。存在しない場合は新しいグループを作成する可能性があります。monitorUUID ではありません。replace で省略すると default に切り替わり、旧グループは保持されません。 |
| content.checkers[].alertPolicyNames | array | 任意でデフォルトは [] です。存在しない名前はポリシー定義を作成します。通知先/ルールがソースポリシーと一緒に移行されるとは想定できません。replace で省略すると旧ポリシー参照がクリアされます。 |
| content.checkers[].alertPolicyNames[] | string | UUID ではありません。インポート後に実際のアラート対象設定を確認してください。 |
| content.checkers[].dashboardName | string | 任意。name のみに基づいて既存の node ダッシュボードを解決し、ダッシュボードは自動インポートしません。一致しない場合は関連付けを作成しません。replace で省略/不一致の場合は旧ダッシュボード参照が削除されます。 |
| content.checkers[].jsonScript.atAccounts | array | 任意の配列でデフォルトは [] です。channels はインシデントの関連付けに使用され、直接の通知先ではありません。サーバー側でデフォルトチャネルを補完したり、無効なチャネルをフィルタしたりする場合があります。@外部メールアドレスは無料/体験版で制限されます。保存は通知送信済みを意味しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.atNoDataAccounts | array | 任意の配列でデフォルトは [] です。channels はインシデントの関連付けに使用され、直接の通知先ではありません。サーバー側でデフォルトチャネルを補完したり、無効なチャネルをフィルタしたりする場合があります。@外部メールアドレスは無料/体験版で制限されます。保存は通知送信済みを意味しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.channels | array | 任意の配列でデフォルトは [] です。channels はインシデントの関連付けに使用され、直接の通知先ではありません。サーバー側でデフォルトチャネルを補完したり、無効なチャネルをフィルタしたりする場合があります。@外部メールアドレスは無料/体験版で制限されます。保存は通知送信済みを意味しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkFuncs | array | 任意。通常のしきい値では指定不要です。seniorCheck では先頭項目の funcId/kwargs に従って使用し、すべての関数を汎用パラメータとして扱いません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt | json | 通常ルールでは rules をよく使用します。高度なタイプは対応するアルゴリズムに従って入力し、V2 では yamlConfig、AI セマンティクスでは userPrompt などを使用します。宣言されていないサブフィールドは公開検証で拒否されるため、内部 SDK のパラメータ全体をそのまま流用できません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.category | string | AI セマンティクス専用。AI セマンティクスの分類メタ情報で、任意の文字列です。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.combineExpr | string | タイプ専用パラメータ。複合メンバーの alias 式で、複合タイプでは空でないことが必須です。Result をメンバー alias の代わりにしません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.confidenceInterval | integer | タイプ専用パラメータ。レンジ V2 の信頼区間 1..100。実際のアルゴリズム設定に従います。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.contextWindowLimit | integer | AI セマンティクス専用。正の整数の Token コンテキスト制限で、≥1 です。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.creditSoftBudget | number | AI セマンティクス専用。1 回あたりの Credit ソフトバジェットで、有限の数値 >0 です。API 実行タイムアウトではありません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.diffMode | string | タイプ専用パラメータ。高度な変化の value は差分値、percent は百分比で、明示的に指定する必要があります。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.direction | string | タイプ専用パラメータ。高度な変化/レンジの up/down/both で、明示的に指定する必要があります。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.disableLargeScaleEventProtect | boolean | 任意の真偽値。true で大規模イベント保護を無効化し、デフォルト false では保護を維持します。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.enableStreamingAggregation | boolean または null | 任意の三状態。サポート対象タイプのストリーミング集約高速化のみを制御し、モニターの有効/停止や DQL の意味の変更ではありません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.eps | float | タイプ専用パラメータ。外れ値では必須で、数値 0..3.0 です。このアルゴリズムでは通常の rules 条件検証を使用しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.ignoreNodata | boolean | 任意の真偽値。複合モニターのみ true で無データを無視し、デフォルトは false です。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.infoEvent | boolean | 任意の真偽値。true では継続的に正常な場合に info を生成し、デフォルトは false です。infoEventCondition はタイプに応じて条件を制御します。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.infoEventCondition | json | 任意。{} は無条件 Info を表します。通常のしきい値/ログ/アプリケーションとアクセス指標/可用性/プロセス/ネットワーク/変化/レンジなどのサポートタイプにのみ適用されます。外れ値/複合/生存 V2/変更/プログラマブル/インテリジェント/SLO はサポートされず、指定すると UnsupportTriggerFields が返されます。空でない場合は alias/operator/operands が完全かつ有効である必要があります。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.infoEventCondition.alias | string | 空でない Info 条件内で構造に従って入力します。targets の alias に対応します。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.infoEventCondition.operands | array | 空でない Info 条件内で構造に従って入力します。比較値の配列で、要素は文字列/数値であり、オブジェクトは指定しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.infoEventCondition.operator | string | 空でない Info 条件内で構造に従って入力します。本ページの通常条件演算子から選択します。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.maxChatRounds | integer | AI セマンティクス専用。最大会話ラウンド数で、整数 ≥1 です。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.maxDQLQueries | integer | AI セマンティクス専用。DQL 呼び出し回数の上限で、整数 ≥0 です。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.mentions | array | AI セマンティクスでは任意で、デフォルトは [] です。各項目は type=dql、空でない namespace/datasource を持ち、index は任意で指定する場合は空でない値にします。正規化 JSON シリアライズの総長は ≤20000 文字です。データクエリの認可を代替しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.mentions[] | object | type/namespace/datasource は必須で、index は任意です。4 つのフィールドのみを宣言します。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.mentions[].datasource | string | 参照項目内の実際のデータソース名(例:ログ source/メジャーメント)。名前空間に従って解釈されます。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.mentions[].index | string | 参照項目内のログ参照では実際のインデックス名/識別子を入力し、その他のタイプでは省略できます。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.mentions[].namespace | string | 参照項目内の実際の DQL 名前空間で、エンティティ type ではありません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.mentions[].type | string | 参照項目内では固定で dql です。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.model | string | AI セマンティクス専用。AI セマンティクスの任意のモデル名で、サイトがサポートするモデル設定から取得する必要があり、ドキュメント例のリテラル値は使用できません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.openMatchTimes | boolean | 任意の真偽値。true で連続トリガー一致を有効化し、デフォルトは false です。rules[].matchTimes と組み合わせます。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.openOkConditions | boolean | 任意の真偽値。true で段階的復旧を有効化し、デフォルトは false です。okConditions はトリガーと復旧の境界を満たす必要があります。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.rules | array | 通常ルール条件の配列です。各項目は status/conditionLogic/conditions を持ち、復旧には okConditions を使用します。誤ったメンバー/演算形状は通常の例外をスローして最終的に 500 になる可能性があり、一律に 406 にはなりません。空の operands を持つ条件はスケジューリング構築前にフィルタされ、「すべて」を表すために使用しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.script | string | タイプ専用パラメータ。プログラマブル検出スクリプトのテキストで、そのタイプがサポートする構文を使用します。この API はスクリプトテストを 1 回実行しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.systemPrompt | string | AI セマンティクス専用。AI セマンティクスでは任意で、指定する場合は空でなく、Python 文字数 ≤20000 です。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.threshold | json | 任意のオブジェクト。指定する場合、status/operator/value はすべて必須として宣言されます。status=false で前提判断を無効化し、value は null を許可しますが、アルゴリズムの実際の意味に従って入力する必要があります。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.threshold.operator | string | 親オブジェクトが存在する場合に必須。前提比較演算子(例:>)で、実際の高度な検出の互換セットに従います。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.threshold.status | boolean | 親オブジェクトが存在する場合に必須。前提条件を有効にするかどうか。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.threshold.value | float または null | 親オブジェクトが存在する場合に必須。前提数値で、status=false では null を許可し、status=true では数値でなければならず、そうでない場合は IllegalMutationParameters になります。単位はクエリ結果と一致させます。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.userPrompt | string | AI セマンティクス専用。AI セマンティクス条件では空でないことが必須で、Python 文字数 ≤20000 です。空文字列を宣言できますが、業務上は空白を受け付けません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.checkerOpt.yamlConfig | string | V2 のみで必須。空でない UTF8 YAML テキスト ≤256KiB で、JSON オブジェクトや Markdown フェンスではありません。構造は本ページの YAML 表を参照してください。アンカー/エイリアス/明示的タグ/重複キーは禁止です。変更は既存の DQL、threshold 設定およびアルゴリズム params のみ許可され、ルール集合/名前/実行構造は変更できません。保存時にプロトコル/バジェットを検証し、チェッククエリのデータドメイン権限を解析しますが、DQL を実行したり、データの存在/ソース認可が完全に確認済みであることを保証したりはしません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.customCrontab | string | 任意。空でない場合は every より優先されます。5 段または秒付き 6 段をサポートし、秒のステップ形式は 20 未満にできません。複合モニターおよび複合メンバーにはカスタム頻度の競合制限があります。V2 では禁止です。検出タイムゾーンは現在のワークスペース/サービス設定に依存し、文字列内のタイムゾーン名でフィールドを代替しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.delaySeconds | integer | 任意。通常モニターのデータ待機ウィンドウで、単位は秒、0 は待機なし、省略時は 0 です。真偽値を整数として扱いません。インテリジェント/AI は通常の待機設定を使用せず、これでインテリジェント実行の遅延を調整できません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.disableCheckEndTime | boolean | 任意の互換真偽値で、デフォルトは false です。実際のサポートは検出タイプに依存します。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.eventChartEnable | boolean | 任意でデフォルトは false です。サポートされている Doris ログ主ストレージの処理にのみ適用されます。保存成功はチャート生成済みを証明しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.eventCharts | array | 任意のチャート設定配列で、イベントチャートを有効にするときに一緒に指定します。具体的な結果はイベント処理チェーンによって生成され、書き込みレスポンスでは返されません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.eventCharts[] | object | 宣言には dql サブフィールドのみを含みます。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.eventCharts[].dql | string | 任意のクエリテキストで、チャート UUID ではありません。保存してもチャートクエリは実行されません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.every | string | 通常の共通プラグインでは every または customCrontab が必要です。最大 24h、最小 20s を推奨します。有効な正の整数形式を使用し、0/負の値や d/w は使用できません。一部の形式問題は 500 になる可能性があります。V2 は固定で 10m で、サーバー側が every を上書きします。AI セマンティクスは自身の検出頻度に従います。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.groupBy | array | 任意のディメンション名配列で、通常 [] は追加ディメンションでグループ化しないことを表します。タグ値ではありません。複合モニターメンバーのディメンションは互換性が必要です。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.interval | integer | 通常、targets がある場合は 1..2592000 秒(30 日)が要求されます。every の検出頻度とは異なります。複合モニターはこの共通チェックをスキップし、V2 では YAML query.interval/lookback を使用します。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.isChangeEvent | boolean | OuterEventChecker では任意でデフォルトは false です。その他のタイプでは使用しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.message | string | event 内容。対応するチェックタイプに応じて任意入力です。変更時に省略を保持とみなすことはできず、設定全体を埋め戻す必要があります。 任意で、省略時は独立したテキストを提供しません。現在の共通構造では title/message と無データテキストが主なソースであり、旧 recover 専用フィールドが各検出を個別にカバーすることを保証しません。message およびサポート対象タイプの noDataMessage は先に Jinja 構文解析を行い、未知の変数の実行値は検証しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.noDataAction | string | 任意。none/checkAs0/noDataEvent/noDataEventRepeat/fatalEvent/criticalEvent/errorEvent/warningEvent/okEvent/noData/recover。noDataEventRepeat は適用可能なタイプのみサポートし、正の整数の noDataInterval が必要です。省略/空の互換値と正の継続時間には専用の履歴処理があり、デフォルト実装に依存して繰り返しアラートを実現しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.noDataInterval | integer | タイプに応じて任意入力。無データ継続時間の秒数です。通常の頻度では検出周期全体に切り上げられ、カスタム頻度では直接秒になります。repeat の無データでは正の整数が必須です。 変更時は適用設定を完全に保持し、単位を混在させないでください。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.noDataMessage | string | 無データイベント情報テンプレートを出力。対応するチェックタイプに応じて任意入力です。変更時に省略を保持とみなすことはできず、設定全体を埋め戻す必要があります。 任意で、省略時は独立したテキストを提供しません。現在の共通構造では title/message と無データテキストが主なソースであり、旧 recover 専用フィールドが各検出を個別にカバーすることを保証しません。message およびサポート対象タイプの noDataMessage は先に Jinja 構文解析を行い、未知の変数の実行値は検証しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.noDataNotificationMessage | string | データ欠落イベントの通知内容。対応するチェックタイプに応じて任意入力です。変更時に省略を保持とみなすことはできず、設定全体を埋め戻す必要があります。 任意で、省略時は独立したテキストを提供しません。現在の共通構造では title/message と無データテキストが主なソースであり、旧 recover 専用フィールドが各検出を個別にカバーすることを保証しません。message およびサポート対象タイプの noDataMessage は先に Jinja 構文解析を行い、未知の変数の実行値は検証しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.noDataRecoverMessage | string | 無データ復旧アップロードイベント情報テンプレートを出力。対応するチェックタイプに応じて任意入力です。変更時に省略を保持とみなすことはできず、設定全体を埋め戻す必要があります。 任意で、省略時は独立したテキストを提供しません。現在の共通構造では title/message と無データテキストが主なソースであり、旧 recover 専用フィールドが各検出を個別にカバーすることを保証しません。message およびサポート対象タイプの noDataMessage は先に Jinja 構文解析を行い、未知の変数の実行値は検証しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.noDataRecoverTitle | string | 無データ復旧アップロードイベントタイトルテンプレートを出力。対応するチェックタイプに応じて任意入力です。変更時に省略を保持とみなすことはできず、設定全体を埋め戻す必要があります。 任意で、省略時は独立したテキストを提供しません。現在の共通構造では title/message と無データテキストが主なソースであり、旧 recover 専用フィールドが各検出を個別にカバーすることを保証しません。message およびサポート対象タイプの noDataMessage は先に Jinja 構文解析を行い、未知の変数の実行値は検証しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.noDataTitle | string | 無データイベントタイトルテンプレートを出力。対応するチェックタイプに応じて任意入力です。変更時に省略を保持とみなすことはできず、設定全体を埋め戻す必要があります。 任意で、省略時は独立したテキストを提供しません。現在の共通構造では title/message と無データテキストが主なソースであり、旧 recover 専用フィールドが各検出を個別にカバーすることを保証しません。message およびサポート対象タイプの noDataMessage は先に Jinja 構文解析を行い、未知の変数の実行値は検証しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.notificationMessage | string | イベント通知内容。対応するチェックタイプに応じて任意入力です。変更時に省略を保持とみなすことはできず、設定全体を埋め戻す必要があります。 任意で、省略時は独立したテキストを提供しません。現在の共通構造では title/message と無データテキストが主なソースであり、旧 recover 専用フィールドが各検出を個別にカバーすることを保証しません。message およびサポート対象タイプの noDataMessage は先に Jinja 構文解析を行い、未知の変数の実行値は検証しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.openNoDataNotificationMessage | boolean | 任意でデフォルトは false です。無効時は対応するイベント内容を使用し、有効時は対応する notificationMessage/noDataNotificationMessage も提供します。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.openNotificationMessage | boolean | 任意でデフォルトは false です。無効時は対応するイベント内容を使用し、有効時は対応する notificationMessage/noDataNotificationMessage も提供します。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.periodBefore | integer | タイプに応じて任意入力。高度な変化の比較オフセット秒数(例:前日 86400)です。range/range_2 と一緒に完全に入力します。 変更時は適用設定を完全に保持し、単位を混在させないでください。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.range | integer | タイプに応じて任意入力。高度な変化の現在の比較ウィンドウで、正の整数秒です。 変更時は適用設定を完全に保持し、単位を混在させないでください。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.range_2 | integer | タイプに応じて任意入力。高度な変化の比較ウィンドウ設定で、-1 は前期比、0 は periodBefore に従い、それ以外は対応する高度な検出定義の秒ウィンドウに従います。 変更時は適用設定を完全に保持し、単位を混在させないでください。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.recoverMessage | string | 復旧イベント情報テンプレートを出力。対応するチェックタイプに応じて任意入力です。変更時に省略を保持とみなすことはできず、設定全体を埋め戻す必要があります。 任意で、省略時は独立したテキストを提供しません。現在の共通構造では title/message と無データテキストが主なソースであり、旧 recover 専用フィールドが各検出を個別にカバーすることを保証しません。message およびサポート対象タイプの noDataMessage は先に Jinja 構文解析を行い、未知の変数の実行値は検証しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.recoverNeedPeriodCount | integer | タイプに応じて任意入力。通常の頻度では連続復旧周期数です。customCrontab では直接秒単位の復旧時間で、省略時は 0 です。 変更時は適用設定を完全に保持し、単位を混在させないでください。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.recoverTitle | string | 復旧イベントタイトルテンプレートを出力。対応するチェックタイプに応じて任意入力です。変更時に省略を保持とみなすことはできず、設定全体を埋め戻す必要があります。 任意で、省略時は独立したテキストを提供しません。現在の共通構造では title/message と無データテキストが主なソースであり、旧 recover 専用フィールドが各検出を個別にカバーすることを保証しません。message およびサポート対象タイプの noDataMessage は先に Jinja 構文解析を行い、未知の変数の実行値は検証しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.subUri | string | OuterEventChecker で追加された必須の空でない文字列です。公開受信 URL は単一のパスセグメントで、/ を含めることはできません(%2F にエンコードしても 404 になります)。英数字とハイフンを推奨します。複数のルールが同じサフィックスを使用でき、一意性は secret が担います。通常の検出では入力しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.targetWorkspaceUUID | string | 任意で、デフォルトは本ワークスペースです。simpleCheck、seniorMutationsCheck、seniorRangeCheck、seniorRangeV2Check、outlierCheck のクロスワークスペースクエリ消費に適用されます。書き込みは候補 index_list を生成し、呼び出し元の身元のデータドメイン権限を検証するだけであり、保存成功はソース認可が完全に確認済み、またはデータが照会可能であることを意味しません。呼び出し前に実際の対象認可を確認する必要があります。V2 では禁止で、認可済みワークスペース内の YAML クエリを使用します。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.targets | array | 通常のクエリ対象配列で、DQL/PromQL の実際の実行文は dql に置きます。通常の共通プラグインの alias は Result または空のみを受け付け、別名の一意性をチェックします。単一対象の Result を推奨します。複合モニターでは monitorCheckerId/alias でメンバーを関連付けます。V2 では targets が禁止され、すべて YAML に置きます。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.title | string | 必須の文字列で、空でないことを推奨します。最大 256 で、ASCII/半角カタカナは 1、その他の文字は 2 としてカウントします。空でない値はルールの name にコピーされ、重複名チェックの対象になります。通常/セルフホストインスペクションは重複名グループを共有し、インテリジェント/AI はそれぞれ別グループです。テンプレート実行時に変数が存在するかは実際のイベントで受け入れる必要があります。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.type | string | 必須のプラグイン識別子。mutationsCheck/rangeCheck/seniorCheck や旧 smart* などの履歴互換は引き続き元の設定に従って維持する必要があり、エンティティ type で代替しません。具体的なフィールドはそのタイプにのみ適用され、混在できません。V2 と旧版は相互に切り替えできません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.windowDql | string | 任意の互換ウィンドウクエリテキストで、イベントの追加資料として透過的に渡され、targets 内の実際の検出クエリを代替しません。省略時は提供しません。 これは保存済みの設定です。実際に有効になるかはチェックタイプに応じて判断する必要があります。書き込みについてはモニターの作成を参照してください。 |
| content.checkers[].jsonScript.targets[] | object | 単一の DQL/PromQL クエリ対象、または複合モニターメンバー。 |
| content.checkers[].jsonScript.targets[].dql | string | 実際に実行されるクエリで、qtype が構文を決定します。 |
| content.checkers[].jsonScript.targets[].qtype | string | 通常は dql/promql で、履歴では queryType で表される場合があります。 |
| content.checkers[].jsonScript.targets[].queryType | string | 履歴のクエリ構文マーカー。 |
| content.checkers[].jsonScript.targets[].alias | string | 通常の共通プラグインでは通常 Result が要求されます。複合モニターではメンバーの alias に従います。 |
| content.checkers[].jsonScript.targets[].monitorCheckerId | string | 複合モニターのみでメンバー UUID を関連付けます。 |
| content.checkers[].jsonScript.targets[].groupBy | array<string> |
複合メンバーの追加トリガーディメンション。 |
| content.checkers[].jsonScript.targets[].groupBy[] | string | フィールド名。 |
| content.checkers[].jsonScript.targetWorkspaceUUIDs | array<string> |
テンプレートがサポートする複数ソース入力の保存集合で、空でない場合は単数より優先されます。実際に構築された実行ワークスペースは crontabInfo.multiWsCrontabInfo を基準とし、認可失敗により縮小される場合があります。 |
| content.checkers[].jsonScript.targetWorkspaceUUIDs[] | string | 単一の対象ワークスペース UUID。 |
| content.checkers[].jsonScript.targets[].extraOptions | object | 保存時または実行構築時のクエリオプションです。現在の認可を完全に保証するものではなく、一覧のエコーバックをそのまま新しいクエリ認可として扱いません。 |
| content.checkers[].jsonScript.targets[].extraOptions.workspace_uuids | array<string> |
保存済み、または一覧が今回解決した候補実行ワークスペースで、履歴値を含む場合があり、現在すべてが認可済みであることを保証しません。 |
| content.checkers[].jsonScript.targets[].extraOptions.workspace_uuids[] | string | 単一の保存済みまたは候補ワークスペース UUID で、現在の認可を確認する必要があります。 |
| content.checkers[].jsonScript.targets[].extraOptions.index_list | array<object> |
保存済み、または一覧が今回解決したデータドメイン/インデックス候補範囲で、履歴値を含む場合があり、現在の完全な認可保証にはできません。 |
| content.checkers[].jsonScript.targets[].extraOptions.index_list[].workspace_uuid | string | ソースワークスペース UUID。 |
| content.checkers[].jsonScript.targets[].extraOptions.index_list[].namespace | string | クエリ名前空間。 |
| content.checkers[].jsonScript.targets[].extraOptions.index_list[].index_name | string | 許可されるインデックス名で、ログ以外では default の場合があります。 |
| content.checkers[].jsonScript.targets[].extraOptions.index_list[].expr_name | string | 式サブクエリ名で、省略可能です。 |
| content.checkers[].jsonScript.targets[].conditions | object または string | クエリの追加フィルタで、保存構造に従って読み取り、型が統一されているとは想定しません。 |
| content.checkers[].jsonScript.groupBy[] | string | トリガーディメンションフィールド。 |
| content.checkers[].jsonScript.checkFuncs[] | object | 互換検出関数の資料。 |
| content.checkers[].jsonScript.checkFuncs[].funcId | string | 関数 ID。 |
| content.checkers[].jsonScript.checkFuncs[].kwargs | object | 関数固有のパラメータで、すべてのアルゴリズムの共通入力ではありません。 |
| content.checkers[].jsonScript.checkFuncs[].kwargs.参数名 | JSON | 対応する関数ドキュメントに従って解釈します。 |
| content.checkers[].jsonScript.channels[] | string | インシデントチャネル UUID。 |
| content.checkers[].jsonScript.atAccounts[] | string | 通知で @ される身元識別子で、履歴ではメールアドレスの場合があります。 |
| content.checkers[].jsonScript.atNoDataAccounts[] | string | 無データ通知の @ 対象。 |
| content.checkers[].jsonScript.checkerOpt.rules[] | object | レベルごとにトリガーと復旧条件を設定します。 |
| content.checkers[].jsonScript.checkerOpt.rules[].status | string | fatal/critical/error/warning/info/ok/ALL などは検出タイプに応じて解釈されます。 |
| content.checkers[].jsonScript.checkerOpt.rules[].conditionLogic | string | and/or で、複数条件の組み合わせです。 |
| content.checkers[].jsonScript.checkerOpt.rules[].matchTimes | integer | 連続一致回数で、openMatchTimes と組み合わせる必要があります。 |
| content.checkers[].jsonScript.checkerOpt.rules[].conditions | array<object> |
トリガー条件。 |
| content.checkers[].jsonScript.checkerOpt.rules[].okConditions | array<object> |
段階的復旧条件で、省略可能です。 |
| content.checkers[].jsonScript.checkerOpt.rules[].conditions[].alias | string | 対応するクエリ対象の alias。 |
| content.checkers[].jsonScript.checkerOpt.rules[].conditions[].operator | string | 条件演算子で、検出タイプのサポートセットに従います。 |
| content.checkers[].jsonScript.checkerOpt.rules[].conditions[].operands | array | 比較値の配列で、数値/文字列の型を保持します。 |
| content.checkers[].jsonScript.checkerOpt.rules[].conditions[].operands[] | string / number | 単一の比較値。 |
| content.checkers[].jsonScript.checkerOpt.rules[].okConditions[].alias | string | 対応するクエリ対象の alias。 |
| content.checkers[].jsonScript.checkerOpt.rules[].okConditions[].operator | string | 条件演算子で、検出タイプのサポートセットに従います。 |
| content.checkers[].jsonScript.checkerOpt.rules[].okConditions[].operands | array | 比較値の配列で、数値/文字列の型を保持します。 |
| content.checkers[].jsonScript.checkerOpt.rules[].okConditions[].operands[] | string / number | 単一の比較値。 |
| content.checkers[].jsonScript.name | string | 互換名。空でない title はコピー/上書きされ、title がない場合はインポート名のフォールバックに使用されます。 |
| content.checkers[].jsonScript.fixedCrontab | string | 保持される互換固定 Cron。実際の実行は crontabInfo を基準とし、every/customCrontab と競合させないでください。 |
| content.checkers[].extend.isNeedCreateIssue | boolean | 異常に基づいて Issue を作成するかどうか。 |
| content.checkers[].extend.issueLevelUUID | string | 履歴の Issue レベル識別子で、無効になっている場合があります。 |
| content.checkers[].extend.issueDfStatus | array<string> |
Issue をトリガーする異常状態。 |
| content.checkers[].extend.issueDfStatus[] | string | fatal/critical/error/warning/nodata。 |
| content.checkers[].extend.manager | array<string> |
解決済みの担当者対象。 |
| content.checkers[].extend.manager[] | string | メンバー/チームなどの対象識別子。 |
| content.checkers[].extend.incidentsTags | array<string> |
異常に関連付けるタグ名。 |
| content.checkers[].extend.incidentsTags[] | string | 単一のタグ名。 |
| content.checkers[].extend.faultMappingMode | string | custom/existing。現在のインシデントレベルマッピング方式。 |
| content.checkers[].extend.levelMappingUUID | string | existing 時のレベルマッピング UUID。 |
| content.checkers[].extend.bindIncidentsInfo | array<object> |
カスタムレベルマッピング行。 |
| content.checkers[].extend.bindIncidentsInfo[].incidentsLevelUUID | string | マッピングされた Issue レベル UUID。 |
| content.checkers[].extend.bindIncidentsInfo[].incidentsDfStatus | array<string> |
マッピングされた異常状態配列。 |
| content.checkers[].extend.bindIncidentsInfo[].incidentsDfStatus[] | string | 単一の異常状態。 |
| content.checkers[].extend.smartMonitor | object | V2 のソースと現在のバージョンメタ情報。 |
| content.checkers[].extend.smartMonitor.source | string | ai/builtin のソース。 |
| content.checkers[].extend.smartMonitor.engineVersion | integer | V2 では通常 2 です。 |
| content.checkers[].extend.smartMonitor.configVersion | integer | V2 設定バージョン。 |
| content.checkers[].extend.smartMonitor.category | string | インテリジェントモニタリングの分類。 |
| content.checkers[].extend.smartMonitor.prompt | string | AI 生成プロンプト。 |
| content.checkers[].extend.smartMonitor.templateId | string | 組み込みテンプレート識別子。 |
| content.checkers[].extend.smartMonitor.templateVersion | string | 組み込みテンプレートバージョン。 |
| content.checkers[].extend.smartMonitor.generationRunId | string | 生成プロセスの追跡識別子で、省略可能です。 |
| content.declaration | object | 共通宣言。インポートでは checkers のみを取得します。 |
{
"code": 200,
"content": {
"checkers": [
{
"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": [
"生产告警"
]
}
],
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。
| HTTP ステータス | errorCode | トリガー条件 | メッセージまたはレスポンス説明 | 処理方式 |
|---|---|---|---|---|
| 406 | ft.ParameterValidationFailed | リクエストフィールドの欠落、またはフィールド値が宣言された検証条件に違反 | パラメータ解析失敗 | パラメータの位置、フィールド名、型、値を確認してください。 |
| 400 | ft.RequestJsonFormatError | リクエスト JSON の構文が無効 | リクエスト JSON の形式エラー | content.reason、line、column に従って JSON を修正してください。 |
| 400 | ft.JsonFormatError | Body のトップレベルが JSON オブジェクトではありません | 一部の json ファイル形式エラー | 例に従って checkers 配列を含むオブジェクトを送信してください。 |
| 500 | ft.InternalServerError | JSON の保存/複合参照/旧周期データまたは関連資料の読み取り・フォーマットに失敗 | 内部エラー | まず単一 UUID でエクスポート範囲を絞り、元の設定を確認してください。継続的に失敗する場合は traceId を提供してください。 |