接口功能介绍
查询已创建的云专线交换机。
接口约束
无
URI
GET /v4/cda/switch/list
路径参数
无
Query 参数
| 参数 | 是否必填 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|---|
| resourcePool | 否 | 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 | 数量总数 | ||
| result | Array of Object | 交换机列表 | Switch | |
| errorMsg | String | 错误信息 | ||
| errorCode | String | 错误码 | ||
| traceID | String | 日志跟踪ID |
表 Switch
| 参数 | 参数类型 | 说明 | 示例 | 下级对象 |
|---|---|---|---|---|
| switchID | String | 交换机ID | ||
| switchName | String | 交换机名字 | ||
| factory | String | 厂商（RUIJIE、华三） | ||
| resourcePool | String | 资源池ID | ||
| resourceName | String | 资源池名字 | ||
| hostname | String | 交换机hostname | ||
| ip | String | 交换机IP | ||
| loginPort | String | 登录port | ||
| vtepIp | String | VTEP IP | ||
| vtepVlan | String | VTEP VLAN | ||
| deviceModel | String | 设备型号 | ||
| accessPoint | String | 接入点 | ||
| as | Integer | as号 | ||
| hasBleafRoute | Boolean | 标记交换机是否要配置BLEAF路由，默认为false（只有部分锐捷交换机需要配置） | ||
| sysMac | String | 交换机mac（多az并且是锐捷交换机则必填）（mac是查交换机配置查出来） | ||
| resourceType | String | 资源池类型 | ||
| azone | String | 可用区 | ||
| status | String | 状态 |
请求示例
请求url
/v4/cda/switch/list?resourcePool=11f77286624311ec810r50155d307d67
请求头
无
请求体 body
无
响应示例
{
"returnObj": {
"totalCount": 1,
"errorMsg": null,
"traceID": "f013a88450314fc19988eaff44bd6177",
"result": [{
"resourcePool": "61f7728672dd11ec819900155d30795h",
"loginPort": "22",
"vtepIp": "10.24.74.1/26",
"deviceModel": "RGS6220H",
"accessPoint": "AP1",
"resourceType": "MAZ",
"ip": "10.246.247.150",
"hostname": "ruijie_6250",
"factory": "RUIJIE",
"as": 64979,
"switchID": "55KNQ8PD235KFU84YT",
"hasBleafRoute": false,
"status": null,
"switchName": "ruijie_6250",
"resourceName": "内蒙8",
"vtepVlan": "301"
}]
},
"errorCode": "",
"message": "",
"description": "",
"statusCode": 800
}
状态码
| 状态码 | 描述 |
|---|---|
| 800 | 表示请求成功 |
| 900 | 表示请求未成功 |
错误码
| errorCode | 描述 |
|---|---|
| OPENAPI.PatternCheck.NotValid | 请求参数无效 |
| OPENAPI.CDA.AccessFailed | 内部错误，请重试。如果多次尝试失败，请提交工单 |
