CreateBorderGateway

1. API Description

This API is used to create a border gateway.

2. Input Parameters

The following request parameter list only provides API request parameters.

Parameter Name	Required	Type	Description
regionId	Yes	String	Region ID.
vpcId	Yes	String	VPC ID.
label	Yes	String	Border gateway name. This parameter must start and end with a number or a letter, containing 2 to 63 characters. Only letters, numbers, - and periods (.) are supported.
asn	Yes	Integer	Autonomous System Number. The range is from 65000 to 65534.
advertisedSubnet	No	AdvertisedSubnet	Subnet route advertisement. Default value: Advertise All.
advertisedCidrs	No	Array of String	Custom IPv4 CIDR block list.
advertisedRouteIds	No	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.
zbgId	String	Border gateway ID.

4. Code Example

Example

Create a border gateway.

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

Request:
{
  "regionId": "xxxx",
  "vpcId": "xxx",
  "label": "xxx",
  "asn": 65000,
  "advertisedSubnet": "ALL"
}

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

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
409	INVALID_ZBG_REGION_EXIST_CONFLICT	Border gateway exists in this region already.
404	INVALID_VPC_NOT_FOUND	VPC does not exist.
404	INVALID_REGION_NOT_FOUND	Region does not exist.
404	INVALID_VPC_ROUTE_NOT_FOUND	Route does not exist.
400	OPERATION_DENIED_ROUTE_TYPE_NOT_SUPPORT	Unsupported route type.
409	INVALID_NIC_ZBG_REGION_MISMATCH	Regions of vNIC and border gateway mismatch.