接口功能介绍
查询防火墙的简要信息
接口约束
传参规范
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
}
}
状态码
请参考 状态码
错误码
请参考 错误码
