コンテンツにスキップ

修正 v2¶

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

概要¶

指定された alert_policy_uuid に基づいてアラートポリシーの設定情報を変更します。v2 では、関連するモニター/インテリジェントモニター/インテリジェントインスペクション/SLO/セキュリティモニタリングの同期更新をサポートします。

ルートパラメータ¶

パラメータ名	タイプ	必須	説明
alert_policy_uuid	string	Y	アラートポリシー UUID

Body リクエストパラメータ¶

パラメータ名	タイプ	必須	説明
name	string		モニター名空を許可: False
desc	string		説明空を許可: False 空文字列を許可: True 最大長: 256
openPermissionSet	boolean		カスタム権限設定を有効にする（デフォルト false: 無効）。有効にすると、このルールの操作権限は permissionSet に基づきます空を許可: False
permissionSet	array		操作権限の設定（ロール（所有者を除く）、メンバー UUID、チーム UUID を設定可能）例: ['wsAdmin', 'acnt_xxxx', 'group_yyyy'] 空を許可: False
checkerUUIDs	array		モニター/インテリジェントモニター/インテリジェントインスペクション/SLO の UUID（2024-12-11 イテレーションで追加）例: ['rule_xxx', 'monitor_xxx'] 空を許可: False
securityRuleUUIDs	array		セキュリティモニタリング（cspm, siem, aba）の UUID 例: ['srul_xxx', 'srul_xxx', 'srul_xxx'] 空を許可: False
ruleTimezone	str	Y	アラートポリシーのタイムゾーン例: Asia/Shanghai 空を許可: False
alertOpt	json		アラート設定空を許可: False
alertOpt.aggType	string		アラート集約タイプ。このフィールドを渡さない場合、デフォルトで旧バージョンのロジックが適用されます（2024-12-25 イテレーションで追加）空を許可: True 選択可能な値: ['byFields', 'byCluster', 'byAI', 'byCustom']
alertOpt.ignoreOK	boolean		詳細設定。正常レベルの場合はイベントのみ生成し、通知を送信しません（OK 通知を無視するかどうか） 2025-10-22 追加フィールド空を許可: False
alertOpt.alertType	string		アラートポリシーの通知タイプ。ステータス(status) またはメンバー(member)、デフォルトはステータス空を許可: False 選択可能な値: ['status', 'member']
alertOpt.silentTimeout	integer		繰り返しアラートの設定空を許可: False
alertOpt.silentTimeoutByStatusEnable	boolean		ステータス別の繰り返しアラート設定を有効にするかどうか。デフォルト false の場合は silentTimeout を使用空を許可: False
alertOpt.silentTimeoutByStatus	array		ステータス別の繰り返しアラート設定。ステータス別の最小アラート間隔設定空を許可: False
alertOpt.alertTarget	array		トリガーアクション。トリガー時間のパラメータ処理に注意例: [{'name': '通知設定1', 'targets': [{'to': ['acnt_xxxx32'], 'status': 'critical', 'tags': {'pod_name': ['coredns-7769b554cf-w95fk']}, 'upgradeTargets': [{'to': ['acnt_xxxx32'], 'duration': 600}, {'to': ['group_xxxx32'], 'duration': 6000}]}], 'crontabDuration': 600, 'crontab': '0 9 * * 0,1,2,3,4'}, {'name': '通知設定2', 'targets': [{'status': 'error', 'to': ['group_xxxx32'], 'upgradeTargets': [{'to': ['acnt_xxxx32'], 'duration': 600}, {'to': ['group_xxxx32'], 'duration': 6000}]}], 'customDateUUIDs': ['ndate_xxxx32'], 'customStartTime': '09:30:10', 'crontabDuration': 600}] 空を許可: False
alertOpt.aggInterval	integer	Y	アラート集約間隔（秒）。0 は集約なしを意味します空を許可: False $minValue: 0 $maxValue: 1800
alertOpt.aggFields	array		集約フィールドのリスト。空のリスト [] は「集約ルール：すべて」を意味します。df_monitor_checker_id：モニター/インテリジェントインスペクション/SLO、df_dimension_tags：検出ディメンション、df_label：ラベル、CLUSTER：インテリジェント集約例: ['CLUSTER'] 空を許可: False
alertOpt.aggLabels	array		ラベル集約時のラベル値リスト。aggFields に df_label が指定されている場合のみ有効空を許可: False
alertOpt.aggClusterFields	array		インテリジェント集約時のフィールドリスト。aggFields に CLUSTER が指定されている場合のみ有効。選択可能な値: "df_title"：タイトル, "df_message"：内容例: ['df_title'] 空を許可: False
alertOpt.aggSendFirst	boolean		集約時に最初のアラートを直接送信するかどうか（2025-09-03 イテレーションで追加されたパラメータ）空を許可: False

パラメータ補足説明¶

リクエスト例¶

curl 'https://openapi.guance.com/api/v1/alert_policy/altpl_xxxx32/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"name":"jj_modify","ruleTimezone":"Asia/Shanghai","alertOpt":{"alertTarget":[{"targets":[{"status":"warning","to":["notify_xxxx32"]}]}],"silentTimeout":21600,"aggInterval":120,"aggFields":["df_monitor_checker_id"]}}' \
--compressed

レスポンス¶

{
    "code": 200,
    "content": {
        "alertOpt": {
            "aggFields": [
                "df_monitor_checker_id"
            ],
            "aggInterval": 120,
            "alertTarget": [
                {
                    "targets": [
                        {
                            "status": "warning",
                            "to": [
                                "notify_xxxx32"
                            ]
                        }
                    ]
                }
            ],
            "silentTimeout": 21600
        },
        "createAt": 1706152082,
        "creator": "xxxx",
        "declaration": {},
        "deleteAt": -1,
        "id": 4100,
        "name": "jj_modify",
        "ruleTimezone": "Asia/Shanghai",
        "score": 0,
        "status": 0,
        "updateAt": 1706152339.7920609,
        "updator": "xxx",
        "uuid": "altpl_xxxx32",
        "workspaceUUID": "wksp_xxxx32"
    },
    "errorCode": "",
    "message": "",
    "success": true,
    "traceId": "TRACE-D38C6668-6F44-45E8-B8A4-BD28EBF142DE"
}