Schedule Modification¶
POST /api/v1/notification_schedule/{notification_schedule_uuid}/modify
Overview¶
Modify a schedule
Route Parameters¶
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| notification_schedule_uuid | string | Y | Schedule uuid |
Body Request Parameters¶
| Parameter Name | Type | Required | Description |
|---|---|---|---|
| name | string | Y | Name Allow empty: False Maximum length: 256 Allow empty string: False |
| timezone | string | Time zone, default Asia/Shanghai Example: Asia/Shanghai Allow empty: False Maximum length: 48 |
|
| start | string | Y | Time period start time Example: 00:00 Allow empty: False Maximum length: 48 |
| end | string | Y | Time period end time Example: 23:59 Allow empty: False Maximum length: 48 |
| notifyTargets | array | Y | Notification targets, includes account uuid, notification target uuid, email Example: ['acnt_xxx', 'notify_', 'xxx@guance.com'] Allow empty: False |
| extend | json | Extended information, includes rotation notification target configuration Allow empty: False |
|
| extend.enableRotateNotification | boolean | Whether to enable rotation, default off Example: False Allow empty: False |
|
| extend.rotationCycle | string | Rotation cycle, day: day, week: week, month: month, workday: workDay, weekend: weekend Example: day Allow empty: False Optional values: ['day', 'week', 'month', 'workDay', 'weekend'] |
|
| extend.effectiveTime | json | Schedule validity period, default this schedule is permanently valid, start/end time is an 11-digit timestamp Example: {'start': 1719990196, 'end': 1729990196} Allow empty: False |
Additional Parameter Notes¶
Parameter description: Refer to the create interface
Request Example¶
curl 'https://openapi.guance.com/api/v1/notification_schedule/nsche_3512c1f4d176433484676225b547ef7a/modify' \
-H 'DF-API-KEY: <DF-API-KEY>' \
-H 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{"name":"schecule_modify","timezone":"Asia/Shanghai","start":"11:00","end":"23:59","notifyTargets":["acnt_8b4bd2b8782646f3ba8f6554193f5997"],"extend":{"enableRotateNotification":false,"effectiveTime":{"start":1735747200,"end":1737603472}}}' \
--compressed
Response¶
{
"code": 200,
"content": {
"createAt": 1735797896,
"creator": "wsak_f2ba9858f4414655be39efc882b120dd",
"declaration": {},
"deleteAt": -1,
"effectiveTimeInfos": {
"expired": false,
"timeStr": "2025/01/02 00:00:00~2025/01/23 11:37:52"
},
"end": "23:59",
"extend": {
"effectiveTime": {
"end": 1737603472,
"start": 1735747200
},
"enableRotateNotification": false
},
"id": 131,
"name": "schecule_modify",
"notifyTargets": [
"acnt_8b4bd2b8782646f3ba8f6554193f5997"
],
"rotationUpdateAt": 1735798211,
"start": "11:00",
"status": 0,
"timezone": "Asia/Shanghai",
"updateAt": 1735798211,
"updator": "wsak_f2ba9858f4414655be39efc882b120dd",
"uuid": "nsche_3512c1f4d176433484676225b547ef7a",
"workspaceUUID": "wksp_798c5e0f589e4992994196832f64b6ba"
},
"errorCode": "",
"message": "",
"success": true,
"traceId": "TRACE-0AC2A410-36A0-4694-879B-732A416A673B"
}