接口功能介绍
查询账户下已创建的云专线(Cloud Dedicated Access)网关。
接口约束
无
URI
GET /v4/cda/gateway/list
路径参数
无
Query 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| pageNo | 是 | Integer | 页数 | 1 | |
| pageSize | 是 | Integer | 每页数据量 | 10 | |
| account | 是 | String | 天翼云客户邮箱 | user@sample.com | |
| search | 否 | String | 专线网关名字或ID |
请求参数
请求头 header 参数
无
请求体 body 参数
无
响应参数
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| statusCode | Integer | 返回状态码(800为成功，900为失败) | ||
| message | String | 失败时的错误描述，一般为英文描述 | ||
| description | String | 失败时的错误描述，一般为中文描述 | ||
| returnObj | Object | 返回对象 | returnObj | |
| errorCode | String | 业务细分码，为product.module.code三段式码 | ||
| error | String | 错误 | ||
| details | String | 错误明细 |
表returnObj
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| totalCount | Integer | 数量总数 | ||
| currentCount | Integer | 当前数量 | ||
| lineGatewayList | Array of Object | 专线网关列表 | LineGateway |
表 LineGateway
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| vrfName | String | 专线网关ID | ||
| displayName | String | 专线网关名字 | ||
| accessPoint | String | 接入点 | ||
| account | String | 天翼云账号 | ||
| isSwConfig | Boolean | 是否下发配置到交换机 | ||
| lineList | Array of String | 绑定的物理专线列表 | ||
| resourcePool | String | 资源池ID | ||
| resourcePoolName | String | 资源池名字 | ||
| srList | Array of Object | 静态路由列表 | StaticRoute | |
| vpcList | Array of Object | VPC列表 | VPC | |
| isAutomation | Boolean | 是否自动化 | ||
| projectIdEcs | String | 租户ID | ||
| lgcreateTime | String | 创建时间 | ||
| fuserLastUpdated | String | 上次更新时间 | ||
| drList | Array of Object | 动态路由列表 | BGPRoute | |
| deleteTime | String | 删除时间 | ||
| switchAs | String | 交换机as号 | ||
| customerID | String | 用户ID |
表StaticRoute
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| ipVersion | String | 本参数表示包周期类型。 取值范围： IPV4 IPV6 DUALSTACK |
||
| vrfName | String | 专线网关ID | ||
| dstCidr | Array of String | 目的IPV4地址列表 | ||
| dstCidrV6 | Array of String | 目的IPV6地址列表 | ||
| nextHop | Array of Object | 下一跳及优先级列表 | NextHop | |
| nextHopV6 | Array of Object | 下一跳IPv6地址及优先级列表 | NextHop | |
| SRID | String | 静态路由ID | ||
| rc | String | 用户rc信息 |
表NextHop
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| remoteGatewayIp | String | 下一跳，即物理专线的远端互联ip | ||
| priority | Integer | 优先级 | 50 | |
| track | Integer | 0为关闭，1为开启 |
表BGPRoute
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| BGPList | Array of Object | IPv4类型的BGP列表 | BGP | |
| multiPathNumberIpv6 | String | BGP-IPv6多路功能序号(负载线路数) | ||
| networkCidr | Array of String | 客户侧子网列表(IPv4) | ||
| vrfName | String | 专线网关ID | ||
| multiPathIpv6 | Boolean | 是否开启BGP-IPv6多路功能 | ||
| networkCidrV6 | Array of String | 客户侧子网列表(IPv6) | ||
| multiPathType | String | Bgp多路功能类型(IBGP/EBGP) | ||
| ipVersion | String | 本参数表示包周期类型。 取值范围： IPV4 IPV6 DUALSTACK |
||
| BGPID | String | BGP ID | ||
| BGPIpv6List | Array of Object | IPv6类型的BGP列表 | BGP | |
| multiPath | Boolean | 是否开启BGP-IPv4多路功能 | ||
| multiPathNumber | String | BGP-IPv4多路功能序号(负载线路数) |
表BGP
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| BGPNeighbor | String | BGP邻居名称 | ||
| BGPIP | String | BGP邻居IP(物理专线的远端互联IP) | ||
| lineID | String | 物理专线ID | ||
| peerAS | String | Peer AS号 | ||
| BGPKey | String | BGP密钥 | ||
| bfd | Boolean | 是否打开bfd 功能 |
表VPC
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| cdaId | String | 专线ID | ||
| account | String | 天翼云账号 | ||
| vpcId | String | VPC ID | ||
| vrfName | String | 专线网关ID | ||
| dcType | String | 本参数表示资源池类型。 取值范围： MAZ CNP |
||
| azNameIpv6 | String | IPv6 VPC的可用区名字 | ||
| cdaIdV6 | String | IPv6 VPC的专线ID | ||
| vpcSubnet | String | VPC子网 | ||
| resourcePool | String | 资源池ID | ||
| emazId | String | 多可用区ID | ||
| ipVersion | String | 本参数表示包周期类型。 取值范围： IPV4 IPV6 DUALSTACK |
||
| virtualBandwidth | Integer | 虚拟带宽 | ||
| vpcName | String | VPC名字 | ||
| emazIdV6 | String | 多可用区ID(IPv6) | ||
| guestGatewayList | Array of String | 客户侧网关列表 | ||
| azName | String | 可用区名字 | ||
| vpcSubnetIpv6 | String | VPC IPv6子网 | ||
| vpcNetworkSegment | String | VPC网段 | ||
| ctUserId | String | 天翼云用户ID | ||
| vpcNetworkSegmentIpv6 | String | VPC IPv6网段 | ||
| guestGatewayListIpv6 | Array of String | 客户侧IPv6网关列表 |
请求示例
请求url
/v4/cda/gateway/list?pageNo=1&pageSize=2
请求头
无
请求体 body
无
响应示例
{
"statusCode": 800,
"returnObj": {
"totalCount": 5,
"currentCount": 2,
"totalPage": 3,
"lineGatewayList": [{
"fuid": "nm8CTYUN12",
"accessPoint": "AP1",
"account": "gmm-cdatest@qq.com",
"createdTime": null,
"deleteTime": null,
"drList": [],
"fuserLastUpdated": "2022-07-01T07:13:50Z",
"isSwConfig": true,
"lgcreateTime": "2022-04-24 09:15:56",
"lineList": ["78C08B77653AFAC22E1C90D4D9BD", "DA3DC23FE61603430122CE148F11"],
"regionID": "",
"resourcePool": "81f7728662dd11ec810800155d307d5b",
"resourcePoolName": "内蒙演示环境",
"srList": [{
"dstCidr": ["113.12.11.0/24"],
"dstCidrV6": ["FD11:1D2C:3C41:2311:0:0:0:0/64"],
"nextHop": [{
"remoteGatewayIp": "113.12.11.3",
"priority": 20,
"track": 1
}],
"vrfName": "nm8CTYUN12",
"ipVersion": "DUALSTACK",
"nextHopV6": [{
"remoteGatewayIp": "FD11:1D2C:3C41:2311:5:0:0:3",
"priority": 20,
"track": 1
}],
"rc": null,
"SRID": "D024E818BC6DDA2D4C2457F24CF2"
}],
"vpcList": [],
"vrfName": "nm8CTYUN12",
"isAutomation": null,
"projectIdEcs": "0"
}, { ...
}]
},
"errorCode": "",
"message": "",
"description": "",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求未成功 |
错误码
| errorCode | 描述 |
|---|---|
| OPENAPI.PatternCheck.NotValid | 请求参数无效 |
| OPENAPI.CDA.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
