openCloudRecord(开通设备云存储)
openCloudRecord:开通设备云存储
要点:https://openapi.lechange.cn/openapi/openCloudRecord · 见 错误码
给账号下的设备通道开通指定的云存储套餐。支持通用云存储和智见云存储套餐。
请求参数
| 参数名 | 参数类型 | 是否必填 | 默认值 | 合法值 | 参数说明 | |
|---|---|---|---|---|---|---|
| token | String | 是 | 管理员accessToken | |||
| deviceId | String | 是 | 设备序列号 | |||
| channelId | String | 是 | 通道号 | |||
| strategyId | String | 是 | 详情请见:云存储套餐 strategyId | 云存储套餐ID,对应需要开通的云存储套餐种类 | ||
| deviceCloudId | String | 否 | 可通过 unUsedCloudList 获取值 | 库存云存储唯一 ID:从 [unUsedCloudList](/api/unUsedCloudList/) 选套餐开通时**必填**;用账号额度新开、不消耗库存时**不填** | ||
| repositoryId | String | 否 | 兼容字段,与 `deviceCloudId` 同义(二选一);新接入请用 `deviceCloudId` | |||
| activateNow | Boolean | 否 | false | 如果设备上已有其他套餐使用中,再次开通套餐时,可通过该字段选择立即启用新套餐。 true:开通后立刻使用该套餐,按其规格存储录像,设备上的其他套餐顺延进套餐队列;false:本次开通的套餐按顺序加入设备套餐队列。默认为false | ||
| rules | Array | 否 | ≤128 条 | 连续云存储录像计划对象数组;元素含 `period`(String,星期可逗号拼接)、`beginTime`/`endTime`(String,`HH:mm:ss`)。形状同 [setCloudRecordPlan](/api/setCloudRecordPlan/) 的 `rules` | ||
对于rules云录像计划参数:
1、该参数只对连续云存储套餐生效。开通事件云存储时可忽略该参数;
2、24小时连续云存储录像计划默认是每天的0点~24点,可不用再设置;如需自定义计划,可通过该参数设置;
3、如果使用的是指定每日存储时长的连续云存储(例如12小时连续云存储套餐),设置的录像计划总生效时长不能超过套餐支持的时长;这类套餐,开通时如果不设置rules,平台默认设置每日0点开始的录像计划。
rules 示例片段:"rules":[{"period":"Monday,Tuesday","beginTime":"08:00:00","endTime":"20:00:00"}]
请求示例
{
"id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"system":{
"ver":"1.0",
"appId":"lcdxxxxxxxxx",
"sign": "xjhCQBoJ9hRDsCjyDcHjtDNzRZ3ZJezcawsfWeiaoxU=",
"time": 1706511734,
"nonce": "f5a1ae2d-c09c-4d39-a744-83a5c2c653c2"
},
"params":{
"token": "<yourAccessToken>",
"deviceId":"TESTQWERXXXX",
"channelId":"0",
"strategyId":"3"
}
}
响应字段
无data数据返回
响应示例
{
"id":"d5c287b4-5b2f-4f03-baf5-8032c5c354af",
"result":{
"code":"0",
"msg":"操作成功"
}
}
错误码
本接口可能返回下列码;完整分组见 错误码。
网关与鉴权(SN / TK / OP)
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
SN1001 | 签名异常 | 按 签名 核对 sign |
TK1002 | token 无效或过期 | 重新获取 token |
OP1002 | 缺少必填参数 | 补必填字段 |
OP1003 | 参数不合法 | 按本页参数表核对 |
OP1039 | 分钟级限流 | 等到下一分钟再试 |
OP1040 | 调用超限 | 降低频率 |
DV1007 | 设备离线或超时 | 等设备上线 |
子账号(SUB)
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
SUB1001 | 子账号无指定权限 | 在 子账号策略 中补权限 |
SUB1002 | 子账号无任何设备权限 | 授权设备或调整策略 |
SUB1005 | 子账号 token 过期 | 重新 获取子账号 token |
SUB1006 | 子账号与设备无授权关系 | 核对 Resource 与设备序列号 |
SUB1008 | 子账号未绑定当前应用 | 先创建并绑定子账号 |
SUB1007 | 创建子账号失败 | 核对参数后重试 |
SUB1009 | 子账号创建失败,账号格式错误 | account 须为手机号或邮箱 |
SUB1010 | 子账号创建失败,账号已存在 | 勿重复绑定同一子账号到应用 |
更多见 错误码 · SUB。
设备访问与通道(DV10xx)
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
DV1007 | 设备离线或超时 | 等设备上线;低电休眠先 唤醒 |
DV1009 | 设备正忙 | 稍后重试 |
DV1012 | 分享/授权设备权限不足 | 核对子账号 Permission / Resource |
DV1019 | 能力集不支持 | 确认型号与 设备能力 |
DV1020 | 通道离线 | 检查通道与设备状态 |
DV1026 | 不支持此功能 | 换接口或升级固件 |
DV1028 | 未绑定或通道不存在 | 核对 deviceId / channelId |
DV1030 | 设备休眠 | 唤醒后再调 |
DV1057 | 通道不存在 | 核对通道号 |
DV1061 | 设备响应超时 | 检查设备网络 |
DV1062 | 需先唤醒设备 | 调用唤醒接口 |
DV1069 | 不满足操作条件 | 见 msg |
云存储套餐(ST)
| 错误码 | 错误码说明 | 下一步 |
|---|---|---|
ST1001 | 默认云存储套餐已到期 | 续费或换套餐 |
ST1002 | 无默认云存储套餐 | 先开通套餐 |
ST1004 | 云存储未开通 | 开通云存储 |
ST1005 | 云存储已过期 | 续费 |
ST1006 | 套餐不存在 | 核对套餐 id |
ST1009 | 仍有未过期收费套餐 | 先处理旧套餐 |
ST1010 | 设备不支持该套餐策略 | 换支持的套餐 |
ST1011 | 24 小时内仅可解绑一次 | 次日再试 |
OP1043 | 国标设备仅支持连续云存储 | 换连续套餐 |
OP1046 | 套餐不属于该设备 | 核对设备与套餐 id |
更多见 错误码 · ST。
说明
仅支持管理员 accessToken;子账号不可调用本接口。