コンテンツにスキップ

一覧



GET /api/v1/checker/list

概要

通常のモニター、インテリジェントモニタリング、AI セマンティックモニターの設定と関連リソースをページ単位で読み取ります。

呼び出し前の前提と使用手順

通常のモニターでは type を省略し、インテリジェントモニタリングと AI モニターではそれぞれ smartMonitor と aiMonitor を指定します。Rule.id の降順で、status!=3 とし、有効と無効を含みます。タグ、ポリシー、指定 UUID、SLO のグループ間フィルターは積集合を取ります。現在の公開 Query では monitorUUID/refKey/dashboardUUID/scriptType などの内部フィルターを宣言していないため、追加しないでください。

これは設定一覧であり、モニター検出を同期実行したり、直近のイベントを返したりするものではありません。クロススペースルールでは保存済み DQL を解析し、targets[].extraOptions に認可された実行範囲を補足するため、読み取ったオブジェクトが元の保存値だけであるとは限りません。フィルターの積集合が空の場合は早期に data=[]、pageInfo={} を返します。通常のページネーションでは pageInfo を提供します。一覧ではカスタム操作権限による設定の非表示を強制せず、allow_operation は操作表示のみに使用され、後続の変更時には引き続き権限を検証します。

リクエストヘッダー

パラメータ名 型 必須 説明
DF-API-KEY string Y ワークスペースの OpenAPI 認証情報。
例: <DF-API-KEY>
取得または入力方法: 対象ワークスペースの API Key 管理から、この操作権限を持つ OpenAPI Key を取得します。

Query リクエストパラメータ

パラメータ名 型 必須 説明
alertPolicyUUID commaArray 任意。複数の半角カンマ区切りで指定し、グループ内のいずれかに一致した場合にヒットし、他のフィルターとは積集合を取ります。
null 許可: False
例: altpl_example
取得または入力方法: アラートポリシー一覧から uuid を取得します。
checkerStatus commaArray 任意。省略時は status!=3 で読み取り、履歴上の他の状態が含まれる場合もあります。カンマ区切り文字列で、呼び出し元は 0/2 のみを送信します。整数以外の値は 500 になる可能性があり、3 を指定して削除済み項目を読み取ることはできません。
null 許可: False
例: 0,2
取得または入力方法: 0 は有効、2 は無効です。
checkerUUID commaArray 任意。複数の半角カンマ区切りで指定し、モニターグループの UUID ではありません。
null 許可: False
例: rul_checker_example
取得または入力方法: 本インターフェースの content.data[].uuid から取得します。
pageIndex integer 任意。デフォルトは 1、最小値は 1 です。
null 許可: False
$minValue: 1
例: 1
取得または入力方法: 1 からページ単位で進めます。
pageSize integer 任意。デフォルトは 100、最大値は 100 です。
null 許可: False
$maxValue: 100
$minValue: 1
例: 100
取得または入力方法: 1 ページあたり 1..100 です。
search string 任意。trim 後の包含一致で、名前は大文字小文字を区別せず、%/_ は LIKE の意味を踏襲します。検出データは検索しません。
null 許可: False
例: 本番CPU
取得または入力方法: ルール名またはルール UUID のキーワードです。
sloUUID string 任意。単一の SLO を指定し、その SLI の関連付けでフィルターします。関連付けに成功しない場合は空の結果になります。
null 許可: False
例: monitor_slo_example
取得または入力方法: SLO 詳細から所属 SLO UUID を取得します。
tagsUUID commaArray 任意。複数の半角カンマ区切りで指定します。モニタータグの関連付けでいずれかに一致した場合にヒットし、他のフィルターとは AND で結合します。
null 許可: False
例: tag_example
取得または入力方法: タグ一覧から uuid を取得します。タグ名ではありません。
type string 任意。指定しない場合はデフォルトの trigger になりますが、trigger を明示的に渡すことはできません(現在の列挙値に含まれません)。jsonScript.type のアルゴリズム名ではありません。
空文字列許可: False
null 許可: False
選択可能な値: ['smartMonitor', 'aiMonitor']
例: smartMonitor
取得または入力方法: インテリジェントモニタリングを検索する場合は smartMonitor、AI セマンティックモニターを検索する場合は aiMonitor を使用します。通常のモニターでは省略します。

リクエスト例

