接口功能介绍
获取通知设置
接口约束
传参规范
URI
GET /vfw/v2_notification
路径参数
无
Query参数
无
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| urlType | 是 | String | 请求地址类型 | CTAPI | |
| regionId | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 状态码 | ||
| message | String | 返回信息 | 成功 | |
| error | String | 错误码：CFW_0000 :成功!;CFW_0001:参数错误！;CFW_0002：业务错误！ | CFW_0000 | |
| returnObj | Array of Objects | 接口返回结果 | NotificationInfo |
表 NotificationInfo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| notifyId | String | 通知id | c6580ef2-02d6-4af4-8cae-1e46c140d3ae | |
| subscribeUserInfos | Array of Objects | 订阅人 | SubscribeUserInfoView | |
| notifyTitle | String | 通知名称 | 入侵检测告警 | |
| notifyType | Array of Strings | 通知类型 | ["SERIOUS","HIGH","MEDIUM"] | |
| notifyMethod | Array of Strings | 通知方式 | ["EMAIL"] | |
| timeRange | Array of Integers | 订阅时间范围 | [8,20] | |
| subscriberCount | Integer | 订阅人数 | 1 | |
| status | Integer | 状态 | 1 |
表 SubscribeUserInfoView
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| String | 用户登录邮箱 | 844*@qq.com | ||
| lastNoticedTime | String | 上一次发送时间 | 2024-10-24T16:00:24Z | |
| userId | String | 用户id | 913d6b7d9a1b46769af6c1de79046a06 | |
| name | String | 用户名称 | 8*61 | |
| selected | Integer | 是否被选中 | 1 |
枚举参数
无
请求示例
请求url
无
请求头header
{
"regionid": "100054c0416811e9a6690242ac110002",
"urlType": "CTAPI"
}
请求体body
{}
响应示例
{
"statusCode": "800",
"error": "CFW_0000",
"message": "成功!",
"returnObj": {
"notifyList": [
{
"notifyId": "c6580ef2-02d6-4af4-8cae-1e46c140d3ae",
"notifyTitle": "入侵检测告警",
"notifyType": [
"SERIOUS",
"HIGH",
"MEDIUM"
],
"notifyMethod": [
"EMAIL"
],
"timeRange": [
8,
20
],
"subscriberCount": 1,
"status": 1,
"users": [
{
"userId": "9fed79ddab744ca2aee039454ef1dd4c",
"name": "d*em",
"email": "dba*@163.com",
"selected": 0
},
{
"userId": "81d45010a9824ead9e5b1a86499a2bee",
"name": "d*it",
"email": "dba*@163.com",
"selected": 0
},
{
"userId": "eed24db80ef942e0af4a1284d88b3fbd",
"name": "t*23",
"email": "494*@qq.com",
"selected": 0
},
{
"userId": "c09bbcb66d74402b9709d1deaaa0c9f1",
"name": "s*y",
"email": "sha*@chinatelecom.cn",
"selected": 1
},
{
"userId": "0beb89c5a9924b7d90593a414391c721",
"name": "s*om",
"email": "sec*@163.com",
"selected": 0
}
]
}
]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
