查看nat列表
更新時間 2024-12-05 17:31:13
最近更新時間: 2024-12-05 17:31:13
分享文章
接口功能介紹
查詢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
}
}
狀態碼
請參考
錯誤碼
請參考
