コンテンツにスキップ

作成 v2



POST /api/v1/alert_policy/add_v2

概要

アラートポリシーを作成し、モニター/SLO/セキュリティルールのバインドを完全に維持します。

呼び出し前の準備と使用手順

name、ruleTimezone を最小限入力すると空の通知ポリシーを保存できます。実際に通知する場合は、aggInterval と対応モードのターゲットアクションを含む完全な alertOpt を送信する必要があります。v2 では作成時に checkerUUIDs でモニター/SLO を、securityRuleUUIDs でセキュリティルールをバインドできます。省略した場合はこれらの関連付けを作成しません。クライアントは事前に各 UUID が現在のワークスペースに属することを検証してください。保存成功は、帰属と実際のバインドの確認を代替するものではありません。現在のバージョンではトップレベルの ruleTimezone が保存および表示されますが、実行キャッシュは従来の alertOpt.ruleTimezone を読み取り、デフォルトは Asia/Shanghai です。他のタイムゾーンは保存成功だけで有効になったと判断できず、連携側は実際の実行タイムゾーンで検証する必要があります。宣言されていない追加フィールドで公開パラメータを回避しないでください。保存とキャッシュ更新は通知の到達を意味しません。実際の送信は、有効なターゲット、イベントレベル、時間帯、フィルタリング、重複抑制、アラート実行サービスに依存します。失敗またはタイムアウト後は、まずポリシーとバインド状態を読み取り、重複作成や部分更新の誤判定を避けてください。

リクエストヘッダー

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

Body リクエストパラメータ

