Query dedicated gateway list
Updated at：2025-10-16
Description
Query the list of dedicated gateways.
Request structure
Plain Text
1GET /v{version}/etGateway?vpcId={vpcId}&etGatewayId={etGatewayId}&name={name}&status={status}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization stringRequest parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number, current value is 1. |
| vpcId | String | Yes | Query | VPC ID |
| etGatewayId | String | No | Query | ID of the dedicated gateway |
| name | String | No | Query | Name of dedicated gateway, supporting fuzzy search |
| status | String | No | Query | Dedicated gateway status |
| marker | String | No | Query | The starting position of the batch list query is a system-generated string |
| maxKeys | Integer | No | Query | Maximum number of items per page is 1,000, with a default value of 1000. |
Response headers
No additional headers beyond standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| etGateways | List<[EtGateway](VPC/API Reference/Appendix.md#EtGateway)> | List containing query results |
| marker | String | Marker indicating the starting position of the query. If the result list is empty, this field does not exist. |
| isTruncated | Boolean | true indicates there is more data later, false indicates it is the last page |
| nextMarker | String | Obtain the marker value required for retrieving the next page; this field will not appear when isTruncated is false |
| maxKeys | Integer | Maximum number of items included per page |
Request example
Plain Text
1GET /v1/etGateway?vpcId=vpc-IyrqYIQ7&maxKeys=1 HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/bf427691810a11e8a106475a8496ca04/2018-07-06T11:02:49Z/3600/host;x-bce-date/e84ee938f6466428ff5c16b3562a1cbf3db5928e7f863cedec8820b5d98aa474Response example
Plain Text
1HTTP/1.1 200 OK
2Date: Fri, 06 Jul 2018 11:12:34 GMT
3Content-Type: application/json;charset=UTF-8
4Server: BWS
5{
6 "etGateways":[
7 {
8 "etGatewayId": "dcgw-4ds9x3kmds88",
9 "name": "dcGateway",
10 "status": "running",
11 "speed": 100,
12 "createTime": "2016-03-08T08:13:09Z",
13 "description": "",
14 "vpcId": "vpc-IyrqYIQ7",
15 "etId": "dcphy-478px3km77dh",
16 "channelId": "dedicatedconn-i7c1skfd0djs",
17 "localCidrs": ["192.168.0.0/20"],
18 "enableIpv6": 1,
19 "ipv6LocalCidrs": ["2400:da00:e003:0:15f::/87"],
20 "tags":[
21 {
22 "tagKey":"tagKey",
23 "tagValue":"tagValue"
24 }
25 ]
26 }
27 ],
28 "marker":"dcgw-4ds9x3kmds88",
29 "isTruncated": true,
30 "nextMarker": "dcgw-bi72s924x5xu",
31 "maxKeys": 1
32}