CreatePort

1. 接口描述

本接口用于创建一个数据中心端口。

准备工作

在创建Port之前，你可以调用DescribeDatacenters进行查看哪些数据中心支持端口的创建。

注意事项

本接口为异步接口，当创建Port请求下发成功后会返回一个PortID列表，此时创建Port操作并未立即完成。在此期间Port的状态将会处于**CREATING，Port创建结果可以通过调用DescribePorts接口查询，如果Port状态由CREATING(创建中)变为RUNNING**，则代表Port创建成功，否则代表还在创建中。创建过程中不可对Port进行任何操作。

2. 请求参数

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

参数名称

是否必选

类型

描述

dcId

是

String

数据中心四字码。

具体取值可通过调用接口DescribeDataCenters来获得最新的数据中心列表。

portName

是

String

端口名称。

最长不超过255个字符，建议使用数据中心四字码 + 端口规格拼接。

portRemarks

否

String

端口备注信息。

最长不超过255个字符。

portType

是

String

端口规格。

具体取值可通过调用接口DescribeDataCenterPortType来获得最新的端口规格表。

businessEntityName

是

String

贵司商业实体名称。

主要用于LOA（Letter of Authorization）的抬头。

3. 响应结果

参数名称

类型

描述

requestId

String

唯一请求 ID。

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

portId

String

端口id。

4. 代码示例

1.在新加坡1（SIN1）创建一个1G规格的端口。

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

Request:
{
  "dcId": "SIN1",
  "portName": "your-port-name",
  "portRemarks": "your-port-remarks",
  "portType": "1G",
  "businessEntityName": "your-business-entity-name"
}

Response:
{
  "requestId": "T3811A0E7-C250-40A2-96AD-08AD759E1BC2",
  "response": {
    "requestId": "T3811A0E7-C250-40A2-96AD-08AD759E1BC2",
    "portId": "your-port-id"
  }
}

5. 开发者工具

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

6. 错误码

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

HTTP状态码

错误码

说明

7111

SELF_SERVICE_PORT_NOT_SHELF

端口SKU未上架，暂不可购买。

最后更新于1年前