接口功能介绍
查询 NAT 网关列表
接口约束
需要先创建 NAT 网关
URI
GET /v4/vpc/describe-nat-gateways
请求参数
Query 参数
| 参数 | 参数类型 | 是否必填 | 示例 | 说明 |
|---|---|---|---|---|
| regionID | String | 是 | 区域id | 81f7728662dd11ec810800155d307d5b |
| natGatewayID | String | 否 | 要查询的NAT网关的ID。 | ngw-bp1uewa15k4iy5770 |
| pageNumber | Integer | 否 | 列表的页码，默认值为1。 | 11 |
| pageNo | Integer | 否 | 列表的页码，默认值为 1, 推荐使用该字段, pageNumber 后续会废弃 | 1 |
| pageSize | Integer | 否 | 分页查询时每页的行数，最大值为50，默认值为10。 | 10 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| statusCode | Integer | 返回状态码（800为成功，900为失败） | 800 |
| message | String | statusCode为900时的错误信息; statusCode为800时为success, 英文 | success |
| description | String | statusCode为900时的错误信息; statusCode为800时为成功, 中文 | 成功 |
| errorCode | String | statusCode为900时为业务细分错误码，三段式：product.module.code; statusCode为800时为SUCCESS | SUCCESS |
| returnObj | Array of Objects | 返回结果 | Object |
表 returnObj
| 参数 | 参数类型 | 说明 | 示例 |
|---|---|---|---|
| ID | String | nat 网关 id | natgw-5t4c4gvwhb |
| name | String | nat 网关名字 | natgw-xxx |
| description | String | nat 网关描述 | xxxx |
| status | Integer | nat 网关状态: 0 表示创建中，2 表示运行中，3 表示冻结 | 2 |
| natGatewayID | String | nat 网关 id | natgw-5t4c4gvwhb |
| zoneID | String | 可用区 ID | az1 |
| state | String | running | NAT网关运行状态: running 表示运行中, creating 表示创建中, expired 表示已过期, freeze 表示已冻结 |
| vpcID | String | 虚拟私有云 id | vpc-xxx |
| vpcName | String | 虚拟私有云名字 | vpc-xxx |
| expireTime | String | 过期时间 | 2022-11-02T02:29:43Z |
| creationTime | String | 创建时间 | 2022-11-02T02:29:43Z |
| projectID | String | 项目 ID | 0 |
请求示例
GET /v4/vpc/describe-nat-gateways?regionID=81f7728662dd11ec810800155d307d5b
请求体Body
无
响应示例
{
"statusCode": 800,
"errorCode": "SUCCESS",
"message": "success",
"description": "",
"returnObj": [
{
"ID": "natgw-5t4c4gvwhb",
"name": "natgw-jojo",
"description": "",
"status": 2,
"natGatewayID": "natgw-5t4c4gvwhb",
"zoneID": "az1",
"state": "running",
"vpcID": "vpc-px0u1h710i",
"vpcName": "jojo-vpc",
"expireTime": "2022-11-02T02:29:43Z",
"creationTime": "2022-10-02T02:29:43Z",
"projectID": "0"
},
{
"ID": "natgw-y9jnmh02dm",
"name": "nat-b25c-ldy-1",
"description": "",
"status": 2,
"natGatewayID": "natgw-y9jnmh02dm",
"zoneID": "az1",
"state": "running",
"vpcID": "vpc-og3futkstv",
"vpcName": "vpc-ldy-1",
"expireTime": "2023-01-30T10:12:30Z",
"creationTime": "2022-09-30T10:12:30Z",
"projectID": "0"
}
]
}
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 表示请求成功。 |
错误码
请参考 错误码说明。
