接口功能介绍
查询nat列表
接口约束
传参规范
URI
GET /vfw/v2_assert_nat_query
路径参数
无
Query参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| natName | 否 | String | nat名称 | nat-b17cqes8 | |
| page | 否 | Integer | 页码 | 1 | |
| protectStatus | 否 | Boolean | 防护状态 | ||
| size | 否 | Integer | 条数 | 1 |
请求参数
请求头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
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| endRow | Long | 当前页面最后一个元素在数据库中的行号 | ||
| hasNextPage | Boolean | 是否有下一页 | ||
| hasPreviousPage | Boolean | 是否有前一页 | ||
| isFirstPage | Boolean | 是否为首页 | ||
| isLastPage | Boolean | 是否为末页 | ||
| list | Array of Objects | 资产列表 | ListEntity | |
| navigateFirstPage | Integer | 导航条上的第一页 | 1 | |
| navigateLastPage | Integer | 导航条上的最后一页 | 1 | |
| navigatePages | Integer | 导航页码数 | 1 | |
| navigatepageNums | Array of Integers | 所有导航页号 | 1 | |
| nextPage | Integer | 下一页 | 1 | |
| pageNum | Integer | 当前页的页码 | 1 | |
| pageSize | Integer | 每页的数量 | 1 | |
| pages | Integer | 总页数 | 1 | |
| prePage | Integer | 前一页 | 1 | |
| size | Integer | 当前页的数量 | 1 | |
| startRow | Long | 当前页面第一个元素在数据库中的行号 | ||
| total | Long | 总记录数 |
表 ListEntity
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| natId | String | Nat id | natgw-sss | |
| natName | String | nat名称 | nat-b17cqes8 | |
| natStatus | String | Nat状态 | NAT网关运行状态: running 表示运行中, creating 表示创建中, expired 表示已过期, freeze 表示已冻结 delete 已删除 | |
| specs | String | 规格 | VM | |
| firewallEdition | String | 防火墙版本号 | ||
| protectStatus | Boolean | 防护状态 | ||
| vpcId | String | vpc id | vpc-cc91 | |
| vpcIp | String | vpc ip | 192.168.0.0/16 | |
| vpcName | String | vpc名称 | vpc-cc91 | |
| endpoint | Object | 终端节点 | GwlbeInfoVo |
表 GwlbeInfoVo
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| endpointName | String | 终端节点名称 | ||
| endpointId | String | 终端节点id | ||
| vpcName | String | Vpc名称 | ||
| subnetName | String | 子网名称 | ||
| description | String | 描述 |
枚举参数
无
请求示例
请求url
无
请求头header
{
"regionid": "100054c0416811e9a6690242ac110002",
"urlType": "CTAPI"
}
请求体body
{}
响应示例
{
"statusCode": "800",
"error": "CFW_0000",
"message": "成功!",
"returnObj": {
"total": 2,
"list": [
{
"createTime": 1726640830,
"updateTime": 1731348058,
"id": 6,
"uid": "e974b0438b814fc08ec8e499643e530f",
"userId": "60b0d272307d408dacda2b16060962c8",
"regionId": "b342b77ef26b11ecb0ac0242ac110002",
"natId": "natgw-nfhk5w3r6a",
"natName": "nat-d0c1",
"natStatus": "running",
"protectStatus": false,
"vpcIp": "192.168.0.0/16",
"vpcId": "vpc-w2yk897lsx",
"vpcName": "vpc-lwj",
"firewallId": "c7cfe772fd3f482da630132e6548a19a",
"firewallEdition": "Enterprise",
"projectId": "0",
"zoneId": "cn-xinan1-1A",
"syncStatus": "UNCHANGED"
},
{
"createTime": 1726035067,
"updateTime": 1731348058,
"id": 4,
"uid": "e974b0438b814fc08ec8e499643e530f",
"userId": "60b0d272307d408dacda2b16060962c8",
"regionId": "b342b77ef26b11ecb0ac0242ac110002",
"natId": "natgw-4vmlrmdgii",
"natName": "nat-be75",
"natStatus": "running",
"protectStatus": false,
"vpcIp": "192.168.0.0/16",
"vpcId": "vpc-w2yk897lsx",
"vpcName": "vpc-lwj",
"firewallId": "c7cfe772fd3f482da630132e6548a19a",
"firewallEdition": "Enterprise",
"projectId": "0",
"zoneId": "cn-xinan1-1A",
"syncStatus": "UNCHANGED"
}
],
"pageNum": 1,
"pageSize": 10,
"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
}
}
状态码
请参考 状态码
错误码
请参考 错误码
