変更 v2¶
POST /api/v1/alert_policy/{alert_policy_uuid}/modify_v2
概要¶
アラートポリシーを変更し、モニター/SLO/セキュリティルールのバインディングを完全に管理します。
呼び出し前の確認事項と使用手順¶
まず詳細を読み取り、完全なターゲットの alertOpt で置き換えます。alertOpt を省略すると元の設定が保持され、{} を渡すとそのオブジェクトがクリアされます。既存の name、必須の ruleTimezone、完全な alertOpt を同時に送信して詳細検証をトリガーすることを推奨します。通知設定のみの変更では、現在のコードで詳細検証がスキップされる可能性があり、成功してもターゲット構造が必ず実行可能であるとは限りません。v2 では同時にバインディングを管理します。変更時、checkerUUIDs と securityRuleUUIDs はどちらも完全なターゲット集合を表し、いずれかを省略した場合も [] として対応するバインディングをクリアします。保持するには、事前に詳細を取得して完全に返す必要があります。クライアントは、同じワークスペース内のモニター/SLO/セキュリティルールを項目ごとに検証する必要があります。サーバー側は存在しない識別子をフィルタリングする可能性がありますが、すべての UUID のワークスペース所属を完全に検証するわけではなく、成功してもバインディングが有効であることを証明せず、項目ごとの確認も提供しません。現在のバージョンではトップレベルの 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_ プレフィックスを使用します(例: 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 | 任意の新しい名前。省略時は保持されます。既存の 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)。現在の実行側の制限については使用上の説明を参照してください。 |
| 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/altpl_example/modify_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": 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 を使用してください。 |