CreateIPTransit

1. 接口描述

调用本接口用于创建一条IP Transit.

准备工作

物理端口：你需要预先准备至少一个物理端口。
查询支持IP Transit 的地区：
- 可以通过 DescribeIPTransitDatacenters 查询支持IP Transit 的数据的数据中心。

注意事项

因设备原因部分区域只支持手动交付，交付周期会在1～3d完成。可以通过 DescribeIPTransitDatacenters 的 deliveryType字段来判断是否是极速交付。
本接口为异步接口，当创建请求下发成功后会返回一个IP Transit的ID，此时创建操作并未立即完成。在此期间实例的状态将会处于**DEPLOYING，创建结果可以通过调用DescribeIpTransit接口查询，如果状态(iptStatus)由DEPLOYING(创建中)变为AVAILABLE**(可用)，则代表创建成功，如果状态变为则代表创建失败，创建过程中不可对二层网络专线进行任何操作。

2. 请求参数

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

参数名称必选类型描述

参数名称	必选	类型	描述
iptName	否	String	IP Transit的名称。长度不能超过255。
iptDescription	否	String	IP Transit的描述信息。长度不能超过255。
peerPortId	是	String	端口的ID。端口的连通性状态必须是`ACTIVE`
peerPortVlan	否	Integer	VLAN ID。范围为1000～4000。必须为未分配的vlan, 可以通过DescribePortUsableVlan来查询一个可以使用的vlan。
iptDcId	否	String	IP Transit 目的地数据中心ID。如果不指定，则代表和端口位于同一个数据中心。
internetType	否	InternetType	IP Transit的带宽计费方式。
commitBandwidth	否	Integer	保底带宽。单位Mbps。有且仅当internetType=ByInstanceBandwidth95时该字段必传。
bandwidth	是	Integer	带宽限速。单位Mbps 最小值不能低于10Mbps。
routingType	是	IPTransitRouteType	路由类型。
publicIPv4BlockSize	否	Array of Integer	公网IPv4地址。网段范围：24～30 有且仅当路由类型是Static 或 Gateway时必须指定。目前只允许指定一个公网CIDR。
bfd	否	BFDConfig	启用 BFD配置。如果不传该字段，则默认不启用BFD。网关模式不支持配置BFD。
resourceGroupId	否	String	资源组的ID。如果不传，则会放到默认资源组。

iptName

否

String

IP Transit的名称。长度不能超过255。

iptDescription

否

String

IP Transit的描述信息。长度不能超过255。

peerPortId

是

String

端口的ID。端口的连通性状态必须是ACTIVE

peerPortVlan

否

Integer

VLAN ID。范围为1000～4000。必须为未分配的vlan, 可以通过DescribePortUsableVlan来查询一个可以使用的vlan。

iptDcId

否

String

IP Transit 目的地数据中心ID。如果不指定，则代表和端口位于同一个数据中心。

internetType

否

InternetType

IP Transit的带宽计费方式。

commitBandwidth

否

Integer

保底带宽。单位Mbps。有且仅当internetType=ByInstanceBandwidth95时该字段必传。

bandwidth

是

Integer

带宽限速。单位Mbps 最小值不能低于10Mbps。

routingType

是

IPTransitRouteType

路由类型。

publicIPv4BlockSize

否

Array of Integer

公网IPv4地址。

网段范围：24～30 有且仅当路由类型是Static 或 Gateway时必须指定。目前只允许指定一个公网CIDR。

bfd

否

BFDConfig

启用 BFD配置。如果不传该字段，则默认不启用BFD。

网关模式不支持配置BFD。

resourceGroupId

否

String

资源组的ID。

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

3. 响应结果

参数名称	类型	描述
requestId	String	唯一请求 ID。每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
orderNumber	String	创建时产生的订单编号。
iptId	String	IP Transit 的 ID。

参数名称

类型

描述

requestId

String

唯一请求 ID。

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

orderNumber

String

创建时产生的订单编号。

iptId

String

IP Transit 的 ID。

4. 代码示例

1. 创建一条IP Transit，路由设置成静态路由，公网地址使用/28的CIDR。并且配置BFD。

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

Request：
{
  "iptName": "test_IPT",
  "iptDescription": "test_ipt_desc",
  "peerPortId": "1170556726903057557",
  "peerPortVlan": 1042,
  "internetType": "ByBandwidth",
  "bandwidth": 50,
  "iptDcId": "AMS1",
  "routingType": "Static",
  "publicIPv4BlockSize": [
    28
  ],
  "bfd": {
    "bfdTxInterval": 100,
    "bfdRxInterval": 100,
    "bfdMultiplier": 10
  }
}


Response：
{   
  "requestId": "T05992D0C-7E8B-4047-B0C0-780F2CD549D3",
  "response": {
     "requestId": "T98044459-95B2-477E-9A2F-00253A70CC6E"，
     "iptId": "your-ipt-id"
     "orderNumber": "xxxx"
  }
}

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 两端的信息不能一样

HTTP状态码

错误码

说明

404

INVALID_PORT_NOT_FOUND

数据中心端口不存在

400

INVALID_PORT_STATUS

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

400

INVALID_ENDPOINT_PARAMETER

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

400

INVALID_CONNECT_ENDPOINT_CONFLICT

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

最后更新于18小时前