変更（このAPIは2025-12-30に廃止されました。v2版APIの使用を推奨します）¶
POST /api/v1/alert_policy/{alert_policy_uuid}/modify
概要¶
alert_policy_uuid に基づいて、指定されたアラートポリシーの設定情報を変更します。
ルートパラメータ¶
| パラメータ名 | 型 | 必須 | 説明 |
|---|---|---|---|
| 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 |
|
| ruleTimezone | str | Y | アラートポリシーのタイムゾーン 例: Asia/Shanghai 空許容: False |
| alertOpt | json | アラート設定 空許容: 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 |
パラメータ補足説明¶
リクエスト例¶
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"
}