站点主备信息
更新时间：2021-12-29 17:07:09
适用产品
连接组网
接口描述
站点主备信息
- 调用URL： https://open.chinanetcenter.com/api/siteDevice/ms
- 调用方法：GET
推荐使用 Open API在线调试
Open API在线调试功能提供可视化界面在线调试API、支持生成代码示例、快速检索查看API文档等能力。前往调试
请求参数
Params 参数
| 参数名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
siteName | String | 否 | 站点名称(只支持查询CPE站点) 该参数可不指定，不指定时，查询企业的所有CPE站点的主用、备用设备情况 |
返回参数
Body 参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
returnCode | Integer | 接口状态码 |
returnMsg | String | 接口信息 |
content | List | 响应内容 |
timeStamp | String | 查询时间 |
details | SiteMsDeviceResponseContentDetails | 站点设备的使用情况 |
siteName | String | 站点名称 |
siteId | Long | 站点 ID |
deviceNum | Integer | 设备数量 |
master | String | 主用设备名称 |
slave | String | 备用设备名称 |
错误码
| 错误代码（code） | 描述（message） | HTTP状态码 | 语义 |
|---|---|---|---|
| 4001 | 非法时间参数 | 400 | 非法时间参数 |
| 4002 | 时间参数不能为空 | 400 | 时间参数不能为空 |
| 4003 | 开始时间不能早于半年前 | 400 | 开始时间不能早于半年前 |
| 4004 | 开始与结束时间不能相差超过x天 | 400 | 开始与结束时间不能相差超过x天 |
| 4005 | 开始时间不能大于结束时间 | 400 | 开始时间不能大于结束时间 |
| 4006 | 开始结束时间必须小于当前时间 | 400 | 开始结束时间必须小于当前时间 |
| 5003 | CPE站点不存在 | 400 | CPE站点不存在 |
| 5005 | 企业下没有CPE站点 | 400 | 企业下没有CPE站点 |
示例
JSON
- 请求示例 复制成功
#!/bin/bash username="example_username" apiKey="example_apiKey" date=`env LANG="en_US.UTF-8" date -u "+%a, %d %b %Y %H:%M:%S GMT"` password=`echo -en "$date" | openssl dgst -sha1 -hmac $apiKey -binary | openssl enc -base64` siteName="autotest_cpe_case04" curl -i --url "http://10.8.218.160/api/siteDevice/ms?siteName=$siteName" \ -X "GET" \ -u "$username:$password" \ -H "Date: $date"
- 返回示例 复制成功
{ "returnCode":"1", "returnMsg": "success", "content":{ "timestamp": "2021-11-2 14:52", "detail":[ { "siteName": "北京总部", "siteId": 740317625433842, "deviceNum": 2, "masterName": "北京CPE1", "slaveName": "北京CPE2" }, { "siteName": "厦门分公司", "siteId": 740317234533843, "deviceNum": 1, "masterName": "厦门CPE1" } ] } }
本篇文档内容对您是否有帮助？
有帮助
我要反馈