接口功能介绍
查询防火墙详情
接口约束
传参规范
URI
GET /vfw/v2_firewall_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 | 结果集 | FirewallView | |
| 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 |
表 FirewallView
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ipProtectCount | Integer | 已防护公网IP数 | 1 | |
| ipUnProtectCount | Integer | 可防护公网IP数 | 1 | |
| firewallState | String | 防火墙状态 normal-正常 overdue-已到期 unsubscribe-已退订 | ||
| vpcFirewallName | String | 东西向实例id | ||
| vpcFirewallType | String | 实例类型NorthSouth：VPC边界防火墙 | ||
| canUnsubscribe | Boolean | 能否退订 | ||
| VpcQuotaUsedCount | Integer | vpc已防护 | ||
| ewFirewallId | String | 东西向防火墙id | ||
| 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 | |
| hostIds | String | 主机ids | ||
| gwlbId | String | gwlbId | ||
| targetGroupId | String | 主机组id | ||
| ipListenerId | String | gwlb和主机对应 | 100 | |
| endpointServiceId | String | 网关负载均衡终端节点服务id | 1 |
枚举参数
无
请求示例
请求url
无
请求头header
{
"regionid": "100054c0416811e9a6690242ac110002",
"urlType": "CTAPI"
}
请求体body
{}
响应示例
{
"statusCode": "800",
"message": "成功！",
"returnObj": {
"total": 3,
"list": [
{
"createTime": 1724305528,
"updateTime": 1729671519,
"id": 32,
"firewallId": "91e76b89efea420595fd859baf4eb2e4",
"firewallName": "CFW-d864",
"firewallEdition": "Enterprise",
"uid": "6069fd7ea3b943a287fea8de5ade38ab",
"userId": "0beb89c5a9924b7d90593a414391c721",
"regionId": "b342b77ef26b11ecb0ac0242ac110002",
"azId": "cn-xinan1-2A",
"masterResourceId": "c3c4a693760d4ef1b06c185dbe94577b",
"masterOrderId": "35bc35bccafe4494a2da119e5909f4be",
"orderId": "04a15f8501684b5fbc9ef1ed3d01aef6",
"state": true,
"protectionIpNum": 20,
"flowProcessingCapacity": 50,
"orderTime": 1729586924375,
"expireTime": 1732265321000,
"isDelete": false,
"email": "sec22080002@163.com",
"hostIds": "b71aa622-0176-baec-45c3-635dd443d57b,1e05f9ba-7512-076c-2d7a-4847faaa2612",
"gwlbId": "gwlb-8zkhbmx30t",
"targetGroupId": "tg-1q5o0fthq7",
"ipListenerId": "iplistener-ax863vue48",
"endpointServiceId": "endpser-vr4ay48e8b",
"createOrderId": "INT042024102216462496065544",
"firewallType": "NorthSouth",
"vpcQuota": 2,
"vpcFlowProcessingCapacity": 200,
"ipProtectCount": 0,
"ipUnProtectCount": 20,
"firewallState": "normal",
"vpcFirewallName": "CFW-d864-VPC",
"vpcFirewallType": "EastWest",
"canUnsubscribe": false,
"ewFirewallId": "092408be0cac4762bc24cc6cd9752d56",
"vpcQuotaUsedCount": 3
}
],
"pageNum": 1,
"pageSize": 10,
"size": 3,
"startRow": 1,
"endRow": 3,
"pages": 1,
"prePage": 0,
"nextPage": 0,
"isFirstPage": true,
"isLastPage": true,
"hasPreviousPage": false,
"hasNextPage": false,
"navigatePages": 8,
"navigatepageNums": [
1
],
"navigateFirstPage": 1,
"navigateLastPage": 1
},
"error": "CFW_0000"
}
状态码
请参考 状态码
错误码
请参考 错误码
