接口功能介绍
查询已创建的共享物理专线
接口约束
无
URI
GET /v4/cda/shared-physical-line/list
路径参数
无
Query 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageNo | 是 | Integer | 页数 | 1 | |
| pageSize | 是 | Integer | 每页行数 | 10 |
请求参数
请求头 header 参数
无
请求体 body 参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | ||
| message | String | 失败时的错误描述，一般为英文描述 | ||
| returnObj | Object | 返回对象 | returnObj | |
| description | String | 失败时的错误描述，一般为中文描述 | ||
| errorCode | String | 业务细分码，为product.module.code三段式码 |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| totalCount | Integer | 共享物理专线总数 | ||
| currentCount | Integer | 共享物理专线数量 | ||
| physicalLineList | Array of Object | 共享物理专线对象列表 | PhysicalLine |
表PhysicalLine
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| lineID | String | 物理专线ID | ||
| lineName | String | 物理专线名字 | ||
| account | String | 天翼云客户邮箱 | ||
| vrfName | String | 专线网关名字 | ||
| resourcePool | String | 资源池ID | ||
| resourcePoolName | String | 资源池名字 | ||
| ipVersion | String | 本参数表示包周期类型。 取值范围： IPV4 IPV6 DUALSTACK |
||
| 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 | 端口名字 | ||
| portNameBus | String | 业务口 | ||
| bandwidth | Integer | 带宽(M) | ||
| deviceIp | String | 设备IP | ||
| lineType | String | 物理专线类型(PON/IPRAN等) | ||
| tag | Integer | 是否带vlan tag, 1 为带， 0为不带 | ||
| vlan | Integer | 接入端口放行vlan, tag为1 ，此项必填 | ||
| isShared | Integer | 端口类别: 独享(0), 共享(1)默认 | ||
| accessPoint | String | 接入点，多AZ必填: AP1, AP2 | ||
| location | String | 接入位置 | ||
| linecode | String | 电路代号 | ||
| description | String | 描述 | ||
| regionID | String | 资源池ID | ||
| fuid | String | 物理专线ID | ||
| projectIDEcs | String | Project ID | ||
| layer | String | 网络协议栈层级 | ||
| lineCreateTime | String | 创建时间 | ||
| fuserLastUpdated | String | 最近更新时间 | ||
| deleteTime | String | 删除时间 | ||
| bssResourceld | String | BCP参数 | ||
| duration | String | 持续时间 | ||
| isAutomation | Boolean | 是否自动化配置 | ||
| isExp | Boolean | 是否到期 | false | |
| businessType | String | 专线类型 | CDA | |
| baseResourceld | String | BCP参数 | ||
| enableQos | Boolean | 是否开启限速 | ||
| isDw | Boolean | 是否销毁 | ||
| ctUserId | String | 天翼云用户ID | ||
| orderTime | String | 订购时间 | ||
| expiryTime | String | 过期时间/到期时间 |
请求示例
请求url
/v4/cda/shared-physical-line/list?pageNo=1&pageSize=2
请求头
无
请求体 body
无
响应示例
{
"returnObj": {
"totalCount": 67,
"currentCount": 2,
"physicalLineList": [{
"layer" : "L3",
"lineName" : "guohy@chinatelecom.cn上海15-1",
"vrfName" : "BP8A9O7C8ZHJYMFJOIIQ",
"remoteConnectIP" : "10.10.10.2/24",
"bssResourceId" : null,
"orderTime" : null,
"remoteConnectIPv6" : "10:10:10:0:0:0:0:202/112",
"ipVersion" : "DUALSTACK",
"portNameBus" : "Twenty-FiveGigE1/0/10.1010",
"bandwidth" : 10,
"tag" : 1,
"fuid" : "EA413CBE39BE2FE65AA4F69C3368",
"linecode" : "",
"projectIdEcs" : "0",
"fuserLastUpdated" : "2023-10-31 02:05:01",
"duration" : null,
"lineCreateTime" : "2023-10-31 09:51:55",
"deleteTime" : null,
"hostname" : "LGXXYA4-501-05-12_06-12-A1P1-PSW-H6825-01U40",
"isAutomation" : null,
"location" : "",
"lineType" : "VPN",
"isExp" : false,
"portType" : "10G",
"ctUserId" : "82b2f71db2a74edc970a5e859d417317",
"isShared" : 1,
"deviceIp" : "30.20.223.5",
"businessType" : "CDA",
"resourcePoolName" : "上海15",
"description" : null,
"accessPoint" : "AP1",
"vlan" : 1010,
"expiryTime" : null,
"resourcePool" : "200000003330",
"baseResourceId" : null,
"localConnectIPv6" : "10:10:10:0:0:0:0:201/112",
"portName" : "Twenty-FiveGigE1/0/10",
"account" : "guohy@chinatelecom.cn",
"regionID" : "200000003330",
"enableQos" : false,
"isDw" : false,
"localConnectIP" : "10.10.10.1/24",
"lineID" : "EA413CBE39BE2FE65AA4F69C3368"
}]
},
"errorCode" : "",
"message" : "",
"description" : "",
"statusCode" : 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求未成功 |
错误码
| errorCode | 描述 |
|---|---|
| OPENAPI.PatternCheck.NotValid | 请求参数无效 |
| OPENAPI.CDA.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
