查询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"
}]
}
}
状态码
请参考 状态码
错误码
请参考 错误码
