コンテンツにスキップ

変更(このインターフェースは 2025-12-30 に提供終了、v2 版インターフェースの使用を推奨)



POST /api/v1/alert_policy/{alert_policy_uuid}/modify

概要

アラートポリシーの通知設定と操作権限を変更します。

呼び出し前の確認と使用手順

まず詳細を読み取り、完全な対象 alertOpt で置き換えます。alertOpt を省略した場合は元の設定を保持し、{} を渡すとそのオブジェクトをクリアします。既存の name、必須の ruleTimezone、完全な alertOpt を同時に送信して深層検証をトリガーすることを推奨します。通知設定のみの変更は現在のコードでは深層検証をスキップする可能性があり、成功しても対象構造が必ず実行可能であることを意味しません。この v1 インターフェースは通知ポリシーのみを保存し、モニター/SLO/セキュリティルールのバインディングは変更しません。バインディングを調整する場合は v2 を使用してください。現在のバージョンではトップレベルの ruleTimezone は保存および表示されますが、実行時キャッシュは履歴の alertOpt.ruleTimezone を読み取り、デフォルトは Asia/Shanghai です。他のタイムゾーンは保存成功のみで有効になったと判断できず、連携側は実際の実行タイムゾーンで検証する必要があります。宣言されていない追加フィールドで公開パラメータを回避しないでください。保存とキャッシュ更新は通知の配信を意味せず、実際の送信は有効なターゲット、イベントレベル、時間帯、フィルター、重複抑制、アラート実行サービスに依存します。失敗またはタイムアウト後は、まずポリシーとバインディング状態を読み取り、重複作成や部分更新の誤判定を避けてください。

ルートパラメータ

パラメータ名 型 必須 説明
alert_policy_uuid string Y 現在のワークスペースのアラートポリシーUUID。
例: altpl_example
取得または入力方法: アラートポリシー一覧のcontent.data[].uuidから取得し、変更前にアラートポリシー詳細で確認します。

リクエストヘッダー

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

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_high のように security_ プレフィックスを使用します。
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 を選択します。
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.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.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 を入力します。
desc string 任意の説明。最大 256 文字。作成時に省略すると空文字列になり、変更時に省略すると保持され、空文字列を渡すとクリアされます。
空文字列許可: True
null 許可: False
最大長: 256
例: 生产服务异常通知与升级。
取得または入力方法: ポリシーが担当する業務範囲に応じて入力します。
name string 任意の新しい名前。省略時は保持されます。既存の name を送信して深層パラメータ検証をトリガーすることを推奨します。
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)を選択します。現在の実行側の制限については使用手順を参照してください。

パラメータ補足説明

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"
                    ]
                  }
                ]
              }
            ]
          }
        ]
      }
    ]
  }
}

リクエスト例

curl --request POST 'https://openapi.guance.com/api/v1/alert_policy/altpl_example/modify' \
  -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"]}]}]}}'

レスポンス

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

フィールド 型 説明
content.id 整数または 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": 42,
    "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": "wsak_example",
    "createAt": 1785430800,
    "updateAt": 1785430860,
    "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 を提供してください。
404 ft.NotFound ポリシーが存在しない、削除済み、または現在のワークスペースに属していません 業務ルートが見つかりません アラートポリシー一覧から有効な UUID を再取得します。
403 ft.ForbiddenAlertPolicyOperation 現在のアイデンティティがポリシーのカスタム操作権限を通過していません アラートポリシー【{}】の操作権限がありません 作成者、owner、または権限を付与された主体で操作し、まず permissionSet を確認します。
403 ft.Forbidden カスタム権限が無効な場合、現在のアイデンティティに API 操作権限がありません 操作権限がありません 操作権限を持つ API Key を使用します。

フィードバック

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