查詢ips規則
更新時間 2024-12-05 17:31:11
最近更新時間: 2024-12-05 17:31:11
分享文章
接口功能介紹
查詢防火墻配置的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"
}
狀態碼
請參考
錯誤碼
請參考
