> For the complete documentation index, see [llms.txt](https://docs.console.zenlayer.com/api-reference/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.console.zenlayer.com/api-reference/cn/sdn/private-connect/createprivateconnect.md).

# CreatePrivateConnect

## 1. 接口描述

本接口(CreatePrivateConnect)用于创建二层网络专线。

{% hint style="info" %}
**注意事项**

* 目前只支持创建后付费固定带宽计费的二层网络专线。
* 云接入操作详见[云接入操作指南](https://docs.console.zenlayer.com/welcome/cloud-networking/get-started/validate-connection-in-public-cloud)
* 本接口为异步接口，当创建实例请求下发成功后会返回一个二层网络专线的`ID`，此时创建操作并未立即完成。在此期间实例的状态将会处于\*\*`DEPLOYING`\*\*，创建结果可以通过调用[**`DescribePrivateConnects`**](/api-reference/cn/sdn/private-connect/describeprivateconnects.md) **接口查询，如果状态(privateConnectStatus)由`DEPLOYING`(创建中)变为AVAILABLE**(可用)，则代表创建成功，如果未查询到任何记录，则代表创建失败，创建过程中不可对二层网络专线进行任何操作。
  {% endhint %}

## 2. 请求参数

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

| 参数名称               | 必选 | 类型                                                                                | 描述                                                                    |
| ------------------ | -- | --------------------------------------------------------------------------------- | --------------------------------------------------------------------- |
| privateConnectName | 是  | String                                                                            | <p>二层网络专线名称。</p><p>长度不超过 255，默认为 private-connect-{当前时间戳}。</p>         |
| bandwidthMbps      | 是  | Integer                                                                           | <p>二层网络专线最大带宽限制。</p><p>单位：Mbps。</p><p>可选值范围：\[10, +)</p><p>默认值：10</p> |
| endpointA          | 是  | [CreateEndpointParam](/api-reference/cn/sdn/datastructure.md#createendpointparam) | 二层网络专线一端的连接点（A）。                                                      |
| endpointZ          | 是  | [CreateEndpointParam](/api-reference/cn/sdn/datastructure.md#createendpointparam) | 二层网络专线另一端的连接点（Z）。                                                     |
| resourceGroupId    | 否  | String                                                                            | <p>资源组 ID。</p><p>不传则放入默认资源组。</p>                                      |
| tags               | 否  | [TagAssociation](/api-reference/cn/sdn/datastructure.md#tagassociation)           | <p>创建二层网络专线时关联的标签。</p><p>注意：关联<code>标签键</code>不能重复。</p>               |
| marketingOptions   | 否  | [MarketingInfo](/api-reference/cn/sdn/datastructure.md#marketinginfo)             | 市场营销活动相关信息。                                                           |

## 3. 响应结果

| 参数名称             | 类型     | 描述                                                       |
| ---------------- | ------ | -------------------------------------------------------- |
| requestId        | String | <p>唯一请求 ID。</p><p>每次请求都会返回。定位问题时需要提供该次请求的 requestId。</p> |
| orderNumber      | String | 订单号。                                                     |
| privateConnectId | String | 二层网络专线 ID。                                               |

## 4. 代码示例

{% tabs %}
{% tab title="示例" %}
**1. 创建1个二层网络专线, A端为数据中心端口，Z端为数据中心端口，专线的带宽为10Mbps。**

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

Request：
{
   "endpointA": {
      "vlanId": 1001,
      "portId": "your port id"
   },
   "privateConnectName": "fra-sel-prviate-line",
   "endpointZ": {
      "vlanId": 2001,
      "portId": "your portId id"
   },
   "bandwidthMbps": 10
}

Response：
{
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
     "requestId": "T98044459-95B2-477E-9A2F-00253A70CC6E",
     "orderNumber": "your-order-number",
     "privateConnectId": "your private connect id"
  }
}
```

{% endtab %}
{% endtabs %}

## 5. 开发者工具

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

## 6. 错误码

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

| HTTP状态码 | 错误码                                | 说明             |
| ------- | ---------------------------------- | -------------- |
| 400     | INVALID\_GOOGLE\_PAIRING\_KEY      | Google 配对密钥无效。 |
| 404     | INVALID\_PORT\_NOT\_FOUND          | 数据中心端口不存在。     |
| 400     | INVALID\_PORT\_STATUS              | 数据中心端口状态无效。    |
| 400     | INVALID\_ENDPOINT\_PARAMETER       | 无法根据参数推断连接点类型。 |
| 404     | INVALID\_ACCESS\_POINT\_NOT\_FOUND | 该云区域没有可用接入点。   |
