Query Express Tunnel Gateway List
Last Updated：2020-07-20
Description
Query the express tunnel gateway list.
Request Structure
GET /v{version}/etGateway?vpcId={vpcId}&etGatewayId={etGatewayId}&name={name}&status={status}&marker={marker}&maxKeys={maxKeys} HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: authorization stringRequest Parameter
| Parameter name | Type | Required or not | Parameter position | Description |
|---|---|---|---|---|
| version | String | Yes | URL parameter | API version number (the current value is 1) |
| vpcId | String | Yes | URL parameter | id of vpc |
| etGatewayId | String | No | URL parameter | Id of express tunnel gateway |
| name | String | No | URL parameter | The name of express tunnel gateway supports fuzzy inquiry. |
| status | String | No | URL parameter | Status of express tunnel gateway |
| marker | String | No | Query parameter | The starting location of query for batch acquisition of lists, and is one string generated by the system. |
| maxKeys | int | No | Query parameter | Maximum number contained in each page, generally not exceeding 1000. The default value is 1000. |
Return Header
There are no other special headers except the public headers.
Return Parameter
| Parameter name | Type | Description |
|---|---|---|
| etGateways | List |
List containing query results |
| marker | string | Mark the starting position of the query. The item does not exist if the result list is empty |
| isTruncated | boolean | True means there are additional data in the following pages and false means the current page is the last page. |
| nextMarker | String | The marker value requiring to be passed in order to acquire the next page. The domain doesn't appear when isTruncated is false. |
| maxKeys | int | Maximum number contained in each page. |
Request Example
GET /v1/etGateway?vpcId=vpc-IyrqYIQ7&maxKeys=1 HTTP/1.1
Host: bcc.bj.baidubce.com
Authorization: bce-auth-v1/bf427691810a11e8a106475a8496ca04/2018-07-06T11:02:49Z/3600/host;x-bce-date/e84ee938f6466428ff5c16b3562a1cbf3db5928e7f863cedec8820b5d98aa474Return Example
HTTP/1.1 200 OK
Date: Fri, 06 Jul 2018 11:12:34 GMT
Content-Type: application/json;charset=UTF-8
Server: BWS
{
"etGateways":[
{
"etGatewayId": "dcgw-4ds9x3kmds88",
"name": "dcGateway";
"status": "running",
"speed": 100,
"createTime": "2016-03-08T08:13:09Z",
"description": "",
"vpcId": "vpc-IyrqYIQ7",
"etId": "dcphy-478px3km77dh",
"channelId": "dedicatedconn-i7c1skfd0djs",
"localCidrs": ["192.168.0.0/20"]
}
]
"marker":"dcgw-4ds9x3kmds88",
"isTruncated": true,
"nextMarker": "dcgw-bi72s924x5xu",
"maxKeys": 1
}