查询NAT网关列表
更新时间：2023-09-11
描述
查询NAT网关列表。
- 可根据NAT网关ID、NAT网关的name、NAT网关绑定的EIP来查询。
- 若不提供查询条件，则默认查询覆盖所有NAT网关
请求结构
GET /v{version}/nat?vpcId={vpcId}&natId={natId}&name={name}&ip={ip}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization string请求参数
| 参数名称 | 类型 | 是否必需 | 参数位置 | 描述 |
|---|---|---|---|---|
| version | String | 是 | URL参数 | API版本号，当前取值1 |
| vpcId | String | 是 | Query参数 | vpc的ID |
| natId | String | 否 | Query参数 | 指定查询的NAT的Id |
| name | String | 否 | Query参数 | 指定查询的NAT的名称 |
| ip | String | 否 | Query参数 | 指定查询的NAT绑定的EIP |
| marker | String | 否 | Query参数 | 批量获取列表的查询的起始位置，是一个由系统生成的字符串 |
| maxKeys | int | 否 | Query参数 | 每页包含的最大数量，最大数量不超过1000。缺省值为1000 |
返回头域
除公共头域外，无其他特殊头域。
返回参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| nats | List<NAT> | 包含查询结果的列表 |
| marker | string | 标记查询的起始位置，若结果列表为空，此项不存在 |
| isTruncated | boolean | true表示后面还有数据，false表示已经是最后一页 |
| nextMarker | String | 获取下一页所需要传递的marker值。当isTruncated为false时，该域不出现 |
| maxKeys | int | 每页包含的最大数量 |
请求示例
GET /v1/nat?vpcId=vpc-13vuxu016dew&name=mynat&maxKeys=2 HTTP/1.1
Host: bcc.bj.baidubce.com
authorization: bce-auth-v1/bf427691810a11e8a106475a8496ca04/2018-07-06T11:02:49Z/3600/host;x-bce-account;x-bce-client-ip;x -bce-date;x-bce-request-id;x-bce-security-token/e84ee938f6466428ff5c16b3562a1cbf3db5928e7f863cedec8820b5d98aa474返回示例
HTTP/1.1 200 OK
Date: Fri, 06 Jul 2018 11:12:34 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"nats":[
{
"id":"nat-bir8biqwr45e",
"name":"mynat",
"vpcId":"vpc-13vuxu016dew",
"spec":"small",
"status":"unconfigured",
"eips":[
],
"paymentTiming":"Prepaid",
"expiredTime":"2018-08-13T08:10:59Z",
"createTime": "2021-04-25 17:22:34"
},
{
"id":"nat-b9q8n98mdxwc",
"name":"mynat",
"vpcId":"vpc-13vuxu016dew",
"spec":"small",
"status":"unconfigured",
"eips":[
],
"paymentTiming":"Prepaid",
"expiredTime":"2018-07-27T13:18:00Z",
"createTime": "2021-04-25 17:22:34"
}
]
}
"marker":"nat-b58rnkn1g98h",
"isTruncated": true,
"nextMarker": "nat-bi72s924x5xu",
"maxKeys": 2
}