Query SNAT rules
Updated at:2025-10-16
Query SNAT rules
Description
Query SNAT rule information of the NAT gateway
Request structure
Plain Text
1GET /v{version}/nat/{natId}/snatRule?marker={marker}&maxKeys={maxKeys} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
Request headers
There are no special headers required beyond the common headers.
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number |
| marker | String | No | Query | The starting position of the batch list query is a system-generated string |
| maxKeys | Integer | No | Query | The maximum number of items per page is 1,000, with a default value of 1,000. |
| natId | String | Yes | URL parameter | ID of NAT gateway |
Response headers
No special headers are required beyond the standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| marker | String | Mark the starting position of the query. |
| isTruncated | boolean | true indicates there is more data later, false indicates it is the last page |
| nextMarker | String | The marker value needed to fetch the next page. This field is absent when isTruncated is false. |
| maxKeys | Integer | Maximum number of items included per page |
| rules | List<[SnatRule](VPC/API Reference/Appendix.md#SnatRule)> | List of SNAT rules |
Request example
Plain Text
1GET /v1/nat/nat-brkztytqzbh0/snatRule?maxKeys=2 HTTP/1.1
2Host: bcc.bj.baidubce.com
3ContentType: application/json
4Authorization: bce-auth-v1/f81d3b34e48048fbb2634dc7882d7e21/2017-03-11T04:17:29Z/3600/ host/74c506f68c65e26c633bfa104c863fffac5190fdec1ec24b7c03eb5d67d2e1de
Response example
Plain Text
1HTTP/1.1 200 OK
2x-bce-request-id: 1214cca7-4ad5-451d-9215-71cb844c0a50
3Date: Thu, 16 Mar 2017 06:29:48 GMT
4Content-Type: application/json;charset=UTF-8
5Server: BWS
6{
7 "isTruncated": true,
8 "nextMarker": "rule-vza86i2k6dqu",
9 "maxKeys": 2,
10 "rules": [
11 {
12 "ruleId": "rule-k1jenum3v9s6",
13 "ruleName": "s3",
14 "publicIpsAddress": [
15 "100.88.10.185"
16 ],
17 "sourceCIDR": "1.1.1.1/32",
18 "status": "configuring"
19 },
20 {
21 "ruleId": "rule-kdgqkwpske2q",
22 "ruleName": "s2",
23 "publicIpsAddress": [
24 "100.88.10.185"
25 ],
26 "sourceCIDR": "192.168.1.0/24",
27 "status": "configuring"
28 }
29 ]
30}