パラメータ名 型 必須 説明
permissionSet[*] string 単一の操作可能な主体識別子。有効かどうかはアイデンティティとリソースの現在の状態にも依存します。
例: wsAdmin
取得または入力方法: ロール UUID(wsAdmin/general/readOnly/role_ など)、acnt_ アカウント、または group_ チームを使用します。アカウント/チームは本ワークスペースの実際のリソースに準拠します。
alertOpt.silentTimeoutByStatus[*] json レベル別間隔オブジェクト。
例: {"status": "critical,error", "silentTimeout": 600}
取得または入力方法: 各項目でレベルのグループとその秒数を定義します。
alertOpt.silentTimeoutByStatus[*].status string 非セキュリティでは fatal/critical/error/warning/nodata/info/ALL を使用可能。セキュリティでは security_critical/security_high/security_medium/security_low/security_info/security_ALL を使用します。複数は半角カンマで区切り、スペースを入れません。
例: critical,error
取得または入力方法: イベントレベルから選択します。セキュリティレベルは security_ プレフィックスを使用します(例: security_high)。
alertOpt.silentTimeoutByStatus[*].silentTimeout integer 各グループで必須の繰り返し間隔(秒)。不正なレベルは内部エラーを引き起こす可能性があるため、送信前に検証してください。
例: 600
取得または入力方法: 該当レベルの非負の整数秒を入力します。0 は周期的な繰り返しを行わないことを示します。
alertOpt.aggFields[*] string 単一の集約フィールド。byCustom は実際のイベントフィールドに基づいて選択し、表示名だけでフィールドを推測しないでください。
例: df_monitor_checker_id
取得または入力方法: イベントモニターでは df_monitor_checker_id、検出ディメンションでは df_dimension_tags、タグでは df_label、従来のインテリジェント集約では CLUSTER を使用します。
alertOpt.aggLabels[*] string 単一のタグ値。
例: production
取得または入力方法: 実際のイベント内のタグ値を取得します。
alertOpt.aggClusterFields[*] string 単一のテキストフィールド。
例: df_title
取得または入力方法: タイトルには df_title、内容には df_message を使用します。
alertOpt.alertTarget[*] json ルールオブジェクト。フォールバックが必要な場合は時間設定のないルールを明示的に追加し、システムが自動補完することを前提としないでください。
例: {"name": "默认通知", "targets": [{"status": "critical", "to": ["notify_example"]}]}
取得または入力方法: 各項目で 1 つの時間ウィンドウまたは時間帯制限のないフォールバックルールを設定します。
alertOpt.alertTarget[*].name string 任意のルール名。最大 256 文字。
例: 默认通知
取得または入力方法: 業務用途に応じて命名します。
alertOpt.alertTarget[*].crontab string 周期開始時刻式。crontabDuration とペアで指定する必要があります。カスタム日付方式のいずれかを使用します。
例: 0 9 * * 1-5
取得または入力方法: 繰り返し開始時刻に応じて Cron 式を入力します(例: 平日 9 時)。同時に crontabDuration を指定します。
alertOpt.alertTarget[*].crontabDuration integer 周期ウィンドウの継続秒数。crontab を指定する場合は同時に指定必須です。繰り返し時間帯を設定しない場合は両方とも省略します。
例: 28800
取得または入力方法: 時間ウィンドウの長さを正の整数秒に換算します(例: 28800 は 8 時間)。
alertOpt.alertTarget[*].customDateUUIDs array カスタム日付セット参照。最大 366 項目。customStartTime、customDuration と一緒に指定し、crontabDuration で代用しません。
例: ["ndate_example"]
取得または入力方法: カスタム通知日 の content.data[].uuid から日付セットを取得します。各項目は日付設定 UUID であり、日付文字列ではありません。
alertOpt.alertTarget[*].customDateUUIDs[*] string 単一の日付設定 UUID。
例: ndate_example
取得または入力方法: カスタム通知日 から、同一ワークスペースで有効な日付設定 UUID を 1 つコピーします。
alertOpt.alertTarget[*].customStartTime string カスタム日付当日の開始時刻。customDateUUIDs/customDuration と併用します。
例: 09:30:00
取得または入力方法: 選択した日付のローカル時刻で HH:MM:SS を入力します。実際の実行タイムゾーンで解釈されます。
alertOpt.alertTarget[*].customDuration integer カスタム日付ウィンドウの継続秒数。日付セットおよび開始時刻と必ず一緒に指定します。
例: 3600
取得または入力方法: ウィンドウの長さを正の整数秒で入力します(例: 3600 は 1 時間)。
alertOpt.alertTarget[*].targets array レベルモードのアクション配列。
例: [{"status": "critical", "to": ["notify_example"]}]
取得または入力方法: アカウントはワークスペースメンバー の content.data[].uuid から取得します。チームはメンバーの member_group またはチーム管理から group_ UUID を取得します。通知先は通知先一覧 から UUID を取得します。すべて現在のワークスペースの実際のリソースを使用します。
alertOpt.alertTarget[*].targets[*] json 単一のレベルアクション。
例: {"status": "critical", "to": ["notify_example"]}
取得または入力方法: イベントソースとレベルごとに 1 つのアクションを設定します。
alertOpt.alertTarget[*].targets[*].status string 必須のレベル選択: fatal、critical、error、warning、nodata、info。すべての場合は大文字の ALL。複数は半角カンマで区切り、スペースを入れません。security ソースでは critical、high、medium、low、info または ALL に変更します。
例: critical
取得または入力方法: 実際のイベントの df_status を取得します。セキュリティイベントでは同時に df_source=security を設定します。
alertOpt.alertTarget[*].targets[*].df_source string 任意。公開ターゲット構造では security のみをサポートします。省略時、実行レイヤーはセキュリティソースを除外します。
例: security
取得または入力方法: セキュリティモニタリングイベントにのみ security を入力し、通常イベントでは省略します。
alertOpt.alertTarget[*].targets[*].to array 必須の受信ターゲット配列。メンバー、チーム、通知先、またはメールアドレスを使用できます。エージェントアカウントは有効なデフォルト Webhook を使用できます。
例: ["notify_example"]
取得または入力方法: アカウントはワークスペースメンバー の content.data[].uuid から取得します。チームはメンバーの member_group またはチーム管理から group_ UUID を取得します。通知先は通知先一覧 から UUID を取得します。すべて現在のワークスペースの実際のリソースを使用します。
alertOpt.alertTarget[*].targets[*].to[*] string member モードでは通常 email/sms/notify_ を使用し、status モードでは acnt_/agent_/group_/notify_ またはメールアドレスを使用します。SMS などのチャネルが利用可能かどうかはサイトおよびターゲット設定に依存します。
例: notify_example
取得または入力方法: アカウントはワークスペースメンバー の content.data[].uuid から取得します。チームはメンバーの member_group またはチーム管理から group_ UUID を取得します。通知先は通知先一覧 から UUID を取得します。すべて現在のワークスペースの実際のリソースを使用します。
alertOpt.alertTarget[*].targets[*].tags json status モードではフィールド値でイベントをフィルタリングします。member モードでは上位の alertInfo.filterString を使用し、ここでの tags はメンバー選択条件として使用しません。
例: {"env": ["production"]}
取得または入力方法: イベントの元のフィールドと値から辞書を構成します。
alertOpt.alertTarget[*].targets[*].tags.フィールド array 単一フィールドの一致値配列。
例: ["production"]
取得または入力方法: キーには実際のイベントフィールド(例: env)を使用し、値には一致させる実際のフィールド値の配列を使用します。
alertOpt.alertTarget[*].targets[*].tags.フィールド[*] string 単一の一致値。
例: production
取得または入力方法: イベントの同じフィールドから値を取得します。
alertOpt.alertTarget[*].targets[*].filterString string status モードで空でない場合、tags より優先され、エスカレーションアクションにも使用されます。member モードでは上位の alertInfo.filterString を使用し、このターゲット内のフィールドは有効なフィルタリング入口として扱いません。
例: env:production
取得または入力方法: サーバー側の FilterString 構文を使用します(例: env:production)。複雑な条件はコンソールで生成してコピーします。
alertOpt.alertTarget[*].targets[*].upgradeTargets array 任意のエスカレーションアクション。イベントが該当レベルで duration に達するまで継続した後に実行されます。[] はエスカレーションを設定しません。
例: [{"to": ["acnt_example"], "duration": 600}]
取得または入力方法: アカウントはワークスペースメンバー の content.data[].uuid から取得します。チームはメンバーの member_group またはチーム管理から group_ UUID を取得します。通知先は通知先一覧 から UUID を取得します。すべて現在のワークスペースの実際のリソースを使用します。
alertOpt.alertTarget[*].targets[*].upgradeTargets[*] json 単一のエスカレーションアクション。
例: {"to": ["acnt_example"], "duration": 600}
取得または入力方法: 各エスカレーションの受信ターゲットと待機秒数を選択します。
alertOpt.alertTarget[*].targets[*].upgradeTargets[*].to array member モードではエスカレーション受信メンバー/チーム、status モードではエスカレーション通知ターゲットです。メンバー/チーム/通知先/メールアドレスを使用できます。
例: ["acnt_example"]
取得または入力方法: アカウントはワークスペースメンバー の content.data[].uuid から取得します。チームはメンバーの member_group またはチーム管理から group_ UUID を取得します。通知先は通知先一覧 から UUID を取得します。すべて現在のワークスペースの実際のリソースを使用します。
alertOpt.alertTarget[*].targets[*].upgradeTargets[*].to[*] string 単一のエスカレーション受信識別子。
例: acnt_example
取得または入力方法: アカウントはワークスペースメンバー の content.data[].uuid から取得します。チームはメンバーの member_group またはチーム管理から group_ UUID を取得します。通知先は通知先一覧 から UUID を取得します。すべて現在のワークスペースの実際のリソースを使用します。
alertOpt.alertTarget[*].targets[*].upgradeTargets[*].duration integer 必須の継続時間(秒)。各エスカレーションはイベントの継続状態を基準に設定し、複数の duration を自動加算しません。
例: 600
取得または入力方法: 業務要件に応じて正の整数秒を入力します(例: 600 は該当レベルが 10 分間継続)。
alertOpt.alertTarget[*].targets[*].upgradeTargets[*].toWay array member のエスカレーション通知方式配列。status モードではこのフィールドを使用しません。
例: ["email"]
取得または入力方法: member モードでは email/sms または通知先一覧 の notify_ オブジェクトから選択し、status モードでは省略します。
alertOpt.alertTarget[*].targets[*].upgradeTargets[*].toWay[*] string 単一のエスカレーション通知方式。
例: email
取得または入力方法: 実際に利用可能な email/sms または通知先 UUID を選択します。
alertOpt.alertTarget[*].alertInfo array member モードでのみ使用するメンバーグループ配列。status モードでは使用しません。
例: [{"name": "生产负责人", "memberInfo": ["acnt_example"], "filterString": "env:production", "targets": [{"status": "critical", "to": ["email"]}]}]
取得または入力方法: アカウントはワークスペースメンバー の content.data[].uuid から取得します。チームはメンバーの member_group またはチーム管理から group_ UUID を取得します。通知先は通知先一覧 から UUID を取得します。すべて現在のワークスペースの実際のリソースを使用します。
alertOpt.alertTarget[*].alertInfo[*] json メンバーグループオブジェクト。
例: {"name": "生产负责人", "memberInfo": ["acnt_example"], "targets": [{"status": "critical", "to": ["email"]}]}
取得または入力方法: 各グループにメンバー範囲、イベント条件、通知方式を入力します。
alertOpt.alertTarget[*].alertInfo[*].name string 任意のメンバーグループ名。最大 256 文字。
例: 生产负责人
取得または入力方法: メンバーグループの業務用途に応じて命名します。
alertOpt.alertTarget[*].alertInfo[*].memberInfo array member モードの通常通知における受信メンバー/チーム配列。エージェントアカウントを含めることができ、targets.to の通知方式と組み合わせます。
例: ["acnt_example"]
取得または入力方法: アカウントはワークスペースメンバー の content.data[].uuid から取得します。チームはメンバーの member_group またはチーム管理から group_ UUID を取得します。通知先は通知先一覧 から UUID を取得します。すべて現在のワークスペースの実際のリソースを使用します。
alertOpt.alertTarget[*].alertInfo[*].memberInfo[*] string 単一のメンバーまたはチーム識別子。
例: acnt_example
取得または入力方法: アカウントはワークスペースメンバー の content.data[].uuid から取得します。チームはメンバーの member_group またはチーム管理から group_ UUID を取得します。通知先は通知先一覧 から UUID を取得します。すべて現在のワークスペースの実際のリソースを使用します。
alertOpt.alertTarget[*].alertInfo[*].filterString string メンバーグループレベルのイベントフィルタリング。通常およびエスカレーションアクションの両方でこの条件を使用します。
例: env:production
取得または入力方法: 実際のイベントフィールドから構成します(例: env:production)。
alertOpt.alertTarget[*].alertInfo[*].targets array member モードの通知方式/レベルアクション配列。
例: [{"status": "critical", "to": ["email"]}]
取得または入力方法: アカウントはワークスペースメンバー の content.data[].uuid から取得します。チームはメンバーの member_group またはチーム管理から group_ UUID を取得します。通知先は通知先一覧 から UUID を取得します。すべて現在のワークスペースの実際のリソースを使用します。
alertOpt.alertTarget[*].alertInfo[*].targets[*] json 単一のレベルアクション。
例: {"status": "critical", "to": ["email"]}
取得または入力方法: イベントソースとレベルごとに 1 つのアクションを設定します。
alertOpt.alertTarget[*].alertInfo[*].targets[*].status string 必須のレベル選択: fatal、critical、error、warning、nodata、info。すべての場合は大文字の ALL。複数は半角カンマで区切り、スペースを入れません。security ソースでは critical、high、medium、low、info または ALL に変更します。
例: critical
取得または入力方法: 実際のイベントの df_status を取得します。セキュリティイベントでは同時に df_source=security を設定します。
alertOpt.alertTarget[*].alertInfo[*].targets[*].df_source string 任意。公開ターゲット構造では security のみをサポートします。省略時、実行レイヤーはセキュリティソースを除外します。
例: security
取得または入力方法: セキュリティモニタリングイベントにのみ security を入力し、通常イベントでは省略します。
alertOpt.alertTarget[*].alertInfo[*].targets[*].to array member モードでは通常 email、sms、または notify_ 通知先を使用し、通知方式を表します。実行レイヤーは直接のアカウント/チームなどのターゲットにも対応しますが、memberInfo と通知方式の組み合わせを優先することを推奨します。
例: ["email"]
取得または入力方法: アカウントはワークスペースメンバー の content.data[].uuid から取得します。チームはメンバーの member_group またはチーム管理から group_ UUID を取得します。通知先は通知先一覧 から UUID を取得します。すべて現在のワークスペースの実際のリソースを使用します。
alertOpt.alertTarget[*].alertInfo[*].targets[*].to[*] string member モードでは通常 email/sms/notify_ を使用し、status モードでは acnt_/agent_/group_/notify_ またはメールアドレスを使用します。SMS などのチャネルが利用可能かどうかはサイトおよびターゲット設定に依存します。
例: email
取得または入力方法: アカウントはワークスペースメンバー の content.data[].uuid から取得します。チームはメンバーの member_group またはチーム管理から group_ UUID を取得します。通知先は通知先一覧 から UUID を取得します。すべて現在のワークスペースの実際のリソースを使用します。
alertOpt.alertTarget[*].alertInfo[*].targets[*].tags json status モードではフィールド値でイベントをフィルタリングします。member モードでは上位の alertInfo.filterString を使用し、ここでの tags はメンバー選択条件として使用しません。
例: {"env": ["production"]}
取得または入力方法: イベントの元のフィールドと値から辞書を構成します。
alertOpt.alertTarget[*].alertInfo[*].targets[*].tags.フィールド array 単一フィールドの一致値配列。
例: ["production"]
取得または入力方法: キーには実際のイベントフィールド(例: env)を使用し、値には一致させる実際のフィールド値の配列を使用します。
alertOpt.alertTarget[*].alertInfo[*].targets[*].tags.フィールド[*] string 単一の一致値。
例: production
取得または入力方法: イベントの同じフィールドから値を取得します。
alertOpt.alertTarget[*].alertInfo[*].targets[*].filterString string status モードで空でない場合、tags より優先され、エスカレーションアクションにも使用されます。member モードでは上位の alertInfo.filterString を使用し、このターゲット内のフィールドは有効なフィルタリング入口として扱いません。
例: env:production
取得または入力方法: サーバー側の FilterString 構文を使用します(例: env:production)。複雑な条件はコンソールで生成してコピーします。
alertOpt.alertTarget[*].alertInfo[*].targets[*].upgradeTargets array 任意のエスカレーションアクション。イベントが該当レベルで duration に達するまで継続した後に実行されます。[] はエスカレーションを設定しません。
例: [{"to": ["acnt_example"], "duration": 600, "toWay": ["email"]}]
取得または入力方法: アカウントはワークスペースメンバー の content.data[].uuid から取得します。チームはメンバーの member_group またはチーム管理から group_ UUID を取得します。通知先は通知先一覧 から UUID を取得します。すべて現在のワークスペースの実際のリソースを使用します。
alertOpt.alertTarget[*].alertInfo[*].targets[*].upgradeTargets[*] json 単一のエスカレーションアクション。
例: {"to": ["acnt_example"], "duration": 600, "toWay": ["email"]}
取得または入力方法: 各エスカレーションの受信ターゲットと待機秒数を選択します。
alertOpt.alertTarget[*].alertInfo[*].targets[*].upgradeTargets[*].to array member モードではエスカレーション受信メンバー/チーム、status モードではエスカレーション通知ターゲットです。メンバー/チーム/通知先/メールアドレスを使用できます。
例: ["acnt_example"]
取得または入力方法: アカウントはワークスペースメンバー の content.data[].uuid から取得します。チームはメンバーの member_group またはチーム管理から group_ UUID を取得します。通知先は通知先一覧 から UUID を取得します。すべて現在のワークスペースの実際のリソースを使用します。
alertOpt.alertTarget[*].alertInfo[*].targets[*].upgradeTargets[*].to[*] string 単一のエスカレーション受信識別子。
例: acnt_example
取得または入力方法: アカウントはワークスペースメンバー の content.data[].uuid から取得します。チームはメンバーの member_group またはチーム管理から group_ UUID を取得します。通知先は通知先一覧 から UUID を取得します。すべて現在のワークスペースの実際のリソースを使用します。
alertOpt.alertTarget[*].alertInfo[*].targets[*].upgradeTargets[*].duration integer 必須の継続時間(秒)。各エスカレーションはイベントの継続状態を基準に設定し、複数の duration を自動加算しません。
例: 600
取得または入力方法: 業務要件に応じて正の整数秒を入力します(例: 600 は該当レベルが 10 分間継続)。
alertOpt.alertTarget[*].alertInfo[*].targets[*].upgradeTargets[*].toWay array member のエスカレーション通知方式配列。status モードではこのフィールドを使用しません。
例: ["email"]
取得または入力方法: member モードでは email/sms または通知先一覧 の notify_ オブジェクトから選択し、status モードでは省略します。
alertOpt.alertTarget[*].alertInfo[*].targets[*].upgradeTargets[*].toWay[*] string 単一のエスカレーション通知方式。
例: email
取得または入力方法: 実際に利用可能な email/sms または通知先 UUID を選択します。
checkerUUIDs[*] string 単一のモニターまたは SLO UUID。
例: rul_example
取得または入力方法: 同一ワークスペースの実際のモニターまたは SLO の UUID を取得します。アラートポリシー UUID は入力しないでください。
securityRuleUUIDs[*] string 単一のセキュリティルール UUID。
例: srul_example
取得または入力方法: 同一ワークスペースのセキュリティモニタリングルール UUID を取得します。
alertOpt json アラート通知設定オブジェクト。作成時に省略すると空の設定を保存でき、変更時はオブジェクト全体を渡して置き換えます。オブジェクトを指定する場合、aggInterval は必須検証フィールドです。
許可 null: False
例: {"alertType": "status", "aggInterval": 0, "silentTimeout": 900, "alertTarget": []}
取得または入力方法: 以下のターゲット構造に従って入力します。変更前に詳細からオブジェクト全体をコピーして調整します。
alertOpt.aggClusterFields array インテリジェント集約のテキストフィールド。CLUSTER を含む場合、df_title または df_message を少なくとも 1 つ選択する必要があります。
許可 null: False
例: ["df_title"]
取得または入力方法: CLUSTER 集約が必要な場合にタイトルまたは内容フィールドを選択します。
alertOpt.aggFields array フィールド一覧。定義済みとして df_monitor_checker_id、df_dimension_tags、df_label、CLUSTER を使用できます。byCustom モードでは業務のカスタムフィールドを使用でき、v2 の集約モードは aggType を参照してください。
許可 null: False
例: ["df_monitor_checker_id"]
取得または入力方法: どのイベントを同じグループにまとめるかに応じて以下のフィールドを選択します。[] はすべてを集約します。
alertOpt.aggInterval integer 条件付き必須 alertOpt を指定する場合に必須。0〜1800 秒。0 は集約しません。byAI を選択しても有効な AI 集約が有効になるわけではありません。
許可 null: False
$maxValue: 1800
$minValue: 0
例: 0
取得または入力方法: 集約が必要な場合は待機する秒数を入力し、集約しない場合は 0 を入力します。
alertOpt.aggLabels array タグで集約するタグ値配列。df_label を選択する場合、空でない配列を指定する必要があります。
許可 null: False
例: ["production"]
取得または入力方法: イベントタグから実際のタグ値を取得します。aggFields に df_label が含まれる場合にのみ使用します。
alertOpt.aggSendFirst boolean v2 では任意。集約時に最初の 1 件を即時送信するかどうか。デフォルトは false。aggInterval=0 の場合は有効な集約になりません。
許可 null: False
例: false
取得または入力方法: 集約しつつ最初のアラートを即時送信する場合は true を入力します。
alertOpt.aggType string v2 の任意モード。byFields はルール集約、byCluster はインテリジェント集約、byAI は AI 集約、byCustom はカスタムフィールドルール集約です。省略または null の場合は従来の aggFields ロジックに従います。集約には引き続き aggInterval>0 が必要です。
許可 null: True
選択可能な値: ['byFields', 'byCluster', 'byAI', 'byCustom']
例: byFields
取得または入力方法: 集約の意図に応じてモードを選択します。
alertOpt.alertTarget array 通知ルール配列。status モードでは targets にレベルアクションを配置し、member モードでは alertInfo でメンバーと通知方式を構成します。
許可 null: False
例: [{"name": "默认通知", "targets": [{"status": "critical", "to": ["notify_example"]}]}]
取得または入力方法: 業務時間と受信ルールに応じて配列を設定し、アクションがない場合は [] を指定します。
alertOpt.alertType string status はレベル別、member はメンバー別。省略時はデフォルトの status。2 つのモードでは targets の階層が異なり、混在できません。
許可 null: False
選択可能な値: ['status', 'member']
例: status
取得または入力方法: レベル別に受信者を選ぶか、メンバー別に通知方式を選ぶかのいずれかを選択します。
alertOpt.ignoreOK boolean v2 では任意。正常レベルの通知を無視します。デフォルトは false。
許可 null: False
例: false
取得または入力方法: 復旧後も正常通知を送信する必要がある場合は false、正常イベントを保持するが通知しない場合は true を入力します。
alertOpt.silentTimeout integer 統一されたアラート繰り返し間隔。省略時の実行デフォルトは 900 秒。0 は今回の周期で繰り返さないことを示します。0 以外で 300 未満の場合は実行時に 300 秒として扱います。null を渡さないでください。
許可 null: False
例: 900
取得または入力方法: 同種アラートで期待する最小繰り返し送信間隔を秒数で入力します。
alertOpt.silentTimeoutByStatus array レベル別繰り返し間隔配列。有効化する場合は制御対象のレベルを網羅する必要があります。このレベル別設定は統一 silentTimeout の 300 秒正規化を受けません。
許可 null: False
例: [{"status": "critical,error", "silentTimeout": 600}]
取得または入力方法: 実際のイベントソースとレベルごとに設定し、以下のレベル別配列構造を使用します。
alertOpt.silentTimeoutByStatusEnable boolean 作成時のデフォルト false では silentTimeout を使用します。true では silentTimeoutByStatus に従って状態別間隔を展開します。
許可 null: False
例: false
取得または入力方法: 異なるイベントレベルごとに繰り返し間隔を設定する必要がある場合は true を入力します。
checkerUUIDs array v2 の作成では任意。v2 の変更では完全なターゲットバインドとなり、省略または [] はモニターおよび SLO のバインドをクリアします。
許可 null: False
例: ["rul_example"]
取得または入力方法: モニター/インテリジェントモニタリング/インテリジェントインスペクション/SLO 設定から実際の UUID(rul_ または monitor_ など)を取得します。アラートポリシー詳細 の refCheckerInfo から既存バインドを取得することも可能です。
desc string 任意の説明。最大 256 文字。作成時に省略すると空文字列、変更時に省略すると保持、空文字列でクリアします。
空文字列を許可: True
許可 null: False
最大長: 256
例: 生产服务异常通知与升级。
取得または入力方法: ポリシーが担当する業務範囲に応じて入力します。
name string Y 必須の新規ポリシー名。最大 256 文字を推奨。ワークスペース内で同名を避けてください。
許可 null: False
例: 生产服务告警
取得または入力方法: アラートポリシー一覧 から本ワークスペースの既存名称を確認し、未使用の名称を選択します。
openPermissionSet boolean 任意のカスタム操作権限スイッチ。作成時のデフォルトは false、変更時に省略すると保持します。有効にすると作成者、owner、および高度な操作権限または permissionSet に該当するアイデンティティが操作可能になります。
許可 null: False
例: false
取得または入力方法: 特定のロール、チーム、メンバーで編集などの操作を制限する場合に有効化します。通常どおり API 権限で制御する場合は無効化します。
permissionSet array カスタム操作主体の完全な配列。ロール、アカウント、チーム識別子を設定できます。作成時に省略すると []、変更時は全体を渡して置き換え、[] でクリアします。作成者と owner は空配列でもロックされません。
許可 null: False
例: ["wsAdmin"]
取得または入力方法: ワークスペースロール からロール UUID を取得し、ワークスペースメンバー からアカウント/チーム UUID を取得します。ロールの表示名は入力しないでください。
ruleTimezone str Y 作成と変更の両方で必須のタイムゾーン文字列。ポリシーエンティティに保存されます。現在の公開バージョンでは実行時の読み取り位置に差異があります。
許可 null: False
例: Asia/Shanghai
取得または入力方法: 業務要件に応じて IANA タイムゾーン(例: Asia/Shanghai)を選択します。現在の実行側の制限は使用上の注意を参照してください。
securityRuleUUIDs array v2 の作成では任意。v2 の変更では完全なターゲットセキュリティルールバインドとなり、省略または [] でクリアします。
許可 null: False
例: ["srul_example"]
取得または入力方法: セキュリティモニタリングルール一覧/コンソールから srul_ UUID を取得するか、アラートポリシー詳細 の refSecurityRuleInfo から取得します。

