接口功能介绍
更新通知设置
接口约束
传参规范
URI
POST /vfw/v2_notification_set
路径参数
无
Query参数
无
请求参数
请求头header参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
urlType | 是 | String | 请求地址类型 | CTAPI | |
regionId | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 |
请求体body参数
参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|---|
notifyId | 是 | String | 通知id | c6580ef2-02d6-4af4-8cae-1e46c140d3ae | |
subscribeUserIds | 是 | Array of Strings | 订阅人 | ["1111"] | |
notifyTitle | 是 | String | 通知名称 | 入侵检测告警 | |
notifyType | 是 | Array of Strings | 通知类型 | ["SERIOUS","HIGH","MEDIUM"] | |
notifyMethod | 是 | Array of Strings | 通知方式 | ["EMAIL"] | |
timeRange | 是 | Array of Integers | 订阅时间范围 | [8,20] | |
status | 是 | Integer | 状态 | 1 |
响应参数
参数 | 参数类型 | 说明 | 示例 | 下级对象 |
---|---|---|---|---|
statusCode | String | 状态码 | ||
message | String | 返回信息 | 成功 | |
error | String | 错误码:CFW_0000 :成功!;CFW_0001:参数错误!;CFW_0002:业务错误! | CFW_0000 | |
returnObj | Object | 接口返回结果 | null |
枚举参数
无
请求示例
请求url
无
请求头header
{
"regionid": "100054c0416811e9a6690242ac110002",
"urlType": "CTAPI"
}
请求体body
{
"notifyId": "c6580ef2-02d6-4af4-8cae-1e46c140d3ae",
"notifyTitle": "入侵检测告警",
"notifyType": [
"SERIOUS",
"HIGH"
],
"notifyMethod": [
"EMAIL"
],
"timeRangeType": "workTime",
"isEnabled": true,
"status": 1,
"timeRange": [
8,
20
],
"subscribeUserIds": [
"c09bbcb66d74402b9709d1deaaa0c9f1"
]
}
响应示例
{
"statusCode": "800",
"error": "CFW_0000",
"message": "成功!"
}
状态码
请参考 状态码
错误码
请参考 错误码