CreatePrivateConnect

1. 接口描述

调用本接口用于创建一条二层网络专线。

准备工作

物理端口连接点：可用通过DescribePrivateConnectAvailablePorts 接口查询可用于加入二层网络专线的物理端口信息。
云接入支持的数据中心查询：
- 可以通过 DescribeGoogleRegions 查询Goolge 云接入点支持的数据中心信息。
- 可以通过 DescribeAWSRegions 查询AWS云接入点支持的数据中心信息。
- 可以通过 DescribeTencentRegions查询Tencent 云接入点支持的数据中心信息。

注意事项

目前只支持创建后付费固定带宽计费的二层网络专线。
云接入操作详见云接入操作指南
本接口为异步接口，当创建实例请求下发成功后会返回一个二层网络专线的ID，此时创建操作并未立即完成。在此期间实例的状态将会处于**DEPLOYING**，创建结果可以通过调用DescribePrivateConnects 接口查询，如果状态(privateConnectStatus)由DEPLOYING(创建中)变为AVAILABLE(可用)，则代表创建成功，如果未查询到任何记录，则代表创建失败，创建过程中不可对二层网络专线进行任何操作。

2. 请求参数

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

参数名称

必选

类型

描述

privateConnectName

否

String

二层网络专线的名称。长度不能超过255。默认为private-connect-{当前时间戳}。

endpointA

是

CreateEndpointParam

创建二层网络其中一端的连接点（A）

endpointZ

否

CreateEndpointParam

创建二层网络另一端的连接点（Z）

bandwidthMbps

否

Integer

二层网络专线最大带宽。

范围是1～500。默认值是1 ，单位：Mbps。

resourceGroupId

否

String

资源组的ID。

如果不传，则会放到默认资源组。

3. 响应结果

参数名称

类型

描述

requestId

String

唯一请求 ID。

每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

privateConnectId

String

二层网络专线ID。

4. 代码示例

1. 创建1个二层网络专线, A端为数据中心端口，Z端为端口，专线的带宽为10Mbps。

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"，
     "privateConnectId": "your private connect id"
  }
}

5. 开发者工具

Zenlayer Cloud API 2.0 提供了配套的开发工具集（SDK），未来会陆续支持更多开发语言，方便快速接入和使用Zenlayer的产品和服务。

6. 错误码

下面包含业务逻辑中遇到的错误码，其他错误码见公共错误码

HTTP状态码

错误码

说明

404

INVALID_PORT_NOT_FOUND

数据中心端口不存在

400

INVALID_PORT_STATUS

数据中心连通性状态不是UP，无法操作

400

INVALID_ENDPOINT_PARAMETER

端点的参数不正确，无法判断类型

400

INVALID_CONNECT_ENDPOINT_CONFLICT

A-Z 两端的信息不能一样

最后更新于1年前