getTimedCruisePlan(查询设备定时巡航计划)
getTimedCruisePlan:查询设备定时巡航计划
遗留 HTTP 保留: 新接入可使用 巡航(
ptz.cruise.*)对应能力。两套接口不是一对一替代。 文件名、实际 HTTP 方法与 registry 名称不一致,不是 registry 一对一映射。
功能说明
查询设备定时巡航计划。须具备 TimedCruise 能力(目前仅支持单通道设备)。
请求地址
https://openapi-[DataCenter].easy4ip.com/openapi/getTimedCruisePlan
请求格式
子账号 token 最低权限
Permission:configure、seniorConfigure 或 Config(与设备鉴权矩阵 TimedCruise 行一致)。Resource:cam:设备序列号:通道号。
请求参数
| 参数名 | 参数类型 | 是否必填 | 默认值 | 合法取值 | 参数说明 |
|---|---|---|---|---|---|
| token | String | 是 | 管理员或子账号 accessToken | ||
| deviceId | String | 是 | 设备序列号 | ||
| channels | int[] | 否 | 通道号数组 |
请求示例
{
"id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"system":{
"ver":"1.0",
"appId":"lcdxxxxxxxxx",
"sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
"time":1599031074,
"nonce":"8ec8a7bd1d1c95420de20d92422d457d"
},
"params":{
"token":"At_12345678901234567890123456789012",
"deviceId":"TESTQWERXXXX-dfXXX-XX",
"channels":[0]
}
}
返回字段说明
| 字段名 | 字段类型 | 说明 |
|---|---|---|
| channels | Array | 各通道定时巡航计划 |
| channels[].channelId | Integer | 通道号 |
| channels[].cruiseName | String | 巡航计划名称(设备返回时存在) |
| channels[].cruises | Array | 巡航时间段与收藏点配置 |
响应示例
{
"id":"123456",
"result":{
"code":"0",
"msg":"操作成功.",
"data": {
"channels": [
{
"channelId": 0,
"cruiseName": "default",
"cruises": [
{
"period": "everyday",
"beginTime": "08:00:00",
"endTime": "18:00:00",
"collectionIndex": 1
}
]
}
]
}
}
}
错误码
网关与鉴权(SN / TK / OP)
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
SN1001 | 签名校验异常 | 按 HTTP 开发规范 核对 sign |
TK1002 | token 无效或过期 | 重新获取 accessToken |
OP1002 | 缺少必填参数 | 补必填字段 |
OP1003 | 参数不合法 | 按本页参数表核对 |
OP1009 | 权限不足 | 核对 token 与设备绑定/分享权限 |
OP1013 | 接口总次数超限 | 降低调用频率 |
OP1014 | 接口日限额超限 | 见 接口调用限额 |
DV1007 | 设备离线 | 等设备上线 |
更多见 错误码 · OP/SN/TK。
子账号(SUB)
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
SUB1001–SUB1002 | 子账号无接口权限 | 在 addPolicy 中补策略 |
SUB1005 | 子账号 token 过期 | 重新 subAccountToken |
SUB1006 | 子账号与设备无授权 | 核对 Resource 与设备序列号 |
SUB1008 | 子账号未绑定应用 | 先创建并绑定子账号 |
更多见 错误码 · SUB。
设备访问与通道(DV10xx)
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
DV1007 | 设备离线或超时 | 等设备上线 |
DV1009 | 设备正忙 | 稍后重试 |
DV1012 | 分享/授权设备权限不足 | 核对子账号 Permission / Resource |
DV1019 | 能力集不支持 | 确认型号与能力列表 |
DV1020 | 通道离线 | 检查通道状态 |
DV1026 | 不支持此功能 | 换接口或升级固件 |
DV1028 | 未绑定或通道不存在 | 核对 deviceId / channelId |
更多见 错误码 · DV。