curl --get 'https://openapi.guance.com/api/v1/checker/list' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  --data-urlencode pageIndex=1 \
  --data-urlencode pageSize=100

レスポンス

HTTP 200、application/json。以下の例は、直接読み取れる主要フィールドを示しています。

フィールド 型 説明
content.data array<object> このページのモニター設定。
content.data[].id integer 現在のレコード番号。履歴ブランチの場合は履歴レコード番号です。
content.data[].uuid string 現在の rul_ UUID。ruleHistory=1 で履歴レコードがある場合は ruleh_ 履歴 UUID となり、後続の変更では引き続きリクエストの現在 UUID を使用します。
content.data[].ruleUUID string 履歴ブランチのみ。所属する現在のモニター UUID。
content.data[].workspaceUUID string オブジェクトが所属するワークスペース。
content.data[].monitorUUID string 関連付けられたモニターグループ UUID。
content.data[].type string エンティティカテゴリ。通常は trigger/smartMonitor/aiMonitor で、jsonScript.type のチェックアルゴリズムとは区別されます。
content.data[].refKey string 互換性のためのビジネス関連キー。通常は空文字列です。
content.data[].secret string または null 外部イベント Webhook 識別子などの共有フィールドで、一般の API Key として扱いません。機密性の高い実値はログに出力しないでください。
content.data[].jsonScript object 保存された検出設定。jsonScript.type およびバージョンに従って解釈されます。読み取りでは検出は実行されません。
content.data[].crontabInfo object スケジュール設定。フィールドは単一/複数スペースおよびアルゴリズムによって変化し、{} の場合があります。
content.data[].crontabInfo.id string メインスケジュール設定 ID。省略可能です。
content.data[].crontabInfo.crontab string または null 実際に実行される Cron。明示的に null または省略される場合があります(Cron のない組み合わせモニターなど)。入力の every とは異なります。
content.data[].crontabInfo.smartRelId string 一部のインテリジェントモニタリングに付属するスケジュール ID。省略可能です。
content.data[].crontabInfo.multiWsCrontabInfo array<object> クロススペースの各スケジュール情報。履歴に存在する場合があり、省略可能です。
content.data[].crontabInfo.multiWsCrontabInfo[].ws_uuid string 対象スペース UUID。
content.data[].crontabInfo.multiWsCrontabInfo[].id string そのスペースのスケジュール ID。
content.data[].crontabInfo.multiWsCrontabInfo[].crontab string または null そのスペースで実際に使用される Cron。明示的に null または省略される場合があります。
content.data[].extend object 追加の表示/インシデント関連設定。履歴のカスタムフィールドを含む場合があります。全体を盲目的に返して変更しないでください。
content.data[].extend.自定义字段 JSON 履歴または型固有の保存値。現在の型の詳細および作成インターフェースで公開されている構造に従ってください。
content.data[].createdWay string manual/import/template または履歴の空値。
content.data[].isLocked integer または boolean ロック状態。履歴ブランチでは省略される場合があります。
content.data[].openPermissionSet boolean カスタム操作権限のスイッチ。読み取り成功から変更可能と推測することはできません。
content.data[].permissionSet array<string> カスタム操作主体の UUID。
content.data[].permissionSet[] string アカウント/チーム/ロールの識別子。
content.data[].status integer 0 は有効、2 は無効です。削除以外のクエリでは他の履歴状態が含まれる場合があります。直近の実行結果を表すものではありません。
content.data[].creator string 作成者の識別情報。
content.data[].updator string 更新者の識別情報。
content.data[].createAt integer 作成日時の Unix 秒。
content.data[].updateAt integer 更新日時の Unix 秒。未更新の場合は -1。
content.data[].deleteAt integer 削除日時の Unix 秒。未削除の場合は -1。
content.data[].configVersion integer V2 の現在の設定バージョン付加フィールド。通常のルールでは省略される場合があります。
content.data[].jsonScript.targetWorkspaceUUID string 対象ワークスペース。クロススペースクエリでは閾値検出タイプのみをサポートします(2025-08-13 のイテレーションで追加)。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.type string チェック方法のタイプ。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.windowDql string window DQL。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.title string 生成される event のタイトル。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.message string event の内容。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.recoverTitle string 復旧イベントのタイトルを出力するテンプレート。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.recoverMessage string 復旧イベント情報を出力するテンプレート。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.noDataTitle string データなしイベントのタイトルを出力するテンプレート。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.noDataMessage string データなしイベント情報を出力するテンプレート。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.openNotificationMessage boolean 有効にするかどうか(イベント通知内容)。デフォルトは無効(イベント内容を通知内容として使用)。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.notificationMessage string イベント通知内容。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.openNoDataNotificationMessage boolean 有効にするかどうか(データ欠損イベントの通知内容)。デフォルトは無効(データ欠損イベントの内容を通知内容として使用)。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.noDataNotificationMessage string データ欠損イベントの通知内容。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.noDataRecoverTitle string データなし復旧アップロードイベントのタイトルを出力するテンプレート。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.noDataRecoverMessage string データなし復旧アップロードイベント情報を出力するテンプレート。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.every string チェック頻度。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.customCrontab string カスタムチェック頻度。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.delaySeconds integer 通常のモニターのデータ待機ウィンドウ。単位は秒で、0 は待機なしを意味します。インテリジェントモニタリングではこの設定はサポートされません。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.interval integer クエリ区間。1 回のクエリにおける時間範囲の差です。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.range integer 高度な検出および変化検出の range パラメータ。単位は秒です。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.range_2 integer 高度な検出および変化検出の range_2 パラメータ。単位は秒です。特記事項: -1 は前期比、0 は periodBefore フィールドの使用を表します。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.periodBefore integer 高度な検出および変化検出の(昨日/1 時間前)パラメータ。単位は秒です。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.recoverNeedPeriodCount integer 異常が発生してから何チェック周期後に復旧イベントを生成するかを指定します。検出頻度がカスタム customCrontab の場合はこのフィールドは時間長を表し、単位は秒です。それ以外の場合はチェック頻度の回数を表します。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.noDataInterval integer どの程度の時間データがない場合にデータなしイベントを生成するか。noDataEventRepeat の場合は正の整数秒である必要があります。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.noDataAction string データなし時の処理操作。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkFuncs array チェック関数情報のリスト。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.groupBy array トリガー次元。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.targets array チェック対象。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt json チェック条件設定。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.enableStreamingAggregation boolean または null モニターのストリーミング集約高速化。未指定または null の場合はスペース設定に従い、true は個別に有効化、false は個別に無効化します。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.yamlConfig string V2 の完全なソース YAML テキスト。最大 256KiB です。JSON オブジェクトではなく、Markdown のコードフェンスも含みません。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.disableLargeScaleEventProtect boolean 大規模イベント保護を無効にするかどうか。デフォルトは false。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.script string プログラマブルモニターのスクリプト内容。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.rules array トリガー条件のリスト。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.openOkConditions boolean 段階的復旧を有効にするかどうか。デフォルトは無効(false)。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.openMatchTimes boolean 連続トリガー判定を有効にするかどうか。デフォルトは無効(false)。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.infoEvent boolean 継続的に正常な場合に info イベントを生成するかどうか。デフォルトは false。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.infoEventCondition json 情報イベントの生成条件。通常ルール検出の閾値、ログ、アプリケーション/ユーザーアクセスメトリクス、可用性、プロセス、ネットワーク、変化、区間、および互換性のある旧タイプをサポートします。外れ値、組み合わせ、ライブネス V2、変更、プログラマブル、インテリジェント、SLO はサポートしません。空オブジェクトは無条件生成を表します。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.infoEventCondition.alias string 判定対象のエイリアス。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.infoEventCondition.operator string 判定演算子。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.infoEventCondition.operands array 判定オペランドのリスト。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.diffMode string 高度な検出における変化検出の差分モード。列挙値は value、percent です。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.direction string 高度な検出における変化検出および区間検出のトリガー条件方向。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.eps float 距離パラメータ。値の範囲は 0 ~ 3.0 です。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.threshold json 変化検出のトリガー前提条件設定。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.threshold.status boolean 変化検出のトリガー前提条件を有効にするかどうか。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.threshold.operator string 変化検出のトリガー前提条件演算子。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.threshold.value float または null 変化検出のトリガー前提条件チェック値。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.combineExpr string 組み合わせモニターの組み合わせ方式。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.ignoreNodata boolean 組み合わせモニターでデータなし結果を無視するかどうか(true は無視が必要)。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.confidenceInterval integer 区間検出 V2 の追加パラメータ。信頼区間の範囲は 1~100 です。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.category string AI モニターカテゴリのメタデータ。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.userPrompt string AI ユーザープロンプト。渡す場合は空にできず、最大 20000 文字です。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.systemPrompt string AI システムプロンプト。渡す場合は空にできず、最大 20000 文字です。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.mentions array DQL 参照リスト。各項目には type=dql、namespace、datasource が必須で、index は任意です。ログを選択する場合に入力し、シリアライズ後は最大 20000 文字です。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.mentions[] object 配列内の単一オブジェクト。下位フィールドの説明に従って解釈します。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.mentions[].type string データソースタイプ。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.mentions[].namespace string DQL 名前空間。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.mentions[].index string DQL インデックス。ログを選択する場合に入力します。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.mentions[].datasource string DQL データソース。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.model string 今回の検出で使用するモデル。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.contextWindowLimit integer コンテキストウィンドウの Token 制限。0 より大きい必要があります。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.maxChatRounds integer 最大対話ラウンド数。1 以上である必要があります。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.maxDQLQueries integer 最大 DQL クエリ回数。0 以上である必要があります。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.checkerOpt.creditSoftBudget number 1 回の検出における Credit ソフトバジェット。0 より大きい必要があります。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.channels array チャンネル UUID リスト。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.atAccounts array 正常検出時に @ されるアカウント UUID リスト。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.atNoDataAccounts array データなし時に @ されるアカウント UUID リスト。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.subUri string OuterEventChecker の Webhook アドレスサフィックス。作成時は必須で、一意である必要はありません。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.isChangeEvent boolean OuterEventChecker を変更イベントとして処理するかどうか。デフォルトは false で、既存ルールに存在しない場合は false として扱います。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.disableCheckEndTime boolean 終了時間の制限を無効にするかどうか。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.eventChartEnable boolean イベントチャートを有効にするかどうか。デフォルトは無効です(メインストレージエンジンの logging が doris の場合のみ有効になります)。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.eventCharts array イベントチャートのリスト。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.eventCharts[] object 配列内の単一オブジェクト。下位フィールドの説明に従って解釈します。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.eventCharts[].dql string イベントチャートのクエリ文。これは保存済み設定であり、実際に有効かどうかはチェックタイプに依存します。書き込みについてはモニターの作成を参照してください。
content.data[].jsonScript.targets[] object 単一の DQL/PromQL クエリ対象、または組み合わせモニターのメンバー。
content.data[].jsonScript.targets[].dql string 実際に実行されるクエリ。qtype が構文を決定します。
content.data[].jsonScript.targets[].qtype string 通常は dql/promql で、履歴では queryType で表現される場合があります。
content.data[].jsonScript.targets[].queryType string 履歴のクエリ構文マーカー。
content.data[].jsonScript.targets[].alias string 通常の共通プラグインでは通常 Result が要求されます。組み合わせモニターではメンバーのエイリアスに従います。
content.data[].jsonScript.targets[].monitorCheckerId string 組み合わせモニターの関連メンバー UUID のみ。
content.data[].jsonScript.targets[].groupBy array<string> 組み合わせメンバーの追加トリガー次元。
content.data[].jsonScript.targets[].groupBy[] string フィールド名。
content.data[].jsonScript.targetWorkspaceUUIDs array<string> 履歴/その他の入口で保存される可能性がある対象スペース UUID の集合。公開の追加/変更では宣言されておらず、全体を返してはいけません。
content.data[].jsonScript.targetWorkspaceUUIDs[] string 単一の対象スペース UUID。
content.data[].jsonScript.targets[].extraOptions object get では保存済み値を返します。list のクロススペース認可確認で解析結果がある場合はその場で補足されることがあり、結果がない場合も履歴値が保持されることがあります。クライアントが書き込めるリクエストや現在の完全な認可証明として扱いません。
content.data[].jsonScript.targets[].extraOptions.workspace_uuids array<string> 保存済み、または一覧で今回解析された実行候補スペース。履歴値を含む場合があり、現在すべてが認可済みであることを保証しません。
content.data[].jsonScript.targets[].extraOptions.workspace_uuids[] string 単一の保存済みまたは候補スペース UUID。現在の認可を確認する必要があります。
content.data[].jsonScript.targets[].extraOptions.index_list array<object> 保存済み、または一覧で今回解析されたデータドメイン/インデックスの候補範囲。履歴値の場合があり、現在の完全な認可保証としては使用できません。
content.data[].jsonScript.targets[].extraOptions.index_list[].workspace_uuid string ソーススペース UUID。
content.data[].jsonScript.targets[].extraOptions.index_list[].namespace string クエリ名前空間。
content.data[].jsonScript.targets[].extraOptions.index_list[].index_name string 許可されるインデックス名。ログ以外では default の場合があります。
content.data[].jsonScript.targets[].extraOptions.index_list[].expr_name string 式サブクエリ名。省略可能です。
content.data[].jsonScript.targets[].conditions object または string クエリの追加フィルター。保存構造に従って読み取り、統一された型を前提としません。
content.data[].jsonScript.groupBy[] string トリガー次元フィールド。
content.data[].jsonScript.checkFuncs[] object 互換性のためのチェック関数情報。
content.data[].jsonScript.checkFuncs[].funcId string 関数 ID。
content.data[].jsonScript.checkFuncs[].kwargs object 関数固有のパラメータ。すべてのアルゴリズムに共通する入力ではありません。
content.data[].jsonScript.checkFuncs[].kwargs.参数名 JSON 対応する関数のドキュメントに従って解釈します。
content.data[].jsonScript.channels[] string インシデント追跡チャンネル UUID。
content.data[].jsonScript.atAccounts[] string 通知で @ される ID 識別子。履歴ではメールアドレスの場合があります。
content.data[].jsonScript.atNoDataAccounts[] string データなし通知の @ 対象。
content.data[].jsonScript.checkerOpt.rules[] object レベルごとにトリガー条件と復旧条件を設定します。
content.data[].jsonScript.checkerOpt.rules[].status string fatal/critical/error/warning/info/ok/ALL など。検出タイプに従って解釈します。
content.data[].jsonScript.checkerOpt.rules[].conditionLogic string and/or。複数条件の組み合わせです。
content.data[].jsonScript.checkerOpt.rules[].matchTimes integer 連続一致回数。openMatchTimes と組み合わせて使用します。
content.data[].jsonScript.checkerOpt.rules[].conditions array<object> トリガー条件。
content.data[].jsonScript.checkerOpt.rules[].okConditions array<object> 段階的復旧条件。省略可能です。
content.data[].jsonScript.checkerOpt.rules[].conditions[].alias string 対応するクエリ対象のエイリアス。
content.data[].jsonScript.checkerOpt.rules[].conditions[].operator string 条件演算子。検出タイプに応じてサポートされる集合が異なります。
content.data[].jsonScript.checkerOpt.rules[].conditions[].operands array 比較値の配列。数値/文字列型を保持します。
content.data[].jsonScript.checkerOpt.rules[].conditions[].operands[] string / number 単一の比較値。
content.data[].jsonScript.checkerOpt.rules[].okConditions[].alias string 対応するクエリ対象のエイリアス。
content.data[].jsonScript.checkerOpt.rules[].okConditions[].operator string 条件演算子。検出タイプに応じてサポートされる集合が異なります。
content.data[].jsonScript.checkerOpt.rules[].okConditions[].operands array 比較値の配列。数値/文字列型を保持します。
content.data[].jsonScript.checkerOpt.rules[].okConditions[].operands[] string / number 単一の比較値。
content.data[].extend.isNeedCreateIssue boolean 異常に基づいて Issue を作成するかどうか。
content.data[].extend.issueLevelUUID string 履歴の Issue レベル識別子。すでに無効な場合があります。
content.data[].extend.issueDfStatus array<string> Issue をトリガーする異常状態。
content.data[].extend.issueDfStatus[] string fatal/critical/error/warning/nodata。
content.data[].extend.manager array<string> 解決済みの担当者対象。
content.data[].extend.manager[] string メンバー/チームなどの対象識別子。
content.data[].extend.incidentsTags array<string> 異常に関連付けられたタグ名。
content.data[].extend.incidentsTags[] string 単一のタグ名。
content.data[].extend.faultMappingMode string custom/existing。現在のインシデントレベルマッピング方式。
content.data[].extend.levelMappingUUID string existing の場合のレベルマッピング UUID。
content.data[].extend.bindIncidentsInfo array<object> カスタムレベルマッピング行。
content.data[].extend.bindIncidentsInfo[].incidentsLevelUUID string マッピングされる Issue レベル UUID。
content.data[].extend.bindIncidentsInfo[].incidentsDfStatus array<string> マッピングされる異常状態の配列。
content.data[].extend.bindIncidentsInfo[].incidentsDfStatus[] string 単一の異常状態。
content.data[].extend.smartMonitor object V2 のソースと現在バージョンのメタ情報。
content.data[].extend.smartMonitor.source string ai/builtin のソース。
content.data[].extend.smartMonitor.engineVersion integer V2 では通常 2 です。
content.data[].extend.smartMonitor.configVersion integer V2 設定バージョン。
content.data[].extend.smartMonitor.category string インテリジェントモニタリングの分類。
content.data[].extend.smartMonitor.prompt string AI 生成プロンプト。
content.data[].extend.smartMonitor.templateId string 組み込みテンプレート識別子。
content.data[].extend.smartMonitor.templateVersion string 組み込みテンプレートバージョン。
content.data[].extend.smartMonitor.generationRunId string 生成プロセスの追跡識別子。省略可能です。
content.data[].creatorInfo object または string 識別情報の概要。一覧で情報がない場合は空文字列、詳細で情報がない場合は {} です。
content.data[].creatorInfo.uuid string 識別情報 UUID。省略可能です。
content.data[].creatorInfo.status integer アカウント/主体の状態。省略可能です。
content.data[].creatorInfo.wsAccountStatus integer メンバー状態。省略可能です。
content.data[].creatorInfo.name string 表示名。
content.data[].creatorInfo.username string ログイン名。省略可能です。
content.data[].creatorInfo.email string メールアドレスまたはシステム識別子。
content.data[].creatorInfo.mobile string 携帯電話番号。空の場合があります。
content.data[].creatorInfo.countryCode string 国/地域コード。省略可能です。
content.data[].creatorInfo.iconUrl string アバター。省略可能です。
content.data[].creatorInfo.acntWsNickname string スペース内ニックネーム。省略可能です。
content.data[].updatorInfo object または string 識別情報の概要。一覧で情報がない場合は空文字列、詳細で情報がない場合は {} です。
content.data[].updatorInfo.uuid string 識別情報 UUID。省略可能です。
content.data[].updatorInfo.status integer アカウント/主体の状態。省略可能です。
content.data[].updatorInfo.wsAccountStatus integer メンバー状態。省略可能です。
content.data[].updatorInfo.name string 表示名。
content.data[].updatorInfo.username string ログイン名。省略可能です。
content.data[].updatorInfo.email string メールアドレスまたはシステム識別子。
content.data[].updatorInfo.mobile string 携帯電話番号。空の場合があります。
content.data[].updatorInfo.countryCode string 国/地域コード。省略可能です。
content.data[].updatorInfo.iconUrl string アバター。省略可能です。
content.data[].updatorInfo.acntWsNickname string スペース内ニックネーム。省略可能です。
content.data[].allow_operation boolean または null 現在の呼び出し元識別情報に対する操作表示値。引き続きインターフェース権限と業務検証が必要で、未設定の場合は null になることがあります。
content.data[].permissionSetInfo object permissionSet が空でない場合に識別子→情報のマッピングを提供します。一致する主体がない場合は {} になります。
content.data[].permissionSetInfo.主体 object アカウントの完全な識別情報、またはロール/チームの {name,status}。
content.data[].permissionSetInfo.主体.uuid string 識別情報 UUID。省略可能です。
content.data[].permissionSetInfo.主体.status integer アカウント/主体の状態。省略可能です。
content.data[].permissionSetInfo.主体.wsAccountStatus integer メンバー状態。省略可能です。
content.data[].permissionSetInfo.主体.name string 表示名。
content.data[].permissionSetInfo.主体.username string ログイン名。省略可能です。
content.data[].permissionSetInfo.主体.email string メールアドレスまたはシステム識別子。
content.data[].permissionSetInfo.主体.mobile string 携帯電話番号。空の場合があります。
content.data[].permissionSetInfo.主体.countryCode string 国/地域コード。省略可能です。
content.data[].permissionSetInfo.主体.iconUrl string アバター。省略可能です。
content.data[].permissionSetInfo.主体.acntWsNickname string スペース内ニックネーム。省略可能です。
content.data[].monitorName string または null 一覧では null の場合があります。一覧のグループ名補足は monitorUUID と一致することを保証しないため、monitorUUID でグループを確認してください。詳細ではグループがある場合にのみ返されます。
content.data[].tagInfo array<object> 有効な関連タグの概要。
content.data[].tagInfo[].id integer タグレコード番号。
content.data[].tagInfo[].uuid string タグ UUID。
content.data[].tagInfo[].name string タグ名。
content.data[].tagInfo[].description string タグの説明。
content.data[].tagInfo[].colour string タグの色。
content.data[].tagInfo[].scope string または array スコープ。履歴の空値は文字列 all にフォールバックする場合があり、それ以外は配列です。
content.data[].tagInfo[].scope[] string 単一の scope。省略可能です。
content.data[].alertPolicyInfos array<object> 有効な関連アラートポリシー。
content.data[].alertPolicyInfos[].uuid string ポリシー UUID。
content.data[].alertPolicyInfos[].name string ポリシー名。
content.data[].dashboardUUID string 有効な関連ダッシュボード UUID。省略可能です。
content.data[].dashboardName string ダッシュボード名。省略可能です。
content.data[].relCombinedCheckerInfos array<object> 本ルールを参照する組み合わせモニターの概要。省略可能です。
content.data[].relCombinedCheckerInfos[].uuid string 組み合わせモニター UUID。
content.data[].relCombinedCheckerInfos[].name string 組み合わせ名。
content.data[].isSLI boolean 有効な SLO と関連付けられているかどうか。
content.data[].sloInfo array<object> isSLI が true の場合のみの SLO 概要。
content.data[].sloInfo[].uuid string SLO UUID。
content.data[].sloInfo[].name string SLO 名。
content.data[].invalidWsGrant boolean クロススペースのソース認可が無効と判定された場合のみ true です。表示されないことは、今後のすべてのクエリが成功することを意味しません。
content.declaration object 共通宣言。
pageInfo object ページネーションオブジェクト。フィルターが早期終了した場合は {} になります。
pageInfo.pageIndex integer 現在のページ。省略可能です。
pageInfo.pageSize integer ページサイズ。省略可能です。
pageInfo.count integer このページの件数。省略可能です。
pageInfo.totalCount integer フィルター後の総件数。省略可能です。
{
  "code": 200,
  "content": {
    "data": [
      {
        "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": null,
        "alertPolicyInfos": [],
        "tagInfo": [],
        "allow_operation": null,
        "isSLI": false
      }
    ],
    "declaration": {}
  },
  "errorCode": "",
  "message": "",
  "success": true,
  "traceId": "TRACE-EXAMPLE",
  "pageInfo": {
    "pageIndex": 1,
    "pageSize": 100,
    "count": 1,
    "totalCount": 1
  }
}

