# CreateBorderGateway

## 1. 接口描述

本接口(CreateBorderGateway)用于在某节点为VPC创建一个边界网关。

## 2. 请求参数

以下请求参数列表仅列出了接口中需要的请求参数

| 参数名称               | 必选 | 类型                                                                                                        | 描述                                                                               |
| ------------------ | -- | --------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------- |
| regionId           | 是  | String                                                                                                    | 节点ID。                                                                            |
| vpcId              | 是  | String                                                                                                    | VPC ID。                                                                          |
| label              | 是  | String                                                                                                    | <p>名称。</p><p>范围2到63个字符。</p><p>仅支持输入字母、数字、-/\_和英文句点(.)。</p><p>且必须以数字或字母开头和结尾。</p> |
| asn                | 是  | Integer                                                                                                   | <p>ASN号。</p><p>可选值范围：\[65000, 65534]。</p>                                        |
| routingMode        | 否  | [RoutingMode](https://docs.console.zenlayer.com/api/cn/compute/datastructure#routingmode)                 | <p>路由级别。</p><p>默认值：Regional。</p>                                                 |
| advertisedSubnet   | 否  | [ZbgAdvertisedSubnet](https://docs.console.zenlayer.com/api/cn/compute/datastructure#zbgadvertisedsubnet) | <p>子网宣告控制。</p><p>默认值：ALL。</p>                                                    |
| advertisedCidrs    | 否  | Array of String                                                                                           | IPv4 Cidr集合。                                                                     |
| advertisedRouteIds | 否  | Array of String                                                                                           | 自定义路由ID集合。                                                                       |

## 3. 响应结果

| 参数名称      | 类型     | 描述                                                       |
| --------- | ------ | -------------------------------------------------------- |
| requestId | String | <p>唯一请求 ID。</p><p>每次请求都会返回。定位问题时需要提供该次请求的 requestId。</p> |
| zbgId     | String | 边界网关的ID。                                                 |

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}
**1. 创建边界网关，路由级别为节点级别。**

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

Request:
{
  "regionId": "asia-east-1",
  "vpcId": "<vpcId>",
  "label": "xxx",
  "asn": 65000,
  "advertisedSubnet": "ALL"
}

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

{% endtab %}
{% endtabs %}

## 5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的[开发工具集（SDK）](https://docs.console.zenlayer.com/api/cn/api-introduction/toolkit)，未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

## 6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见[公共错误码](https://docs.console.zenlayer.com/api/cn/api-introduction/instruction/commonerrorcode)

| HTTP状态码 | 错误码                                          | 说明               |
| ------- | -------------------------------------------- | ---------------- |
| 409     | INVALID\_ZBG\_REGION\_EXIST\_CONFLICT        | 节点已经存在边界网关，有冲突。  |
| 409     | INVALID\_NIC\_ZBG\_REGION\_MISMATCH          | 网卡的区域与边界网关区域不匹配。 |
| 404     | INVALID\_REGION\_NOT\_FOUND                  | 指定的可用区不存在。       |
| 404     | INVALID\_VPC\_NOT\_FOUND                     | VPC不存在。          |
| 404     | INVALID\_VPC\_ROUTE\_NOT\_FOUND              | VPC路由不存在。        |
| 400     | OPERATION\_DENIED\_ROUTE\_TYPE\_NOT\_SUPPORT | VPC路由类型不支持。      |
