查詢NAT網關列表v3
更新時間 2025-09-24 10:36:26
最近更新時間: 2025-09-24 10:36:26
分享文章
接口功能介紹
查詢NAT網關列表v3
接口約束
無
URI
GET /v3/nat/describe
路徑參數 無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| regionId | 是 | String | 資源池ID。 | xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | |
| name | 否 | String | NAT網關名稱 | ||
| pageNum | 否 | Integer | 頁碼，至少1，默認1 | ||
| pageSize | 否 | Integer | 每頁數量，最大100，默認10 |
請求參數
請求頭header參數 無
請求體body參數 無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 狀態碼。可能值： - 800：請求成功。 - 900：請求失敗。 | 800 | |
| error | String | 錯誤碼。 | ECPC_1000 | |
| message | String | 提示信息。 | OK. | |
| returnObj | Object | 返回數據對象 | returnObj | |
| 表 returnObj |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| total | Long | 總記錄數 | ||
| list | Array of Objects | 數據列表 | list | |
| 表 list |
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| natOid | String | NAT網關ID | XXXXXXXXXXXXX | |
| name | String | NAT網關名稱 | ||
| vpcOid | String | VPC ID | ||
| vpcName | String | VPC名稱 | ||
| subnetName | String | 子網名稱 | ||
| subnetCidr | String | 子網網段 | ||
| spec | String | 規格（LITTLE-小型;LARGE-大型） | ||
| description | String | 描述 | ||
| source | String | 來源（RESOURCE_PACK-資源包） | ||
| status | String | NAT網關狀態（CREATING-創建中;ACTIVE-正常;FROZEN-凍結中;DELETING-刪除中;ERROR-異常） | ||
| createTime | String | 創建時間。以ISO 8601為標準，并使用UTC+0時間，格式為yyyy-MM-ddTHH:mm:ssZ。 |
枚舉參數
無
請求示例
請求url
無
請求頭header
無
請求體body
無
響應示例
{
"statusCode":800,
"message":"OK.",
"returnObj":{
"total":1,
"list":[{
"natOid":"XXXXXXXXXXXXX",
"name":"NAT網關示例名稱",
"vpcOid":"xxxxx",
"vpcName":"VPC示例名稱",
"subnetName":"子網示例名稱",
"subnetCidr":"XXX.XXX.XXX.XXX/XX",
"spec":"LITTLE",
"description":"NAT網關描述",
"source":"RESOURCE_PACK",
"status":"ACTIVE",
"createTime":"2099-09-09T00:00:00Z"
}]
}
}
狀態碼
請參考
錯誤碼
請參考