エラー応答

認証、レート制限、共通リクエストエラーについては共通エラー定義を参照してください。

HTTP ステータス errorCode 発生条件 メッセージまたはレスポンスの説明 対処方法
406 ft.ParameterValidationFailed 宣言されていない Query パラメータを使用した場合、またはパラメータがルールに違反した場合 パラメータの解析に失敗しました Query パラメータ表と例を確認してください。
404 ft.NoInitOtherNodeCfg 一覧でソース認可を確認する際に外部組織サイトアドレスが未設定 他のノード設定が初期化されていません 管理者が認可ソースのサービスアドレスとサイト設定を確認してください。
406 ft.UnsupportMultiSiteQuery ソース認可が複数の互換性のないサイトアドレスに解決された マルチサイトスペースクエリはサポートされていません ソーススペースごとにフィルターし、認可サイト設定を確認してください。
406 ft.DqlParseError 一覧でクロススペース認可を確認する際に保存済み DQL または eval サブクエリの解析に失敗 dql parser の解析に失敗しました: {} 保存済みの検出クエリ式およびインデックス/データドメインを修正し、まず対象 UUID に絞って調査してください。
500 ft.InternalServerError ステータスが整数でない、保存 JSON の形状が無効、関連付け/認可処理または通常のクエリサービスが 5xx で失敗 内部エラー checkerStatus は 0/2 のみを使用し、フィルターを絞ってください。継続して失敗する場合は traceId を提供してください。

フィードバック

このページは役に立ちましたか?