DescribeBorderGateways

1. API Description

This API is used to query the details of one or more border gateways. You can filter the query results with the border gateway ID and name.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
zbgIds	No	Array of String	Border gateway IDs.
name	No	String	Border gateway name. Fuzzy query is supported.
regionId	No	String	Region ID.
pageSize	No	Integer	Number of items in the current page result. Default value: 20; Maximum value: 1000.
pageNum	No	Integer	Number of pages returned. Default value: 1.

3. Output Parameters

Parameter Name	Type	Description
requestId	String	The unique request ID, which is returned for each request. RequestId is required for locating a problem.
dataSet	Array of ZbgInfo	Information on border gateways.
totalCount	Integer	Number of border gateways meeting the filtering conditions.

4. Code Example

Example

Query all the available border gateways.

POST /api/v2/zec HTTP/1.1
Host: console.zenlayer.com
Content-Type: application/json
X-ZC-Action: DescribeBorderGateways
<Common Request Params>

Request:
{
  "regionId": "xxx",
  "pageSize": 10,
  "pageNum": 1
}

Response:
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
    "dataSet": [
      {
        "zbgId": "your-sucerity-id",
        "name": "123",
        "vpcId": "Global",
        "regionId": "xxx",
        "asn": 65000,
        "interConnectCidr": "xxx",
        "createTime": "2022-01-01T01:00:00Z",     
        "cloudRouterIds": ["xxx"]
      }
    ],
    "totalCount": 1
  }
}

5. Developer Resources

Zenlayer Cloud API 2.0 integrates SDKs to make it easier for you to call APIs. More programming languages will be supported.

6. Error Codes

No error codes related to the API business logic. For other error codes, see Common Error Codes.​