パラメータ補足説明

status モードでは alertTarget[].targets を設定します。member モードでは alertTarget[].alertInfo[].memberInfo および targets を設定し、エスカレーションの受信者には to、通知方式には toWay を使用します。周期ウィンドウには crontab+crontabDuration を入力し、指定日ウィンドウには customDateUUIDs+customStartTime+customDuration を入力します。crontabDuration を customDuration として扱うことはできません。

メンバーモードのリクエストボディ構造例(本ページの URL に送信。例のアカウント/チームは置き換えが必要):

{
  "name": "生产服务告警",
  "ruleTimezone": "Asia/Shanghai",
  "alertOpt": {
    "alertType": "member",
    "aggInterval": 0,
    "silentTimeout": 900,
    "alertTarget": [
      {
        "name": "默认成员通知",
        "alertInfo": [
          {
            "name": "生产负责人",
            "memberInfo": [
              "acnt_example"
            ],
            "filterString": "env:production",
            "targets": [
              {
                "status": "critical",
                "to": [
                  "email"
                ],
                "upgradeTargets": [
                  {
                    "to": [
                      "group_example"
                    ],
                    "duration": 600,
                    "toWay": [
                      "email"
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  },
  "checkerUUIDs": [],
  "securityRuleUUIDs": []
}

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/alert_policy/add_v2' \
  -H 'DF-API-KEY: <DF-API-KEY>' \
  -H 'Content-Type: application/json' \
  --data-raw '{"name":"生产服务告警","ruleTimezone":"Asia/Shanghai","alertOpt":{"alertType":"status","aggInterval":0,"silentTimeout":900,"alertTarget":[{"name":"默认通知","targets":[{"status":"critical","to":["notify_example"]}]}]},"checkerUUIDs":[],"securityRuleUUIDs":[]}'

応答

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

フィールド 型 説明
content.id integer または null ポリシーレコード番号。作成応答ではまだ割り当てられていない場合があります。操作には uuid を使用します。
content.uuid string altpl_ アラートポリシー UUID。
content.workspaceUUID string 所属ワークスペース UUID。
content.name string ポリシー名。
content.desc string ポリシー説明。
content.ruleTimezone string 保存されたエンティティのタイムゾーン。実行時の読み取り差異については使用上の注意を参照してください。タイムゾーンが有効になった証明にはなりません。
content.score integer ポリシーのスコアフィールド。作成時のデフォルトは 0。本公開リクエストではこのフィールドを提供しません。
content.openPermissionSet boolean カスタム操作権限スイッチ。
content.permissionSet array<string> 操作可能なロール/メンバー/チーム識別子。
content.permissionSet[] string 単一の主体識別子。
content.status integer レコード状態。0 は有効、2 は無効、3 は削除。一覧には未削除のポリシーが表示されます。
content.creator string 作成アイデンティティ。
content.updator string 最終更新アイデンティティ。
content.createAt integer 作成時刻(Unix 秒)。
content.updateAt integer 更新時刻(Unix 秒)。初期値は -1。
content.deleteAt integer 削除時刻(Unix 秒)。未削除の場合は -1。
content.alertOpt object 保存された設定: アラート通知設定オブジェクト。作成時に省略すると空の設定を保存でき、変更時はオブジェクト全体を渡して置き換えます。オブジェクトを指定する場合、aggInterval は必須検証フィールドです。
content.alertOpt.alertType string 保存された設定: status はレベル別、member はメンバー別。省略時はデフォルトの status。2 つのモードでは targets の階層が異なり、混在できません。
content.alertOpt.silentTimeout integer 保存された設定: 統一されたアラート繰り返し間隔。省略時の実行デフォルトは 900 秒。0 は今回の周期で繰り返さないことを示します。0 以外で 300 未満の場合は実行時に 300 秒として扱います。null を渡さないでください。
content.alertOpt.silentTimeoutByStatusEnable boolean 保存された設定: 作成時のデフォルト false では silentTimeout を使用します。true では silentTimeoutByStatus に従って状態別間隔を展開します。
content.alertOpt.silentTimeoutByStatus array<object> 保存された設定: レベル別繰り返し間隔配列。有効化する場合は制御対象のレベルを網羅する必要があります。このレベル別設定は統一 silentTimeout の 300 秒正規化を受けません。
content.alertOpt.silentTimeoutByStatus[] object 保存された設定: レベル別間隔オブジェクト。
content.alertOpt.silentTimeoutByStatus[].status string 保存された設定: 非セキュリティでは fatal/critical/error/warning/nodata/info/ALL を使用可能。セキュリティでは security_critical/security_high/security_medium/security_low/security_info/security_ALL を使用します。複数は半角カンマで区切り、スペースを入れません。
content.alertOpt.silentTimeoutByStatus[].silentTimeout integer 保存された設定: 各グループで必須の繰り返し間隔(秒)。不正なレベルは内部エラーを引き起こす可能性があるため、送信前に検証してください。
content.alertOpt.aggInterval integer 保存された設定: alertOpt を指定する場合に必須。0〜1800 秒。0 は集約しません。byAI を選択しても有効な AI 集約が有効になるわけではありません。
content.alertOpt.aggFields array<string> 保存された設定: フィールド一覧。定義済みとして df_monitor_checker_id、df_dimension_tags、df_label、CLUSTER を使用できます。byCustom モードでは業務のカスタムフィールドを使用でき、v2 の集約モードは aggType を参照してください。
content.alertOpt.aggFields[] string 保存された設定: 単一の集約フィールド。byCustom は実際のイベントフィールドに基づいて選択し、表示名だけでフィールドを推測しないでください。
content.alertOpt.aggLabels array<string> 保存された設定: タグで集約するタグ値配列。df_label を選択する場合、空でない配列を指定する必要があります。
content.alertOpt.aggLabels[] string 保存された設定: 単一のタグ値。
content.alertOpt.aggClusterFields array<string> 保存された設定: インテリジェント集約のテキストフィールド。CLUSTER を含む場合、df_title または df_message を少なくとも 1 つ選択する必要があります。
content.alertOpt.aggClusterFields[] string 保存された設定: 単一のテキストフィールド。
content.alertOpt.alertTarget array<object> 保存された設定: 通知ルール配列。status モードでは targets にレベルアクションを配置し、member モードでは alertInfo でメンバーと通知方式を構成します。
content.alertOpt.alertTarget[] object 保存された設定: ルールオブジェクト。フォールバックが必要な場合は時間設定のないルールを明示的に追加し、システムが自動補完することを前提としないでください。
content.alertOpt.alertTarget[].name string 保存された設定: 任意のルール名。最大 256 文字。
content.alertOpt.alertTarget[].crontab string 保存された設定: 周期開始時刻式。crontabDuration とペアで指定する必要があります。カスタム日付方式のいずれかを使用します。
content.alertOpt.alertTarget[].crontabDuration integer 保存された設定: 周期ウィンドウの継続秒数。crontab を指定する場合は同時に指定必須です。繰り返し時間帯を設定しない場合は両方とも省略します。
content.alertOpt.alertTarget[].customDateUUIDs array<string> 保存された設定: カスタム日付セット参照。最大 366 項目。customStartTime、customDuration と一緒に指定し、crontabDuration で代用しません。
content.alertOpt.alertTarget[].customDateUUIDs[] string 保存された設定: 単一の日付設定 UUID。
content.alertOpt.alertTarget[].customStartTime string 保存された設定: カスタム日付当日の開始時刻。customDateUUIDs/customDuration と併用します。
content.alertOpt.alertTarget[].customDuration integer 保存された設定: カスタム日付ウィンドウの継続秒数。日付セットおよび開始時刻と必ず一緒に指定します。
content.alertOpt.alertTarget[].targets array<object> 保存された設定: レベルモードのアクション配列。
content.alertOpt.alertTarget[].targets[] object 保存された設定: 単一のレベルアクション。
content.alertOpt.alertTarget[].targets[].status string 保存された設定: 必須のレベル選択: fatal、critical、error、warning、nodata、info。すべての場合は大文字の ALL。複数は半角カンマで区切り、スペースを入れません。security ソースでは critical、high、medium、low、info または ALL に変更します。
content.alertOpt.alertTarget[].targets[].df_source string 保存された設定: 任意。公開ターゲット構造では security のみをサポートします。省略時、実行レイヤーはセキュリティソースを除外します。
content.alertOpt.alertTarget[].targets[].to array<string> 保存された設定: 必須の受信ターゲット配列。メンバー、チーム、通知先、またはメールアドレスを使用できます。エージェントアカウントは有効なデフォルト Webhook を使用できます。
content.alertOpt.alertTarget[].targets[].to[] string 保存された設定: member モードでは通常 email/sms/notify_ を使用し、status モードでは acnt_/agent_/group_/notify_ またはメールアドレスを使用します。SMS などのチャネルが利用可能かどうかはサイトおよびターゲット設定に依存します。
content.alertOpt.alertTarget[].targets[].tags object 保存された設定: status モードではフィールド値でイベントをフィルタリングします。member モードでは上位の alertInfo.filterString を使用し、ここでの tags はメンバー選択条件として使用しません。
content.alertOpt.alertTarget[].targets[].tags.フィールド array<object> 保存された設定: 単一フィールドの一致値配列。
content.alertOpt.alertTarget[].targets[].tags.フィールド[] string 保存された設定: 単一の一致値。
content.alertOpt.alertTarget[].targets[].filterString string 保存された設定: status モードで空でない場合、tags より優先され、エスカレーションアクションにも使用されます。member モードでは上位の alertInfo.filterString を使用し、このターゲット内のフィールドは有効なフィルタリング入口として扱いません。
content.alertOpt.alertTarget[].targets[].upgradeTargets array<object> 保存された設定: 任意のエスカレーションアクション。イベントが該当レベルで duration に達するまで継続した後に実行されます。[] はエスカレーションを設定しません。
content.alertOpt.alertTarget[].targets[].upgradeTargets[] object 保存された設定: 単一のエスカレーションアクション。
content.alertOpt.alertTarget[].targets[].upgradeTargets[].to array<string> 保存された設定: member モードではエスカレーション受信メンバー/チーム、status モードではエスカレーション通知ターゲットです。メンバー/チーム/通知先/メールアドレスを使用できます。
content.alertOpt.alertTarget[].targets[].upgradeTargets[].to[] string 保存された設定: 単一のエスカレーション受信識別子。
content.alertOpt.alertTarget[].targets[].upgradeTargets[].duration integer 保存された設定: 必須の継続時間(秒)。各エスカレーションはイベントの継続状態を基準に設定し、複数の duration を自動加算しません。
content.alertOpt.alertTarget[].targets[].upgradeTargets[].toWay array<string> 保存された設定: member のエスカレーション通知方式配列。status モードではこのフィールドを使用しません。
content.alertOpt.alertTarget[].targets[].upgradeTargets[].toWay[] string 保存された設定: 単一のエスカレーション通知方式。
content.alertOpt.alertTarget[].alertInfo array<object> 保存された設定: member モードでのみ使用するメンバーグループ配列。status モードでは使用しません。
content.alertOpt.alertTarget[].alertInfo[] object 保存された設定: メンバーグループオブジェクト。
content.alertOpt.alertTarget[].alertInfo[].name string 保存された設定: 任意のメンバーグループ名。最大 256 文字。
content.alertOpt.alertTarget[].alertInfo[].memberInfo array<string> 保存された設定: member モードの通常通知における受信メンバー/チーム配列。エージェントアカウントを含めることができ、targets.to の通知方式と組み合わせます。
content.alertOpt.alertTarget[].alertInfo[].memberInfo[] string 保存された設定: 単一のメンバーまたはチーム識別子。
content.alertOpt.alertTarget[].alertInfo[].filterString string 保存された設定: メンバーグループレベルのイベントフィルタリング。通常およびエスカレーションアクションの両方でこの条件を使用します。
content.alertOpt.alertTarget[].alertInfo[].targets array<object> 保存された設定: member モードの通知方式/レベルアクション配列。
content.alertOpt.alertTarget[].alertInfo[].targets[] object 保存された設定: 単一のレベルアクション。
content.alertOpt.alertTarget[].alertInfo[].targets[].status string 保存された設定: 必須のレベル選択: fatal、critical、error、warning、nodata、info。すべての場合は大文字の ALL。複数は半角カンマで区切り、スペースを入れません。security ソースでは critical、high、medium、low、info または ALL に変更します。
content.alertOpt.alertTarget[].alertInfo[].targets[].df_source string 保存された設定: 任意。公開ターゲット構造では security のみをサポートします。省略時、実行レイヤーはセキュリティソースを除外します。
content.alertOpt.alertTarget[].alertInfo[].targets[].to array<string> 保存された設定: member モードでは通常 email、sms、または notify_ 通知先を使用し、通知方式を表します。実行レイヤーは直接のアカウント/チームなどのターゲットにも対応しますが、memberInfo と通知方式の組み合わせを優先することを推奨します。
content.alertOpt.alertTarget[].alertInfo[].targets[].to[] string 保存された設定: member モードでは通常 email/sms/notify_ を使用し、status モードでは acnt_/agent_/group_/notify_ またはメールアドレスを使用します。SMS などのチャネルが利用可能かどうかはサイトおよびターゲット設定に依存します。
content.alertOpt.alertTarget[].alertInfo[].targets[].tags object 保存された設定: status モードではフィールド値でイベントをフィルタリングします。member モードでは上位の alertInfo.filterString を使用し、ここでの tags はメンバー選択条件として使用しません。
content.alertOpt.alertTarget[].alertInfo[].targets[].tags.フィールド array<object> 保存された設定: 単一フィールドの一致値配列。
content.alertOpt.alertTarget[].alertInfo[].targets[].tags.フィールド[] string 保存された設定: 単一の一致値。
content.alertOpt.alertTarget[].alertInfo[].targets[].filterString string 保存された設定: status モードで空でない場合、tags より優先され、エスカレーションアクションにも使用されます。member モードでは上位の alertInfo.filterString を使用し、このターゲット内のフィールドは有効なフィルタリング入口として扱いません。
content.alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets array<object> 保存された設定: 任意のエスカレーションアクション。イベントが該当レベルで duration に達するまで継続した後に実行されます。[] はエスカレーションを設定しません。
content.alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[] object 保存された設定: 単一のエスカレーションアクション。
content.alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[].to array<string> 保存された設定: member モードではエスカレーション受信メンバー/チーム、status モードではエスカレーション通知ターゲットです。メンバー/チーム/通知先/メールアドレスを使用できます。
content.alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[].to[] string 保存された設定: 単一のエスカレーション受信識別子。
content.alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[].duration integer 保存された設定: 必須の継続時間(秒)。各エスカレーションはイベントの継続状態を基準に設定し、複数の duration を自動加算しません。
content.alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[].toWay array<string> 保存された設定: member のエスカレーション通知方式配列。status モードではこのフィールドを使用しません。
content.alertOpt.alertTarget[].alertInfo[].targets[].upgradeTargets[].toWay[] string 保存された設定: 単一のエスカレーション通知方式。
content.alertOpt.aggType string 保存された設定: v2 の任意モード。byFields はルール集約、byCluster はインテリジェント集約、byAI は AI 集約、byCustom はカスタムフィールドルール集約です。省略または null の場合は従来の aggFields ロジックに従います。集約には引き続き aggInterval>0 が必要です。
content.alertOpt.ignoreOK boolean 保存された設定: v2 では任意。正常レベルの通知を無視します。デフォルトは false。
content.alertOpt.aggSendFirst boolean 保存された設定: v2 では任意。集約時に最初の 1 件を即時送信するかどうか。デフォルトは false。aggInterval=0 の場合は有効な集約になりません。
content.declaration object または null ワークスペースの共通宣言。書き込み API は保存されたエンティティのみを返し、クエリ時の追加フィールドは含みません。
{
  "code": 200,
  "content": {
    "id": null,
    "uuid": "altpl_example",
    "workspaceUUID": "wksp_example",
    "name": "生产服务告警",
    "desc": "生产服务异常通知与升级。",
    "alertOpt": {
      "alertType": "status",
      "aggInterval": 0,
      "silentTimeout": 900,
      "alertTarget": [
        {
          "name": "默认通知",
          "targets": [
            {
              "status": "critical",
              "to": [
                "notify_example"
              ]
            }
          ]
        }
      ]
    },
    "ruleTimezone": "Asia/Shanghai",
    "score": 0,
    "openPermissionSet": false,
    "permissionSet": [],
    "status": 0,
    "creator": "wsak_example",
    "updator": "",
    "createAt": 1785430800,
    "updateAt": -1,
    "deleteAt": -1,
    "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 JSON のトップレベルがオブジェクトではない 一部の json ファイル形式エラー 単一の JSON オブジェクトを送信してください。
400 ft.AlertPolicyNameRepeat 同名の未削除ポリシーが存在する、または短時間の同時作成で名称が占有された アラートポリシー名が重複 既に作成済みか確認し、少し待ってから名前を変更して再試行する必要があるか確認してください。
400 ft.ParamsValidateError status/member アクション構造または時間フィールドの依存関係がルールに適合しない パラメータ検証失敗: {} 本ページの対応モードに従って必須フィールドを補完してください。custom 日付には customDuration が必要で、crontabDuration で代用できません。
400 ft.InvalidEventStatus status モードのイベントレベルが対応する通常/セキュリティ列挙に含まれない 無効なイベント状態: {} 本ページの大文字 ALL と正しいソース列挙を使用し、カンマの間にスペースを入れないでください。
406 ft.InvalidCrontabFormat 周期式を解析できない 無効な crontab 形式 有効な Cron 式を使用し、crontabDuration を指定してください。
400 ft.ErrorFilterString filterString を解析できない filterString 解析失敗: {} まずコンソールのフィルターで有効な条件を生成するか、例に従って修正してください。
400 ft.InvalidCustomNoticeDateUUID 参照した日付設定が存在しない、削除済み、または現在のワークスペースに属していない 無効なカスタム日付 UUIDs: {} カスタム通知日から有効な UUID を再取得してください。
400 ft.InvalidAggFields byCustom 以外のモードで検証に適合しない集約フィールドが指定された 無効な集約タイプ 定義済みフィールドから選択するか、v2 で明示的に byCustom を選択して実際の業務フィールドを使用してください。
400 ft.TagFieldMissing df_label 集約を選択したが空でない aggLabels が指定されていない タグが不足 実際のタグ値配列を指定してください。
400 ft.InvalidAggClusterFields CLUSTER を選択したがタイトルまたは内容の集約フィールドが指定されていない 無効な集約フィールド aggClusterFields に少なくとも df_title または df_message を含めてください。
400 ft.UnsupportExternalEmail 制限付きワークスペースバージョンで status ターゲットに外部メールアドレスが使用された 無料プランワークスペースでは通知先に外部メールアドレスを使用できません 現在のワークスペースのメンバーを選択するか、バージョンとチャネルのサポートを確認してください。
500 ft.InternalServerError レベル別繰り返しアラート状態などの値が直接例外を引き起こした、または保存/キャッシュ/その他の内部処理が失敗した 内部エラー 本ページの列挙と完全な構造でまず自己確認し、保存済み状態を確認してから再試行を判断してください。継続的に失敗する場合は traceId を提供してください。

フィードバック

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