接口功能介绍
创建物理专线
接口约束
无
URI
POST /v4/cda/physical-line/add
路径参数
无
Query 参数
无
请求参数
请求头 header 参数
无
请求体 body 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| lineName | 是 | String | 物理专线名字 | ||
| account | 是 | String | 天翼云客户邮箱 | ||
| resourcePool | 是 | String | 资源池ID | ||
| resourcePoolName | 是 | String | 资源池名字 | ||
| ipVersion | 是 | String | IPV4/DUALSTACK/IPV6(三选一) | ||
| localConnectIP | 否 | String | 本端互联IP(IPV4或DUALSTACK必填) | ||
| remoteConnectIP | 否 | String | 远端互联IP(IPV4或DUALSTACK必填) | ||
| localConnectIPv6 | 否 | String | 本端互联IPv6(IPV6或DUALSTACK必填) | ||
| remoteConnectIPv6 | 否 | String | 本端互联IPv6(IPV6或DUALSTACK必填) | ||
| hostname | 是 | String | 交换机hostname | ||
| portType | 是 | String | 端口类型(10G、1G) | ||
| portName | 是 | String | 端口名字 | ||
| bandwidth | 是 | Integer | 带宽(M) | ||
| lineType | 是 | String | 物理专线类型(PON/IPRAN等) | ||
| tag | 是 | Integer | 是否带vlan tag, 1 为带， 0为不带 | ||
| vlan | 否 | Integer | 接入端口放行vlan, tag为1 ，此项必填 | ||
| isShared | 是 | Integer | 端口类别: 独享(0), 共享(1)默认 | ||
| accessPoint | 否 | String | 接入点 | ||
| location | 否 | String | 接入位置 | ||
| lineCode | 否 | String | 电路代号 | ||
| description | 否 | String |
响应参数
| 参数 | 参数类型 | 描述 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | ||
| message | String | 失败时的错误描述，一般为英文描述 | ||
| description | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | Object | 返回对象 | returnObj | |
| errorCode | String | 业务细分码，为product.module.code三段式码 | ||
| error | String | 错误 | ||
| details | String | 错误明细 |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| result | String | 1成功， 0失败 | ||
| data | String | 成功为空 | ||
| errorMsg | String | 成功为空 | ||
| errorCode | String | 错误代码，成功为空 | ||
| traceID | String | 日志跟踪ID |
请求示例
请求头
无
请求体 body
{
"bandwidth": 100,
"lineName": "autotest0627-test01",
"lineType": "PON",
"account": "autotest0627@qq.com",
"resourcePool": "81f7728662dd11ec810800155d307d5b",
"resourcePoolName": "内蒙演示环境",
"portType": "1G",
"portName": "TenGigabitEthernet 0/41",
"ipVersion": "IPV4",
"localConnectIP": "67.22.60.32/31",
"remoteConnectIP": "67.22.60.33/31",
"hostname": "NMA07-405-H12-ASW-RG6250-1U37",
"isShared": 1,
"tag": 1,
"vlan": 3301,
"lineCode": "mmmaaa",
"description": "test for openapi",
}
响应示例
{
"returnObj": {
"traceID": "f013a88450314fc19988eaff44bd6177",
"errorMsg": "",
"result": "1"
},
"errorCode": "",
"message": "",
"description": "",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求未成功 |
错误码
| errorCode | 描述 |
|---|---|
| OPENAPI.PatternCheck.NotValid | 请求参数无效 |
| OPENAPI.CDA.CreateError | 内部错误，请重试。如果多次尝试失败，请提交工单 |
