查询NAT网关列表
更新时间:2024-12-19
接口描述
本接口用于查询BEC NAT网关列表。
请求结构
JSON
1GET /v2/nat?marker={marker}&maxKeys={maxKeys}&name={name}&natId={natId}®ionId={regionId}&vpcId={vpcId}&ip={ip} HTTP/1.1
2Host: bec.baidubce.com
3Authorization: authorization string
请求头域
除公共头域外,无其它特殊头域。
请求参数
| 参数名称 | 参数说明 | 请求类型 | 是否必须 | 数据类型 |
|---|---|---|---|---|
| ip | NAT网关绑定的EIP | query | 否 | string |
| marker | 标记查询的起始位置 | query | 否 | string |
| maxKeys | 每页包含的最大数量,1-1000,默认1000 | query | 否 | integer |
| name | NAT网关名称 | query | 否 | string |
| natId | NAT网关ID | query | 否 | string |
| regionId | NAT网关regionId | query | 否 | string |
| vpcId | NAT网关所属的vpcId | query | 否 | string |
响应头域
除公共头域外,无其它特殊头域。
响应参数
| 参数名称 | 参数说明 | 类型 |
|---|---|---|
| isTruncated | true表示后面还有数据,false表示已经是最后一页 | boolean |
| marker | 标记查询的起始位置 | string |
| maxKeys | 每页包含的最大数量 | integer |
| nats | 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 |
| tags | 标签信息 | List<TagModel> |
| tagKey | 标签键 | String |
| tagValue | 标签值 | String |
| nextMarker | 获取下一页所需要传递的marker值。当isTruncated为false时,该域不出现 | string |
错误码
请参照错误返回章节的内容。
请求示例
JSON
1GET /v2/nat HTTP/1.1
2Host: bec.baidubce.com
3Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2015-08-11T04:17:29Z/3600/host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
响应示例
JSON
1HTTP/1.1 200 OK
2Content-Type: application/json;charset=UTF-8
3Date: Wed, 08 Jul 2015 03:28:11 GMT
4x-bce-request-id: d8752367-38e8-45e4-b4c7-e53be3137ce5
5Server: BWS
6
7
8{
9 "isTruncated": true,
10 "marker": "",
11 "maxKeys": 1,
12 "nats": [
13 {
14 "bandwidth": 100,
15 "createTime": "2023-02-06T04:05:28Z",
16 "desc": "test",
17 "dnatEips": [
18 {
19 "ip": "1.1.1.2",
20 "serviceProvider": "CHINA_MOBILE"
21 }
22 ],
23 "eips": [
24 {
25 "ip": "1.1.1.1",
26 "serviceProvider": "CHINA_MOBILE"
27 }
28 ],
29 "name": "test",
30 "natId": "nat-cn-changchun-ix-qotjedkx",
31 "regionId": "cn-changchun-ix",
32 "spec": "small",
33 "status": "active",
34 "vpcId": "vpc-u8wjaroqoqba",
35 "tags": [
36 {
37 "tagKey": "tagKey",
38 "tagValue": "tagValue"
39 }
40 ]
41 }
42 ],
43 "nextMarker": "nat-cn-changchun-ix-qotjedky"
44}
