查询NAT网关列表
更新时间：2023-05-12
接口描述
本接口用于查询BEC NAT网关列表。
请求结构
GET /v1/nat/list?vpcId={vpcId}®ionId={regionId}&keyword=&keywordType HTTP/1.1
Host: bec.baidubce.com
Authorization: authorization string请求头域
除公共头域外，无其它特殊头域。
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| region | 地域 | query | 否 | string |
| city | 城市 | query | 否 | string |
| serviceProvider | 运营商 | query | 否 | string |
| regionId | 节点ID | query | 否 | string |
| vpcId | VPC ID | query | 否 | string |
| keywordType | 过滤类型：NAT_NAME、NAT_ID，分别表示NAT名称、NAT ID | query | 否 | string |
| keyword | 过滤值 | query | 否 | string |
| pageNo | 页码 | query | 否 | integer |
| pageSize | 每页结果数 | query | 否 | integer |
响应头域
除公共头域外，无其它特殊头域。
响应参数
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| order | 排序顺序 | string |
| orderBy | 排序字段 | string |
| pageNo | 页码 | integer |
| pageSize | 每页结果数 | integer |
| result | NAT网关列表 | List<NatVo> |
| bandwidth | 带宽 | integer |
| createTime | 创建时间 | string |
| desc | 描述 | string |
| dnatEips | 绑定的DNAT EIP地址列表 | List<NatEipVo> |
| ip | DNAT EIP | string |
| serviceProvider | DNAT EIP运营商 | string |
| eips | 绑定的EIP地址列表 | List<NatEipVo> |
| ip | EIP | string |
| serviceProvider | EIP运营商 | string |
| name | 名称 | string |
| natId | ID | string |
| regionId | 节点ID | string |
| spec | 类型。small、mid、large分别代表：普通型（小）、普通型（中）、普通型（大） | string |
| status | 状态。starting：启动中，down：异常，active：可用，deleting：删除中 | string |
| vpcId | VPC ID | string |
| totalCount | 结果总数 | integer |
错误码
请参照错误返回章节的内容。
请求示例
GET /v1/nat/list HTTP/1.1
Host: bec.baidubce.com
Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de响应示例
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Date: Wed, 08 Jul 2015 03:28:11 GMT
x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
Server: BWS
{
"result":[
{
"natId":"nat-cn-changchun-ix-qotjedkx",
"name":"test",
"desc":"test",
"regionId":"cn-changchun-ix",
"vpcId":"vpc-u8wjaroqoqba",
"spec":"small",
"bandwidth":100,
"status":"active",
"dnatEips": [
{
"ip": "1.1.1.2",
"serviceProvider": "CHINA_MOBILE"
}
],
"eips": [
{
"ip": "1.1.1.1",
"serviceProvider": "CHINA_MOBILE"
}
],
"createTime":"2023-02-06T04:05:28Z"
}
],
"orderBy":"createTime",
"order":"desc",
"pageNo":1,
"pageSize":1,
"totalCount":14
}