查詢防火墻的簡要信息
更新時間 2024-12-05 17:31:11
最近更新時間: 2024-12-05 17:31:11
分享文章
接口功能介紹
查詢防火墻的簡要信息
接口約束
傳參規范
URI
GET /vfw/v2_firewall_simple_query
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| firewallId | 是 | String | 防火墻id | dca4f9ffaca2447aa24310c1e62c4690 | |
| firewallName | 否 | String | 防火墻名稱 | ||
| firewallType | 否 | String | 防火墻類型 NorthSouth 南北向 EastWest東西向 | ||
| firewallState | 否 | String | 防火墻狀態 normal-正常 overdue-已到期 unsubscribe-已退訂 processing-開通中 | ||
| firewallStateExclude | 否 | String | 過濾防火墻狀態 normal-正常 overdue-已到期 unsubscribe-已退訂 processing-開通中 | ||
| masterOrderId | 否 | String | 主訂單ID | ||
| masterResourceIds | 否 | Array of Strings | 主資源IDs | ||
| masterResourceId | 否 | String | 主資源ID | ||
| page | 否 | Integer | 頁碼 | 1 | |
| size | 否 | Integer | 條數 | 10 | |
| isDelete | 否 | Boolean | 是否刪除 | false | |
| state | 否 | Boolean | 是否退訂 | true |
請求參數
請求頭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 | 結果集 | FirewallEntity | |
| 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 |
表 FirewallEntity
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| firewallEdition | String | 防火墻版本 | ||
| firewallId | String | 防火墻id | ||
| firewallName | String | 防火墻名稱 | ||
| uid | String | 賬戶id | ||
| userId | String | 用戶id | ||
| regionId | String | 資源池id | ||
| azId | String | 可用區id | ||
| masterOrderId | String | 主訂單ID | ||
| masterResourceId | String | 主資源ID | ||
| orderId | String | 訂單ID | ||
| state | Boolean | 防火墻狀態 true-正常 false-退訂 | ||
| flowProcessingCapacity | Integer | 公網流量處理能力(單位Mbps) | 100 | |
| protectionIpNum | Integer | 可防護公網IP數 | 1 | |
| orderTime | Long | 訂購時間 | ||
| expireTime | Long | 到期時間 | ||
| isDelete | Boolean | 是否軟刪除 | ||
| String | ||||
| firewallType | String | 防火墻類型 NorthSouth 南北向 EastWest東西向 | ||
| vpcFlowProcessingCapacity | Integer | vpc流量處理能力(單位Mbps) | 100 | |
| vpcQuota | Integer | 可防護VPC配額 | 1 |
枚舉參數
無
請求示例
請求url
無
請求頭header
{
"regionid": "100054c0416811e9a6690242ac110002",
"urlType": "CTAPI"
}
請求體body
{}
響應示例
{
"statusCode": "800",
"error": "CFW_0000",
"message": "成功!",
"returnObj": [
"total": 2,
"list": [
{
"id": 42,
"firewallId": "c7cfe772fd3f482da630132e6548a19a",
"firewallName": "CFW-9d6b",
"firewallEdition": "Enterprise",
"uid": "e974b0438b814fc08ec8e499643e530f",
"userId": "60b0d272307d408dacda2b16060962c8",
"regionId": "b342b77ef26b11ecb0ac0242ac110002",
"azId": "cn-xinan1-2A",
"masterResourceId": "02bffe2828194d03bfd5b62f7ed0ed77",
"masterOrderId": "3d0a5d193e7e40e4bb62a80609941160",
"orderId": "2a496cc6d2164034a9f93d7bcc27e4ca",
"state": true,
"protectionIpNum": 28,
"flowProcessingCapacity": 2485,
"orderTime": 1726190877499,
"expireTime": 1731550194000,
"isDelete": false,
"email": "sec22080013@163.com",
"firewallType": "NorthSouth",
"vpcQuota": 8,
"vpcFlowProcessingCapacity": 2000
},
{
"id": 43,
"firewallId": "92b8fc784068481187f1c4064296a4dd",
"firewallName": "CFW-9d6b-VPC",
"firewallEdition": "Enterprise",
"uid": "e974b0438b814fc08ec8e499643e530f",
"userId": "60b0d272307d408dacda2b16060962c8",
"regionId": "b342b77ef26b11ecb0ac0242ac110002",
"azId": "cn-xinan1-3A",
"masterResourceId": "02bffe2828194d03bfd5b62f7ed0ed77",
"masterOrderId": "3d0a5d193e7e40e4bb62a80609941160",
"orderId": "2a496cc6d2164034a9f93d7bcc27e4ca",
"state": true,
"orderTime": 1726190877499,
"expireTime": 1731550194000,
"isDelete": false,
"email": "sec22080013@163.com",
"firewallType": "EastWest",
"vpcQuota": 10,
"vpcFlowProcessingCapacity": 2600
}
],
"pageNum": 1,
"pageSize": 2147483646,
"size": 2,
"startRow": 1,
"endRow": 2,
"pages": 1,
"prePage": 0,
"nextPage": 0,
"isFirstPage": true,
"isLastPage": true,
"hasPreviousPage": false,
"hasNextPage": false,
"navigatePages": 8,
"navigatepageNums": [
1
],
"navigateFirstPage": 1,
"navigateLastPage": 1
}
}
狀態碼
請參考
錯誤碼
請參考
