Query dedicated gateway details
Updated at:2025-10-16
Description
Query the details of a dedicated gateway.
Request structure
Plain Text
1GET /v{version}/etGateway/{etGatewayId} HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: authorization string
Request parameters
| Parameter name | Types | Whether required | Parameter location | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number, current value is 1. |
| etGatewayId | String | Yes | URL parameter | ID of the dedicated gateway |
Response headers
No additional headers beyond standard ones.
Response parameters
| Parameter name | Types | Description |
|---|---|---|
| etGatewayId | String | ID of the dedicated gateway |
| name | String | Dedicated gateway name |
| status | String | Dedicated gateway status |
| speed | Integer | Bandwidth limit value of the dedicated gateway, in Mbps |
| createTime | string | Creation time |
| description | String | Description of the dedicated gateway |
| vpcId | String | ID of VPC to which the dedicated gateway belongs |
| etId | String | ID of physical dedicated line bound |
| channelId | String | ID of dedicated channel bound |
| localCidrs | List<String> | IPv4 cloud network of the dedicated gateway |
| enableIpv6 | Integer | Whether the IPv6 function is enabled, 1 for yes and 0 for no |
| ipv6LocalCidrs | List |
IPv6 cloud network of the dedicated gateway |
| healthCheckSourceIp | String | Source IP of health check |
| healthCheckDestIp | String | Destination IP of health check |
| healthCheckInterval | Integer | Health check interval |
| healthThreshold | Integer | Health threshold |
| unhealthThreshold | Integer | Unhealthy threshold |
| healthCheckType | String | Method for health check |
| healthCheckPort | Integer | Health check port |
| tags | List<[TagModel](VPC/API Reference/Appendix.md#TagModel)> | Collection of tags bound to dedicated gateway |
Request example
Plain Text
1GET /v1/etGateway/dcgw-4ds9x3kmds88 HTTP/1.1
2Host: bcc.bj.baidubce.com
3Authorization: bce-auth-v1/bf427691810a11e8a106475a8496ca04/2018-07-06T11:02:49Z/3600/host;x-bce-date/e84ee938f6466428ff5c16b3562a1cbf3db5928e7f863cedec8820b5d98aa474
Response 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 "etGatewayId":"dcgw-4ds9x3kmds88",
7 "name":"dcGateway",
8 "status":"running",
9 "speed":100,
10 "createTime":"2016-03-08T08:13:09Z",
11 "description":"",
12 "vpcId":"vpc-IyrqYIQ7",
13 "etId":"dcphy-478px3km77dh",
14 "channelId":"dedicatedconn-i7c1skfd0djs",
15 "localCidrs":["192.168.0.0/20"],
16 "enableIpv6": 1,
17 "ipv6LocalCidrs": ["2400:da00:e003:0:15f::/87"],
18 "healthCheckSourceIp":"192.168.5.2",
19 "healthCheckDestIp":"172.16.2.3",
20 "healthCheckType":"ICMP",
21 "healthCheckInterval":2,
22 "healthThreshold":2,
23 "unhealthThreshold":2,
24 "tags":[
25 {
26 "tagKey":"tagKey",
27 "tagValue":"tagValue"
28 }
29 ]
30}
