# DescribeBorderGateways

## 1. API Description

This API (DescribeBorderGateways) 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          | <p>Border gateway name.</p><p>Fuzzy query is supported.</p>                                                                          |
| regionId       | No       | String          | Region ID.                                                                                                                           |
| vpcId          | No       | String          | VPC ID to which the border gateway belongs.                                                                                          |
| pageSize       | No       | Integer         | <p>Number of items in the current page result.</p><p>Default value: 20;</p><p>Maximum value: 1000.</p><p>Value range: \[1, 1000]</p> |
| pageNum        | No       | Integer         | <p>Number of pages returned.</p><p>Default value: 1.</p><p>Value range: \[1, +)</p><p>Default value: 1</p>                           |

## 3. Output Parameters

| Parameter Name | Type                                                                                              | Description                                                                                                           |
| -------------- | ------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| requestId      | String                                                                                            | <p>The unique request ID, which is returned for each request.</p><p>RequestId is required for locating a problem.</p> |
| totalCount     | Integer                                                                                           | Number of border gateways meeting the filtering conditions.                                                           |
| dataSet        | Array of [ZbgInfo](https://docs.console.zenlayer.com/api-reference/compute/datastructure#zbginfo) | Information on border gateways.                                                                                       |

## 4. Code Example

{% tabs %}
{% tab title="Example" %}
**Query all the available border gateways.**

```json
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
  }
}
```

{% endtab %}
{% endtabs %}

## 5. Developer Resources

Zenlayer Cloud API 2.0 integrates [SDKs](https://docs.console.zenlayer.com/api-reference/api-introduction/toolkit/api-sdk)，to make it easier for you to call APIs. More programming languages will be supported.

## 6. Error Codes

The following only lists the error codes related to the API business logic. For other error codes, see [Common Error Codes](https://docs.console.zenlayer.com/api-reference/api-introduction/instruction/commonerrorcode).

| HTTP Status Code | Error Code | Description |
| ---------------- | ---------- | ----------- |