物理专线云端口订购
更新时间 2025-12-10 16:13:35
最近更新时间: 2025-12-10 16:13:35
接口功能介绍
物理专线云端口订购
接口约束
云端口订购成功后需联系工单人员在蟠桃系统开通专线
URI
POST /v4/cda/physical-line/new
路径参数 无
Query参数 无
请求参数
请求头header参数 无
请求体body参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| clientToken | 否 | String | 客户端存根，用于保证订单幂等性，要求单个云平台账户内唯一。 | ||
| lineName | 是 | String | 云端口名字 | ||
| regionID | 是 | String | 资源池ID | ||
| regionName | 是 | String | 资源池名字 | ||
| bandwidth | 是 | Integer | 云端口带宽值(Mbps) | ||
| cycleType | 是 | String | 包周期类型，取值如下： "YEAR": 包年 "MONTH":包月 | MONTH | |
| cycleCount | 是 | Integer | 包周期数。周期最大长度不能超过60个月 | 6 | |
| address | 否 | String | IDC地址 | ||
| contactName | 否 | String | 联系人姓名 | ||
| contactPhone | 否 | String | 联系人电话 | ||
| contactEmail | 否 | String | 联系人邮箱 | ||
| notes | 否 | String | 备注 |
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | ||
| message | String | 失败时的错误描述，一般为英文描述 | ||
| description | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | Object | 返回对象 | returnObj | |
| errorCode | String | 业务细分码，为product.module.code三段式码 | ||
| error | String | 错误 | ||
| details | Object | 错误明细。一般情况下，会对订单侧(bss)的订单业务相关的错误做明确的错误映射和提升，有唯一对应的errorCode | ||
| 表 returnObj |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| masterOrderID | String | 订单ID。调用方在拿到masterOrderID之后，在若干错误情况下，可以使用materOrderID进一步确认订单状态及资源状态 | ||
| masterOrderNO | String | 订单号 | ||
| masterResourceID | String | 主资源ID | d708e8925dc743829cfc5b26c3d314e2 | |
| masterResourceStatus | String | 主资源状态，只有主订单资源会返回 | started | |
| regionID | String | 资源所属资源池ID | 81f7728662dd11ec810800155d307d5b | |
| resources | Array of Objects | 资源明细列表,参考表resources | Resource | |
| 表 Resource |
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| resourceID | String | 单项资源的变配、续订、退订等需要该资源项的ID | d708e8925dc743829cfc5b26c3d314e2 | |
| orderID | String | 订单ID | bb4e607c0da348a6ab6be71c10fc2a5b | |
| startTime | Integer | 启动时刻，epoch时戳，毫秒精度 | 1667902478000 | |
| expireTime | Integer | 过期时刻，epoch时戳，毫秒精度 | 1667902480000 | |
| createTime | Integer | 创建时刻，epoch时戳，毫秒精度 | 1667902456000 | |
| updateTime | Integer | 更新时刻，epoch时戳，毫秒精度 | 1667902481000 | |
| status | Integer | 资源状态。参考masterResourceStatus | 2 | |
| isMaster | Boolean | 布尔类型，是否是主资源项 | true | |
| itemValue | Integer | 资源规格，带宽包大小，单位MB | 5 | |
| resourceUUID | String | 资源UUID，结合regionID一起使用 | 4ed708e89743829cfc5b25dc26c3d312 | |
| resourceConfig | Object | 带宽包订单相关资源配置 |
枚举参数
无
请求示例
请求url
POST /v4/cda/physical-line/new
请求头header
无
请求体body
{
"clientToken": "unique-any-string",
"regionName": "内蒙8",
"lineName": "physical-line-openapi-test",
"regionID": "81f7728662dd11ec810800155d307d5b",
"bandwidth": 5,
"cycleType": "MONTH",
"cycleCount": 1
}
响应示例
{
"returnObj": {
"masterResourceStatus": "started",
"regionID": "81f7728662dd11ec810800155d307d5b",
"masterOrderID": "11dd614a5f4e11eda34b0242ac110003",
"masterResourceID": "d708e8925dc743829cfc5b26c3d314e2",
"masterOrderNO": null,
"resources": [{
"orderID": "bb4e607c0da348a6ab6be71c10fc2a5b",
"status": 2,
"isMaster": true,
"resourceType": "CDA_CONNECT_BANDWIDTH",
"resourceID": "d708e8925dc743829cfc5b26c3d314e2",
"masterOrderID": "11dd614a5f4e11eda34b0242ac110003",
"updateTime": 1667902481000,
"masterResourceID": "d708e8925dc743829cfc5b26c3d314e2",
"itemValue": 5,
"startTime": 1667902478000,
"resourceConfig": {
"yptProductLimit": "PUB_100_02_0001",
"projectID": "0",
"isauto": "0",
"number": "5",
"name": "cloudhigh-packet02-openapi",
"platformid": "81f7728662dd11ec810800155d307d5b",
"availabilityZonea": "china",
"availabilityZoneb": "china",
"regionid": "81f7728662dd11ec810800155d307d5b",
"areaA": "china",
"areaB": "china",
"zoneid": "81f7728662dd11ec810800155d307d5b",
"adminUrl": "http://admin.huidu.inner.cn:38082/",
"value": "5",
"version": "v1",
"prodissupportedcredit": "PUB_100_02_0001",
"billmode": "1",
"zonetype": "openstack",
"type": "overlay",
"size": "5"
},
"createTime": 1667902456000
}]
},
"details": "",
"message": "success",
"description": "成功",
"statusCode": 800,
"errorCode": ""
}
状态码
请参考 状态码
错误码
请参考 错误码
