# AssignBorderGatewayRoute

## 1. API Description

This API (AssignBorderGatewayRoute) is used to advertise custom routes to a border gateway.

{% hint style="info" %} <mark style="color:blue;">**Note**</mark>

* <mark style="color:blue;">Only the custom routes with the type of Static Routes or Policy-based Route are supported.</mark>
* <mark style="color:blue;">If the border gateway is in a</mark> <mark style="color:blue;">`Regional`</mark> <mark style="color:blue;">dynamic routing mode, the next-hop region of the custom routes to be advertised must be the same as the region of the border gateway.</mark>
  {% endhint %}

## 2. Input Parameters

The following request parameter list only provides API request parameters.

| Parameter Name     | Required | Type            | Description                                    |
| ------------------ | -------- | --------------- | ---------------------------------------------- |
| zbgId              | Yes      | String          | Border gateway ID.                             |
| advertisedRouteIds | Yes      | Array of String | ID list of the custom routes to be advertised. |

## 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> |

## 4. Code Example

{% tabs %}
{% tab title="Example" %}
**Advertise custom routes to a border gateway.**

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

Request:
{
  "zbgId": "xxx",
  "advertisedRouteIds": ["routeId1","routeId2"]
}

Response:
{
  "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F",
  "response": {
    "requestId": "TBFC01FCF-6439-4530-ADBC-16809F0C3E8F"
  }
}
```

{% 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                                            |
| ---------------- | -------------------------------------------- | ------------------------------------------------------ |
| 409              | INVALID\_NIC\_ZBG\_REGION\_MISMATCH          | Regions of vNIC and border gateway should be the same. |
| 404              | INVALID\_VPC\_ROUTE\_NOT\_FOUND              | Route does not exist.                                  |
| 404              | INVALID\_ZBG\_NOT\_FOUND                     | Border gateway does not exist.                         |
| 400              | OPERATION\_DENIED\_ROUTE\_TYPE\_NOT\_SUPPORT | Route type is not supported.                           |