AssignBorderGatewayRoute

1. API Description

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

Note

• Only the custom routes with the type of Static Routes or Policy-based Route are supported.

• If the border gateway is in a Regional 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.

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	The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Code Example

Example

Advertise custom routes to a border gateway.

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"
  }
}

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

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.​

HTTP Status Code	Error Code	Description
404	INVALID_ZBG_NOT_FOUND	Border gateway does not exist.