API 文档调用方式
正在加载文档
最近更新时间: 2022-12-12 11:45:28
视频监控（qvs）API 返回结果说明
调用 API 服务后返回数据采用统一格式：
返回的 HTTP 状态码为 2xx，代表调用成功。 调用成功返回的数据格式为json。 返回的 HTTP 状态码为 4xx、5xx或6xx，代表调用失败。错误状态下会返回详细的错误信息：
{
"code": <errorCode>,
"error": "<errorInfo>"
}| HTTP状态码 | 详细错误码 | 错误信息 |
|---|---|---|
| 400 | 400000 | patch请求参数非法 |
| 400 | 400001 | patch请求解析失败 |
| 400 | 400002 | patch op非法 |
| 400 | 400100 | 空间名称非法(^[a-zA-Z0-9_-]{1,100}$) |
| 400 | 400101 | 空间描述不合法(最大支持100个字符) |
| 400 | 400102 | 空间接入方式不合法，必须为"rtmp"或者"gb28181" |
| 400 | 400103 | rtmp 方式接入的时候需指定接入类型(1:静态,2:动态) |
| 400 | 400105 | rtmp 静态接入必须指定域名 |
| 400 | 400106 | 域名已存在 |
| 400 | 400109 | 录制模版ID非法 |
| 400 | 400110 | 截图模版ID非法 |
| 400 | 400111 | 无效的回调地址 |
| 400 | 400112 | 无效的服务区域 |
| 400 | 400113 | 只允许在gb28181类型的空间下进行该操作 |
| 400 | 400114 | 只允许在rtmp类型的空间下进行该操作 |
| 400 | 400115 | 按需拉流已开启，请绑定按需模版 |
| 400 | 400116 | 空间被禁用 |
| 400 | 400200 | 模版名称非法(^[a-zA-Z0-9_-]{1,100}$) |
| 400 | 400201 | 模版描述不合法(最大支持100个字符） |
| 400 | 400202 | 模版类型不合法(0:录制模版,1:截图模版) |
| 400 | 400203 | 录制文件名非法，当前不支持自定义录制文件名 |
| 400 | 400204 | 截图文件名非法当前不支持自定义截图文件名 |
| 400 | 400205 | 查询Bucket所在区域信息失败 |
| 400 | 400206 | 截图类型非法(0:序列式截图,1:覆盖式截图,2:按需截图) |
| 400 | 400207 | 录制模版类型非法(0:不录制,1:实时录制,2:按需录制) |
| 400 | 400208 | 文件存储类型非法(0:普通存储,1:低频存储) |
| 400 | 400212 | 录制模版时长非法([600,3600秒]) |
| 400 | 400213 | 截图模版按需截图间隔非法([10-21600秒]) |
| 400 | 400215 | 无效bucket, bucket区域需与绑定bucket对应空间区域信息一致 |
| 400 | 400300 | stream 名称非法(^[a-zA-Z0-9_-]{1,100}$) |
| 400 | 400301 | stream 描述非法，最大为100个字符 |
| 400 | 400302 | 查询流列表接口sortBy参数非法 |
| 400 | 400305 | publish ip不能为空 |
| 400 | 400306 | play ip 不能为空 |
| 400 | 400307 | 请求rtmp动态地址时，urlExpireSec参数非法，此参数不能小于0 |
| 400 | 400308 | 查询start，end非法，时间跨度最大只能查询1天 |
| 400 | 400309 | ip地址无效 |
| 400 | 400310 | 请求rtmp动态地址时，playip、publiship 不能同时为空 |
| 400 | 400402 | 请求非法，只有静态接入才能绑定域名 |
| 400 | 400405 | 域名不存在 |
| 400 | 400406 | 时间戳防盗链输入key值非法 |
| 400 | 400407 | 时间戳防盗链没有启用 |
| 400 | 400408 | 域名与实际域名类型不匹配 |
| 400 | 400410 | ssl 证书不存在 |
| 400 | 400501 | start、end参数非法，start参数应小于end参数 |
| 400 | 400502 | 截图列表参数非法，[0,3] |
| 400 | 400505 | 另存为格式非法，支持m3u8、mp4、flv |
| 400 | 400506 | 另存文件名和format不匹配 |
| 400 | 400507 | 非法的录制间隔 |
| 400 | 400600 | 非法的start、end参数，流量带宽查询参数格式为20201012(年月日)或者20201012204005(年月日时分秒) |
| 400 | 400601 | 非法的device name |
| 400 | 400602 | 非法的device type |
| 400 | 400603 | 非法username格式 |
| 400 | 400604 | 非法的passowd格式 |
| 400 | 400606 | 查询设备列表sortBy参数非法 |
| 400 | 400607 | 非法的国标ID |
| 400 | 400608 | 无效的起止时间 |
| 400 | 400609 | 无效的告警方法，全部报警方法 1,2,3,4,5,6,7 |
| 400 | 400702 | 不支持的控制指令 |
| 400 | 400703 | 预设位id非法 |
| 400 | 400704 | 平台设备需指定通道ID |
| 400 | 400705 | 预置位名称非法(最大支持20个字符) |
| 400 | 400706 | 预置位名称已存在 |
| 400 | 400718 | 巡航组中绑定了该预置位，请先解除绑定 |
| 400 | 400802 | 非法的ai模板参数，截帧间隔（0.5 |
| 400 | 400803 | 非法的图像库参数，名称(^[a-zA-Z0-9_-]{1,100}$)，描述(最大支持100个字符) |
| 400 | 400804 | 非法的实体参数，名称(^[\u4e00-\u9fa5a-zA-Z0-9_-]{1,100}$)，性别（female/male），手机号码（^(+\d{2,}-)?[\d-]{6,}$），证件号（最大支持50个字符），地址（最大支持100个字符），描述（最大支持100个字符） |
| 400 | 400805 | 查询ai模板列表接口sortBy参数非法 |
| 400 | 400806 | 上传图像非法，请上传只包含一个人脸的图片 |
| 400 | 400807 | 图片内容无法解析，请上传合法的base64编码 |
| 500 | 500000 | 服务端内部错误 |
| 612 | 612100 | 空间不存在 |
| 612 | 612200 | 模版不存在 |
| 612 | 612300 | 流不存在 |
| 612 | 612303 | 流被禁用 |
| 612 | 612500 | 流对应的录制模版没有绑定 |
| 612 | 612501 | 录制模版对应的bucket不存在 |
| 612 | 612502 | 没有录制记录 |
| 612 | 612503 | 模板中选择的存储bucket未绑定域名，请绑定域名后在进行访问 |
| 612 | 612504 | 流不在线 |
| 612 | 612505 | 未绑定覆盖式截图模版 |
| 612 | 612600 | 设备不存在 |
| 612 | 612601 | channel不存在 |
| 612 | 612604 | 流对应的截图模版没有绑定 |
| 612 | 612607 | 删除文件失败，一次最多可以删除1000个文件 |
| 612 | 612701 | 国标设备推流启动中 |
| 612 | 612706 | 启动拉流或停止拉流操作失败，需指定国标设备进行操作 |
| 612 | 612707 | 国标设备离线 |
| 612 | 612708 | 启动拉流或停止拉流操作失败 |
| 612 | 612712 | 输入国标ID为非平台类设备，无法返回通道相关数据，请输入国标ID平台类的设备进行查询 |
| 612 | 612713 | 国标设备获取本地录制信息失败 |
| 612 | 612714 | 平台设备同步通道失败 |
| 612 | 612717 | 查询预置位列表失败 |
| 612 | 612719 | 本地录像上传开关未开启 |
| 612 | 612720 | 查询录制回放记录失败 |
| 612 | 612721 | 设备录制模版对应的bucket与流指定的bucket发生冲突 |
| 612 | 612800 | 图像库不存在 |
| 612 | 612802 | 实体不存在 |
| 612 | 612803 | 图片不存在 |
| 612 | 612804 | 上传图片时服务器发生错误 |
| 612 | 612805 | 删除图片时服务器发生错误 |
| 612 | 612806 | ai分析时发生错误 |
| 613 | 613100 | 添加空间失败，超出空间数量限制，最多可以创建10个空间 |
| 614 | 614100 | 空间名已经存在(namesapce 名称必须保证唯一) |
| 614 | 614200 | 模版已经存在(模版名称必须保证唯一) |
| 614 | 614300 | 流已经存在 |
| 614 | 614400 | 设备已经存在 |
| 614 | 614500 | 国标ID已经存在 |
| 614 | 614801 | 图像库已经存在 |
| 614 | 614802 | 实体已经存在 |
这篇文档有帮助吗？
正在加载反馈服务…