取得¶
GET /api/v1/checker/{rule_uuid}/get
概要¶
モニターの完全な設定、関連リソース、および互換性のある履歴スナップショットを読み取ります。
呼び出し前の確認と使用手順¶
パスには、対応する type 一覧から取得した現在のワークスペースのルール UUID を使用する必要があります。この共有読み取り自体は Rule.type を限定しないため、同じ rul_ プレフィックスでオブジェクト種別を推測しないでください。デフォルトでは現在の設定を読み取り、互換性のための Query は下表を参照してください。旧 ruleHistory に利用可能な履歴がない場合は content={} を正常に返しますが、これは現在のルールが存在しないことを意味しません。
この route は YAML に Query 宣言がありませんが、実際には request.args を透過的に渡し、ruleHistory/targetWorkspaceUUID/targetRegion を処理します。ここでは完全な呼び出しチェーンで確認済みの互換フィールドのみを列挙しており、これを根拠に他の controller パラメータがすべて公開インターフェースから利用できると推測することはできません。ワークスペース間/サイト間では、すでに有効な認可が存在している必要があります。本インターフェースは認可を作成せず、ソースルールを変更しません。リモート側が認可失効系のエラーで拒否した場合、ローカル mirror の認可失効を非同期でマークし、読み取りによってローカルの認可状態が更新されることもあります。ソースの認可を確認してから復旧してください。現在または履歴として保存された設定を返しますが、関連/アイデンティティ/レベル/チャンネル情報は現在のリソースで補完される場合があり、当時のすべての関連リソースの完全な履歴スナップショットではありません。読み取りはモニタリングや通知を実行しません。OpenAPI は Front 固有の df_event_id を渡さないため、alreadyFeedback は返しません。Manage が別途補う managerInfos も、本エントリの固定フィールドではありません。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| rule_uuid | string | Y | ルール UUID。グループ UUID、名前、履歴 UUID、数値バージョンではありません。 例: rul_checker_example取得または入力方法: モニター一覧 の content.data[].uuid から取得します。 |
リクエストヘッダー¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| DF-API-KEY | string | Y | ワークスペースの OpenAPI 認証情報。 例: <DF-API-KEY>取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。 |
Query リクエストパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| ruleHistory | integer | 任意の文字列整数 0/1。非ゼロ整数は履歴分岐に入り、履歴バージョン番号ではありません。履歴がない場合は正常に {} を返します。不正な整数形式は現在 500 になります。V2 の完全な複数バージョンはインテリジェントモニタリング履歴を使用してください。 例: 0取得または入力方法: 現在の設定を読み取る場合は 0 または省略。互換性のため直近の非削除履歴を読み取る場合は 1。 |
|
| targetWorkspaceUUID | string | 任意。省略時は現在のワークスペース。認可済みのソースワークスペースのルールを読み取る必要がある場合に指定し、rule_uuid はそのソースに属している必要があります。本 API Key のワークスペースを変更するものではありません。カンマ区切りの集合で単一 UUID を置き換えることはできません。 例: wksp_source_example取得または入力方法: 有効なワークスペース間認可レコードから、単一の対象ソースワークスペース UUID を取得します。 |
|
| targetRegion | string | 任意。targetWorkspaceUUID と併用する場合のみ使用し、省略時は認可関係から解決されます。対象ワークスペースを指定しない場合はクロスサイト読み取りを有効にしません。異なるサイトはソースサービスへ転送される場合があります。サンプルコードを実際のサイトとして扱わないでください。 例: example-region取得または入力方法: 対象ソースワークスペースの実際のサイトおよび有効な認可レコードから確認します。 |
リクエスト例¶
curl --get 'https://openapi.guance.com/api/v1/checker/rul_checker_example/get' \
-H 'DF-API-KEY: <DF-API-KEY>'
レスポンス¶
HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示します。
| フィールド | 型 | 説明 |
|---|---|---|
| content.id | integer | 現在のレコード番号。履歴分岐の場合は履歴レコード番号。 |
| content.uuid | string | 現在の rul_ UUID。ruleHistory=1 で履歴レコードがある場合は ruleh_ 履歴 UUID。以降の変更でもリクエストされた現在の UUID を使用します。 |
| content.ruleUUID | string | 履歴分岐のみ。所属する現在のモニター UUID。 |
| content.workspaceUUID | string | オブジェクトが属するワークスペース。 |
| content.monitorUUID | string | 関連する監視グループ UUID。 |
| content.type | string | エンティティ種別。通常は trigger/smartMonitor/aiMonitor で、jsonScript.type のチェックアルゴリズムとは異なります。 |
| content.refKey | string | 互換性のための業務関連キー。通常は空文字列。 |
| content.secret | string または null | 外部イベント Webhook 識別子などの共有フィールド。一般の API Key として扱わないでください。機密の実値をログに書き込まないでください。 |
| content.jsonScript | object | 保存された検出設定。jsonScript.type およびバージョンに従って解釈します。読み取りは検出を実行しません。 |
| content.crontabInfo | object | スケジュール設定。フィールドは単一/複数ワークスペースおよびアルゴリズムによって変化し、{} の場合があります。 |
| content.crontabInfo.id | string | メインスケジュール設定 ID。省略可能。 |
| content.crontabInfo.crontab | string または null | 実際に実行される Cron。明示的な null または省略(Cron の組み合わせがない複合モニターなど)の場合があります。入力 every とは異なります。 |
| content.crontabInfo.smartRelId | string | 一部のインテリジェントモニタリング付属スケジュール ID。省略可能。 |
| content.crontabInfo.multiWsCrontabInfo | array<object> |
ワークスペース間の各スケジュール情報。履歴に存在する場合があり、省略可能。 |
| content.crontabInfo.multiWsCrontabInfo[].ws_uuid | string | 対象ワークスペース UUID。 |
| content.crontabInfo.multiWsCrontabInfo[].id | string | そのワークスペースのスケジュール ID。 |
| content.crontabInfo.multiWsCrontabInfo[].crontab | string または null | そのワークスペースの実際の Cron。明示的な null または省略の場合があります。 |
| content.extend | object | 追加の表示/インシデント関連設定。履歴のカスタムフィールドを含む場合があります。全体をそのまま盲目的に返して変更しないでください。 |
| content.extend.自定义字段 | JSON | 履歴またはタイプ固有の保存値。現在のタイプ詳細および作成インターフェースの公開構造に準拠します。 |
| content.createdWay | string | manual/import/template または履歴の空値。 |
| content.isLocked | integer または boolean | ロック状態。履歴分岐では省略される場合があります。 |
| content.openPermissionSet | boolean | カスタム操作権限スイッチ。読み取り成功だけで変更可能と判断しないでください。 |
| content.permissionSet | array<string> |
カスタム操作プリンシパル UUID。 |
| content.permissionSet[] | string | アカウント/チーム/ロール識別子。 |
| content.status | integer | 0 有効、2 無効。削除以外のクエリでは他の履歴ステータスを含む場合があります。最新の実行結果を表すものではありません。 |
| content.creator | string | 作成アイデンティティ。 |
| content.updator | string | 更新アイデンティティ。 |
| content.createAt | integer | 作成 Unix 秒。 |
| content.updateAt | integer | 更新 Unix 秒。未更新は -1。 |
| content.deleteAt | integer | 削除 Unix 秒。未削除は -1。 |
| content.configVersion | integer | V2 現在の設定バージョンの追加フィールド。通常のルールでは省略可能。 |
| content.jsonScript.targetWorkspaceUUID | string | 対象ワークスペース。ワークスペース間クエリでは、しきい値検出タイプのみサポートします(2025-08-13 イテレーションで追加)。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.type | string | チェック方法タイプ。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.windowDql | string | window dql。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.title | string | 生成される event のタイトル。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.message | string | event の内容。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.recoverTitle | string | 復旧イベントのタイトルテンプレートを出力。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.recoverMessage | string | 復旧イベント情報テンプレートを出力。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.noDataTitle | string | データなしイベントのタイトルテンプレートを出力。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.noDataMessage | string | データなしイベント情報テンプレートを出力。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.openNotificationMessage | boolean | 有効/無効。イベント通知内容。デフォルトは無効(イベント内容を通知内容として使用)。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.notificationMessage | string | イベント通知内容。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.openNoDataNotificationMessage | boolean | 有効/無効。データ欠落イベント通知内容。デフォルトは無効(データ欠落イベント内容を通知内容として使用)。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.noDataNotificationMessage | string | データ欠落イベント通知内容。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.noDataRecoverTitle | string | データなし復旧アップロードイベントのタイトルテンプレートを出力。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.noDataRecoverMessage | string | データなし復旧アップロードイベント情報テンプレートを出力。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.every | string | チェック頻度。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.customCrontab | string | カスタム検出頻度。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.delaySeconds | integer | 通常モニターのデータ待機ウィンドウ(秒)。0 は待機なし。インテリジェントモニタリングではこの設定をサポートしません。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.interval | integer | クエリ範囲。1 回のクエリの時間範囲の差分。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.range | integer | 高度な検出、変動検出の range パラメータ(秒)。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.range_2 | integer | 高度な検出、変動検出の range_2 パラメータ(秒)。特記事項(-1 は前回比、0 は periodBefore フィールドを使用)。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.periodBefore | integer | 高度な検出、変動検出の(前日/1時間前)パラメータ(秒)。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.recoverNeedPeriodCount | integer | 指定した異常が何チェック周期後に復旧イベントを生成するか。検出頻度がカスタム customCrontab の場合、このフィールドは時間長(秒)を表し、それ以外の場合はチェック頻度の回数を表します。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.noDataInterval | integer | どのくらいの期間データがない場合にデータなしイベントを生成するか。noDataEventRepeat の場合は正の整数秒である必要があります。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.noDataAction | string | データなし処理操作。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkFuncs | array | チェック関数情報リスト。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.groupBy | array | トリガーディメンション。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.targets | array | チェック対象。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt | json | チェック条件設定。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.enableStreamingAggregation | boolean または null | モニタリングのストリーミング集約アクセラレーション。省略または null はワークスペースに従い、true は個別に有効、false は個別に無効。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.yamlConfig | string | V2 の完全なソース YAML テキスト。最大 256KiB。JSON オブジェクトではなく、Markdown フェンスも含みません。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.disableLargeScaleEventProtect | boolean | 大規模イベント保護を無効化するか。デフォルト false。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.script | string | プログラマブルモニターのスクリプト内容。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.rules | array | トリガー条件リスト。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.openOkConditions | boolean | レベル別復旧を有効化。デフォルトは無効 false。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.openMatchTimes | boolean | 連続トリガー判定を有効化。デフォルトは無効 false。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.infoEvent | boolean | 継続的に正常な場合に info イベントを生成するか。デフォルト false。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.infoEventCondition | json | 情報イベントの生成条件。通常ルール検出のしきい値、ログ、アプリケーション/ユーザーアクセス指標、可用性、プロセス、ネットワーク、変動、区間および互換性のある旧タイプをサポートします。外れ値、複合、ライブネス V2、変更、プログラマブル、インテリジェント、SLO はサポートしません。空オブジェクトは無条件生成を表します。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.infoEventCondition.alias | string | 判定対象の別名。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.infoEventCondition.operator | string | 判定演算子。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.infoEventCondition.operands | array | 判定オペランドリスト。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.diffMode | string | 高度な検出の変動検出における差分モード。列挙値 value、percent。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.direction | string | 高度な検出の変動検出、区間検出におけるトリガー条件の方向。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.eps | float | 距離パラメータ。値の範囲: 0 ~ 3.0。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.threshold | json | 変動検出のトリガー前提条件設定。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.threshold.status | boolean | 変動検出のトリガー前提条件を有効にするか。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.threshold.operator | string | 変動検出のトリガー前提条件演算子。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.threshold.value | float または null | 変動検出のトリガー前提条件チェック値。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.combineExpr | string | 複合モニターの組み合わせ方式。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.ignoreNodata | boolean | 複合モニターでデータなし結果を無視するか(true は無視が必要)。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.confidenceInterval | integer | 区間検出 V2 の追加パラメータ。信頼区間の範囲は 1-100。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.category | string | AI モニタリングカテゴリのメタデータ。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.userPrompt | string | AI ユーザープロンプト。指定する場合は空にできず、最大 20000 文字。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.systemPrompt | string | AI システムプロンプト。指定する場合は空にできず、最大 20000 文字。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.mentions | array | DQL 参照リスト。各項目には type=dql、namespace、datasource が必須で、index は任意(ログを選択する場合に入力)。シリアライズ後は最大 20000 文字。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.mentions[] | object | 配列内の単一オブジェクト。下位フィールドに従って解釈します。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.mentions[].type | string | データソースタイプ。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.mentions[].namespace | string | DQL 名前空間。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.mentions[].index | string | DQL インデックス。ログを選択する場合に入力。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.mentions[].datasource | string | DQL データソース。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.model | string | 今回の検出で使用するモデル。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.contextWindowLimit | integer | コンテキストウィンドウの Token 制限。0 より大きい必要があります。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.maxChatRounds | integer | 最大対話ラウンド。1 以上である必要があります。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.maxDQLQueries | integer | 最大 DQL クエリ回数。0 以上である必要があります。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.checkerOpt.creditSoftBudget | number | 1 回の検出における Credit ソフトバジェット。0 より大きい必要があります。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.channels | array | チャンネル UUID リスト。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.atAccounts | array | 正常検出時に @ されるアカウント UUID リスト。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.atNoDataAccounts | array | データなし時に @ されるアカウント UUID リスト。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.subUri | string | OuterEventChecker の Webhook アドレスサフィックス。作成時は必須で、一意である必要はありません。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.isChangeEvent | boolean | OuterEventChecker を変更イベントとして処理するか。デフォルト false。既存ルールで欠落している場合は false として処理。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.disableCheckEndTime | boolean | 終了時間制限を無効化するか。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.eventChartEnable | boolean | イベントチャートを有効化するか。デフォルト無効(メインストレージエンジン logging が doris の場合のみ有効)。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.eventCharts | array | イベントチャートリスト。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.eventCharts[] | object | 配列内の単一オブジェクト。下位フィールドに従って解釈します。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.eventCharts[].dql | string | イベントチャートのクエリ文。これは保存済み設定であり、実際に有効かはチェックタイプと合わせて確認する必要があります。書き込みはモニターを作成を参照してください。 |
| content.jsonScript.targets[] | object | 単一の DQL/PromQL クエリ対象、または複合モニターメンバー。 |
| content.jsonScript.targets[].dql | string | 実際に実行されるクエリ。qtype が構文を決定。 |
| content.jsonScript.targets[].qtype | string | 通常 dql/promql。履歴では queryType で表される場合があります。 |
| content.jsonScript.targets[].queryType | string | 履歴のクエリ構文マーカー。 |
| content.jsonScript.targets[].alias | string | 通常の共通プラグインでは通常 Result が要求されます。複合モニターではメンバー別名に従います。 |
| content.jsonScript.targets[].monitorCheckerId | string | 複合モニター関連メンバー UUID のみ。 |
| content.jsonScript.targets[].groupBy | array<string> |
複合メンバーの追加トリガーディメンション。 |
| content.jsonScript.targets[].groupBy[] | string | フィールド名。 |
| content.jsonScript.targetWorkspaceUUIDs | array<string> |
履歴/その他の入口で保存される対象ワークスペース UUID 集合。公開の追加・変更では宣言されておらず、全体をそのまま返さないでください。 |
| content.jsonScript.targetWorkspaceUUIDs[] | string | 単一の対象ワークスペース UUID。 |
| content.jsonScript.targets[].extraOptions | object | get で保存済み値を返します。list のワークスペース間認可確認で解析結果がある場合はその場で補足されることがあり、結果がない場合も履歴値を保持することがあります。クライアントが書き込めるリクエストや現在の完全な認可の証明として扱わないでください。 |
| content.jsonScript.targets[].extraOptions.workspace_uuids | array<string> |
保存済み、または list で今回解析された候補実行ワークスペース。履歴値を含む場合があり、現在すべてが認可済みであることを保証しません。 |
| content.jsonScript.targets[].extraOptions.workspace_uuids[] | string | 単一の保存済みまたは候補ワークスペース UUID。現在の認可を確認する必要があります。 |
| content.jsonScript.targets[].extraOptions.index_list | array<object> |
保存済み、または list で今回解析されたデータドメイン/インデックス候補範囲。履歴値を含む場合があり、現在の完全な認可を保証するものではありません。 |
| 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.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.creatorInfo | object または string | アイデンティティ概要。一覧で情報がない場合は空文字列、詳細で情報がない場合は {}。 |
| content.creatorInfo.uuid | string | アイデンティティ UUID。省略可能。 |
| content.creatorInfo.status | integer | アカウント/プリンシパルステータス。省略可能。 |
| content.creatorInfo.wsAccountStatus | integer | メンバーステータス。省略可能。 |
| content.creatorInfo.name | string | 表示名。 |
| content.creatorInfo.username | string | ログイン名。省略可能。 |
| content.creatorInfo.email | string | メールアドレスまたはシステムアイデンティティ識別子。 |
| content.creatorInfo.mobile | string | 電話番号。空の場合があります。 |
| content.creatorInfo.countryCode | string | 国/地域コード。省略可能。 |
| content.creatorInfo.iconUrl | string | アバター。省略可能。 |
| content.creatorInfo.acntWsNickname | string | ワークスペースニックネーム。省略可能。 |
| content.updatorInfo | object または string | アイデンティティ概要。一覧で情報がない場合は空文字列、詳細で情報がない場合は {}。 |
| content.updatorInfo.uuid | string | アイデンティティ UUID。省略可能。 |
| content.updatorInfo.status | integer | アカウント/プリンシパルステータス。省略可能。 |
| content.updatorInfo.wsAccountStatus | integer | メンバーステータス。省略可能。 |
| content.updatorInfo.name | string | 表示名。 |
| content.updatorInfo.username | string | ログイン名。省略可能。 |
| content.updatorInfo.email | string | メールアドレスまたはシステムアイデンティティ識別子。 |
| content.updatorInfo.mobile | string | 電話番号。空の場合があります。 |
| content.updatorInfo.countryCode | string | 国/地域コード。省略可能。 |
| content.updatorInfo.iconUrl | string | アバター。省略可能。 |
| content.updatorInfo.acntWsNickname | string | ワークスペースニックネーム。省略可能。 |
| content.allow_operation | boolean または null | 現在の呼び出しアイデンティティの操作表示値。引き続きインターフェース権限と業務検証が必要で、未設定時は null の場合があります。 |
| content.permissionSetInfo | object | permissionSet が空でない場合に識別子→情報のマッピングを提供。一致するプリンシパルがない場合は {}。 |
| content.permissionSetInfo.主体 | object | アカウントの完全なアイデンティティ、またはロール/チーム {name,status}。 |
| content.permissionSetInfo.主体.uuid | string | アイデンティティ UUID。省略可能。 |
| content.permissionSetInfo.主体.status | integer | アカウント/プリンシパルステータス。省略可能。 |
| content.permissionSetInfo.主体.wsAccountStatus | integer | メンバーステータス。省略可能。 |
| content.permissionSetInfo.主体.name | string | 表示名。 |
| content.permissionSetInfo.主体.username | string | ログイン名。省略可能。 |
| content.permissionSetInfo.主体.email | string | メールアドレスまたはシステムアイデンティティ識別子。 |
| content.permissionSetInfo.主体.mobile | string | 電話番号。空の場合があります。 |
| content.permissionSetInfo.主体.countryCode | string | 国/地域コード。省略可能。 |
| content.permissionSetInfo.主体.iconUrl | string | アバター。省略可能。 |
| content.permissionSetInfo.主体.acntWsNickname | string | ワークスペースニックネーム。省略可能。 |
| content.monitorName | string または null | 一覧では null の場合があります。一覧のグループ名補足は monitorUUID と一致することを保証しないため、monitorUUID でグループを確認してください。詳細ではグループがある場合にのみ返します。 |
| content.tagInfo | array<object> |
有効な関連タグ概要。 |
| content.tagInfo[].id | integer | タグレコード番号。 |
| content.tagInfo[].uuid | string | タグ UUID。 |
| content.tagInfo[].name | string | タグ名。 |
| content.tagInfo[].description | string | タグ説明。 |
| content.tagInfo[].colour | string | タグ色。 |
| content.tagInfo[].scope | string または array | スコープ。履歴の空値は文字列 all にフォールバックする場合があり、それ以外は配列です。 |
| content.tagInfo[].scope[] | string | 単一の scope。省略可能。 |
| content.alertPolicyInfos | array<object> |
有効な関連アラートポリシー。 |
| content.alertPolicyInfos[].uuid | string | ポリシー UUID。 |
| content.alertPolicyInfos[].name | string | ポリシー名。 |
| content.dashboardUUID | string | 有効な関連ダッシュボード UUID。省略可能。 |
| content.dashboardName | string | ダッシュボード名。省略可能。 |
| content.relCombinedCheckerInfos | array<object> |
本ルールを参照する複合モニター概要。省略可能。 |
| content.relCombinedCheckerInfos[].uuid | string | 複合モニター UUID。 |
| content.relCombinedCheckerInfos[].name | string | 複合名。 |
| content.memberRuleInfos | array<object> |
複合モニター詳細のみが返す有効メンバー概要。通常ルールでは返しません。 |
| content.memberRuleInfos[].uuid | string | メンバールール UUID。 |
| content.memberRuleInfos[].name | string | メンバー名。 |
| content.incidentsTagInfo | array<object> |
extend.incidentsTags の名前に対応する有効タグの完全なエンティティ。 |
| content.incidentsTagInfo[].id | integer | タグレコード番号。 |
| content.incidentsTagInfo[].uuid | string | タグ UUID。 |
| content.incidentsTagInfo[].name | string | タグ名。 |
| content.incidentsTagInfo[].description | string | タグ説明。 |
| content.incidentsTagInfo[].colour | string | タグ色。 |
| content.incidentsTagInfo[].scope | string または array | スコープ。履歴の空値は文字列 all にフォールバックする場合があり、それ以外は配列です。 |
| content.incidentsTagInfo[].scope[] | string | 単一の scope。省略可能。 |
| content.incidentsTagInfo[].workspaceUUID | string | タグのワークスペース。 |
| content.incidentsTagInfo[].status | integer | 有効タグは 0。 |
| content.incidentsTagInfo[].creator | string | タグ作成アイデンティティ。 |
| content.incidentsTagInfo[].updator | string | タグ更新アイデンティティ。 |
| content.incidentsTagInfo[].createAt | integer | タグ作成 Unix 秒。 |
| content.incidentsTagInfo[].updateAt | integer | タグ更新 Unix 秒。 |
| content.incidentsTagInfo[].deleteAt | integer | タグ削除 Unix 秒。 |
| content.levelInfo | array | 互換性のため、レベル UUID 文字列と追加されたレベル表示オブジェクトを同時に含む場合があります。未設定時は空 []。純粋なオブジェクト配列として解析しないでください。 |
| content.levelInfo[] | string または object | 文字列は元の設定 UUID。オブジェクトは {} または履歴/システムレベルの情報で、現在も選択可能であることを保証しません。 |
| content.levelInfo[].id | integer | レベルレコード番号。システムデフォルトでは省略可能。 |
| content.levelInfo[].uuid | string | レベル UUID。 |
| content.levelInfo[].name | string | レベル名。 |
| content.levelInfo[].color | string | レベル色。 |
| content.levelInfo[].description | string | レベル説明。 |
| content.levelInfo[].workspaceUUID | string | レベルが属するワークスペース。省略可能。 |
| content.levelInfo[].extend | object | レベル拡張。デフォルトでは省略可能。 |
| content.levelInfo[].extend.自定义键 | JSON | 保存済みレベル拡張値。 |
| content.levelInfo[].isManage | boolean | グローバル管理レベルのマーカー。省略可能。 |
| content.levelInfo[].isDefault | boolean | デフォルトレベルの選択可能マーカー。 |
| content.levelInfo[].status | integer | 履歴レベルのステータス。省略可能。 |
| content.levelInfo[].creator | string | レベル作成アイデンティティ。省略可能。 |
| content.levelInfo[].updator | string | レベル更新アイデンティティ。省略可能。 |
| content.levelInfo[].createAt | integer | レベル作成 Unix 秒。 |
| content.levelInfo[].updateAt | integer | レベル更新 Unix 秒。 |
| content.levelInfo[].deleteAt | integer | レベル削除 Unix 秒。 |
| content.channelInfo | object | チャンネル UUID をキーとする関連チャンネルエンティティのマッピング。空の場合は {}。現在のクエリには履歴ステータスが含まれる場合があり、有効なチャンネル一覧として扱わないでください。 |
| content.channelInfo.频道UUID | object | 単一チャンネルの完全なエンティティ。 |
| content.channelInfo.频道UUID.id | integer または null | データベースレコード番号。作成時は永続化前にレスポンスを構築するため null の場合があります。リソース操作には uuid を使用してください。 |
| content.channelInfo.频道UUID.uuid | string | チャンネル UUID。変更、削除、購読に使用。 |
| content.channelInfo.频道UUID.workspaceUUID | string | チャンネルが属するワークスペース。 |
| content.channelInfo.频道UUID.name | string | チャンネル名。default はデフォルトチャンネルを表します。 |
| content.channelInfo.频道UUID.description | string | チャンネル説明。 |
| content.channelInfo.频道UUID.notifyTarget | array<string> |
このチャンネルに直接設定された通知先 UUID。 |
| content.channelInfo.频道UUID.notifyTarget[] | string | 単一の通知先 UUID。 |
| content.channelInfo.频道UUID.notifyUpgradeCfg | object | エスカレーション通知設定。未設定時は空オブジェクト。 |
| content.channelInfo.频道UUID.notifyUpgradeCfg.triggerTime | integer | エスカレーション通知をトリガーするまでの待機時間(秒)。 |
| content.channelInfo.频道UUID.notifyUpgradeCfg.notifyTarget | array<string> |
エスカレーション通知先 UUID リスト。 |
| content.channelInfo.频道UUID.notifyUpgradeCfg.notifyTarget[] | string | エスカレーション通知先 UUID。 |
| content.channelInfo.频道UUID.status | integer | レコードステータス。正常は 0。 |
| content.channelInfo.频道UUID.creator | string | 作成呼び出しアイデンティティ。 |
| content.channelInfo.频道UUID.updator | string | 最終更新アイデンティティ。未更新の場合は空文字列の場合があります。 |
| content.channelInfo.频道UUID.createAt | integer | 作成時間(Unix 秒)。 |
| content.channelInfo.频道UUID.updateAt | integer | 更新時間(Unix 秒)。未更新は -1。 |
| content.channelInfo.频道UUID.deleteAt | integer | 削除時間(Unix 秒)。未削除は -1。 |
| 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": "",
"createAt": 1785427200,
"updateAt": -1,
"deleteAt": -1,
"creatorInfo": {},
"updatorInfo": {},
"monitorName": "默认分组",
"alertPolicyInfos": [],
"tagInfo": [],
"allow_operation": null,
"relCombinedCheckerInfos": [],
"incidentsTagInfo": [],
"levelInfo": [],
"channelInfo": {},
"declaration": {}
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
互換履歴にレコードがない場合:
{
"code": 200,
"content": {},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-EXAMPLE"
}
エラーレスポンス¶
認証、レート制限、共通リクエストエラーは共通エラー定義を参照してください。
| HTTP ステータス | errorCode | トリガー条件 | メッセージまたはレスポンス説明 | 処理方法 |
|---|---|---|---|---|
| 404 | ft.NotFoundRuleInspector | 現在/対象ワークスペースに対象の非削除ルールがない | 指定されたルール/チェッカーが見つかりません | UUID が属するワークスペースを確認してください。履歴がない場合は正常に {} を返すことがあります。 |
| 406 | ft.workspaceUnauthorized | 対象ワークスペースに対応する有効な認可がない | ワークスペース[{}]は未認可 | ソースの認可と呼び出しワークスペースを確認してください。 |
| 406 | ft.NotFoundWorkspaceAuthorizationCfg | クロスサイトで利用可能な認可設定がない | ワークスペース認可情報が見つかりません | 管理者がソース/対象サイトの認可を確認してください。 |
| 406 | ft.UnsupportMultiSiteQuery | 認可解決が複数のソースサイトに関係する | マルチサイトワークスペースクエリはサポートされていません | 1 回に 1 つのソースワークスペースとサイトを選択してください。 |
| 400 | ft.InvalidWorkspace | 対象ワークスペースが削除済み/利用不可 | 無効なワークスペース: {} | 有効なソースワークスペースを確認してください。 |
| 404 | ft.NoInitOtherNodeCfg | クロスサイト対象アドレスが未設定 | 他のノード設定が初期化されていません | 管理者がサイトサービス設定と認可を確認してください。 |
| 500 | ft.InternalServerError | ルール/履歴/関連/権限の読み取り、フォーマット、または通常の下流 5xx 失敗。ruleHistory を整数に変換できない場合も失敗 | 内部エラー | 本ページのパラメータ形式を使用し、現在のルールとソースを確認してください。継続的に失敗する場合は traceId を提供してください。 |