接口功能介绍
查询防火墙配置的ips规则
接口约束
传参规范
URI
GET /vfw/v2_ips_rule_query
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| firewallId | 是 | String | 防火墙id | ||
| method | 否 | String | 攻击类型 | ||
| page | 否 | Integer | 页码 | 1 | |
| ruleId | 否 | Long | 规则id | ||
| ruleIds | 否 | Array of Longs | 规则ids | ||
| size | 否 | Integer | 条数 | 10 | |
| target | 否 | String | 攻击对象 | ||
| type | 否 | String | 类型 method-攻击类型 target-攻击对象 |
请求参数
请求头header参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| urlType | 是 | String | 请求地址类型 | CTAPI | |
| regionId | 是 | String | 资源池id | 100054c0416811e9a6690242ac110002 |
请求体body参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | String | 状态码 | ||
| message | String | 返回信息 | 成功 | |
| error | String | 错误码：CFW_0000 :成功!;CFW_0001:参数错误！;CFW_0002：业务错误！ | CFW_0000 | |
| returnObj | Object | 接口返回结果 | PageInfo |
表 PageInfo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| total | Integer | 总记录数 | 1 | |
| list | Array of Objects | 结果集 | IpsRuleEntity | |
| pageNum | Integer | 当前页的页码 | 1 | |
| pageSize | Integer | 每页的数量 | 10 | |
| size | Integer | 当前页的数量 | 1 | |
| startRow | Long | 当前页面第一个元素在数据库中的行号 | 1 | |
| endRow | Long | 当前页面最后一个元素在数据库中的行号 | 1 | |
| pages | Integer | 总页数 | 1 | |
| prePage | Integer | 前一页 | 0 | |
| nextPage | Integer | 下一页 | 0 | |
| isFirstPage | Boolean | 是否为首页 | true | |
| isLastPage | Boolean | 是否为末页 | true | |
| hasPreviousPage | Boolean | 是否有前一页 | false | |
| hasNextPage | Boolean | 是否有下一页 | false | |
| navigatePages | Integer | 导航页码数 | 8 | |
| navigatepageNums | String | 所有导航页号 | [1] | |
| navigateFirstPage | Integer | 导航条上的第一页 | 1 | |
| navigateLastPage | String | 导航条上的最后一页 | 1 |
表 IpsRuleEntity
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| action | String | 动作 | ||
| cnnvd | String | 安全漏洞库 | ||
| cve | String | cve | ||
| descCn | String | 描述-中文 | ||
| descEn | String | 描述 | ||
| level | String | 等级 | ||
| method | Array of Strings | 获取method类别的规则 | ||
| methodCn | Array of Strings | 获取method类别的规则-中文 | ||
| methodCnFirst | Array of Strings | 获取一级method类别的规则-中文 | ||
| methodCnSecond | Array of Strings | 获取二级method类别的规则-中文 | ||
| methodFirst | Array of Strings | 获取一级method类别的规则 | ||
| methodSecond | Array of Strings | 获取二级method类别的规则 | ||
| name | String | 规则名称 | ||
| nameCn | String | 规则名称-中文 | ||
| ruleId | Long | 规则id rule_id和type二选一: 指定rule_id时，获取指定id规则信息; 指定type时，指定该分类的所有规则 | ||
| target | Array of Strings | 获取target类别的规则 | ||
| targetCn | Array of Strings | 获取target类别的规则-中文 | ||
| targetCnFirst | Array of Strings | 获取一级target类别的规则-中文 | ||
| targetCnSecond | Array of Strings | 获取二级target类别的规则-中文 | ||
| targetFirst | Array of Strings | 获取一级target类别的规则 | ||
| targetSecond | Array of Strings | 获取二级target类别的规则 | ||
| type | String | 规则类别 rule_id和type二选一 base: 普通规则 vpatch: 虚拟补丁规则 |
枚举参数
无
请求示例
请求url
/vfw/v2_ips_rule_query?firewallId=92b8fc784068481187f1c4064296a4dd&ruleIds[]=43049
请求头header
{
"regionid": "100054c0416811e9a6690242ac110002",
"urlType": "CTAPI"
}
请求体body
{}
响应示例
{
"statusCode": "800",
"error": "CFW_0000",
"message": "成功!",
"returnObj": {
"total": 1,
"list": [
{
"createTime": 1721377405,
"updateTime": 1721377405,
"id": 5501,
"type": "base",
"ruleId": 43049,
"descEn": "POP3 Weak Password Login Attempt",
"descCn": "在POP3用户登录时，检测到仅由字符、数字组成的低于8个字符的弱口令。",
"level": "middle",
"method": [
"InformationDisclosure-WeakPassword"
],
"methodFirst": [
"InformationDisclosure"
],
"methodSecond": [
"WeakPassword"
],
"methodCn": [
"信息收集类攻击-弱密码"
],
"methodCnFirst": [
"信息收集类攻击"
],
"methodCnSecond": [
"弱密码"
],
"name": "POP3_Weak_Password_Login_Attempt(TCP)",
"nameCn": "POP3 弱口令(TCP)",
"target": [
"MailServer-Any"
],
"targetFirst": [
"MailServer"
],
"targetSecond": [
"Any"
],
"targetCn": [
"邮件服务器-任意"
],
"targetCnFirst": [
"邮件服务器"
],
"targetCnSecond": [
"任意"
],
"action": "alert"
}
],
"pageNum": 1,
"pageSize": 10,
"size": 1,
"startRow": 1,
"endRow": 1,
"pages": 1,
"prePage": 0,
"nextPage": 0,
"isFirstPage": true,
"isLastPage": true,
"hasPreviousPage": false,
"hasNextPage": false,
"navigatePages": 8,
"navigatepageNums": [
1
],
"navigateFirstPage": 1,
"navigateLastPage": 1
},
"statusCode": "800"
}
状态码
请参考 状态码
错误码
请参考 错误码
