# ccnvr ## API Docs - 系统 [获取公开产品信息](https://api.ccnvr.com/528546700e0.md): - 系统 [获取组件版本信息](https://api.ccnvr.com/528546701e0.md): - 系统 [检查版本更新](https://api.ccnvr.com/528546702e0.md): - 系统 [在线下载升级包(SSE 进度)](https://api.ccnvr.com/528546703e0.md): 返回 text/event-stream 进度;前端当前主要使用 /app/upgrade/upload/* 与 /app/upgrade/apply 的离线包流程。 - 系统 [初始化离线升级包上传](https://api.ccnvr.com/528546704e0.md): - 系统 [上传升级包分片](https://api.ccnvr.com/528546705e0.md): 请求体为 application/octet-stream 二进制分片。 - 系统 [合并分片并校验升级包](https://api.ccnvr.com/528546706e0.md): - 系统 [应用已暂存升级包并重启](https://api.ccnvr.com/528546707e0.md): - 系统 [重启服务](https://api.ccnvr.com/528546708e0.md): - 系统 [获取授权状态](https://api.ccnvr.com/528546709e0.md): - 系统 [获取设备码与指纹](https://api.ccnvr.com/528546710e0.md): - 系统 [获取授权用量](https://api.ccnvr.com/528546711e0.md): - 系统 [上传授权文件激活](https://api.ccnvr.com/528546712e0.md): - 系统 [获取系统指标(常规页)](https://api.ccnvr.com/528546713e0.md): - 系统 [获取存储统计(存储页)](https://api.ccnvr.com/528546714e0.md): - 系统 [获取本机网卡与公网 IP 候选](https://api.ccnvr.com/528546715e0.md): - 系统 [在线读取系统日志(最新在前)](https://api.ccnvr.com/528546716e0.md): - 系统 [下载当前日志文件](https://api.ccnvr.com/528546717e0.md): - 认证 [登录](https://api.ccnvr.com/528546718e0.md): - 认证 [获取当前用户角色与权限](https://api.ccnvr.com/528546719e0.md): - 认证 [修改当前用户用户名或密码](https://api.ccnvr.com/528546720e0.md): - 权限 [用户列表(仅 root)](https://api.ccnvr.com/528546721e0.md): - 权限 [新增用户(仅 root)](https://api.ccnvr.com/528546722e0.md): - 权限 [修改用户角色或状态(仅 root)](https://api.ccnvr.com/528546723e0.md): - 权限 [删除用户(仅 root)](https://api.ccnvr.com/528546724e0.md): - 权限 [重置用户密码(仅 root)](https://api.ccnvr.com/528546725e0.md): - 权限 [查询用户摄像头资源(仅 root)](https://api.ccnvr.com/528546726e0.md): root 始终拥有全部摄像头资源且不可修改;普通用户默认没有任何通道。 - 权限 [设置用户摄像头资源(仅 root)](https://api.ccnvr.com/528546727e0.md): 按通道分配。all_channels=true 表示现有及未来新增通道全部可见;否则仅能访问 channel_ids 中的通道。 - 权限 [角色列表(仅 root)](https://api.ccnvr.com/528546728e0.md): - 权限 [新增角色(仅 root)](https://api.ccnvr.com/528546729e0.md): - 权限 [修改角色及权限(仅 root)](https://api.ccnvr.com/528546730e0.md): - 权限 [删除角色(仅 root)](https://api.ccnvr.com/528546731e0.md): - 权限 [获取页面与按钮权限目录(仅 root)](https://api.ccnvr.com/528546732e0.md): - 设备 [设备列表](https://api.ccnvr.com/528546733e0.md): - 设备 [添加设备](https://api.ccnvr.com/528546734e0.md): - 设备 [设备及通道列表](https://api.ccnvr.com/528546735e0.md): 返回设备及其通道;children 包含隐藏通道(hidden=true)。 - 设备 [设备详情](https://api.ccnvr.com/528546736e0.md): - 设备 [修改设备](https://api.ccnvr.com/528546737e0.md): - 设备 [删除设备(级联删除其下所有通道)](https://api.ccnvr.com/528546738e0.md): 删除设备及其下所有通道;删除前停止播放、解绑录像计划并归档通道元数据,已有录像文件保留。 - 设备 [刷新设备目录(同步通道)](https://api.ccnvr.com/528546739e0.md): GB28181/ONVIF 重新查询设备目录并同步通道;用户自定义的通道名称和 hidden 状态不会被覆盖。 - 通道 [隐藏设备下的通道](https://api.ccnvr.com/528546740e0.md): 软删除:设置 hidden=true,通道默认不再出现在通道列表中;设备目录同步不会重新显示。 - 通道 [恢复隐藏通道](https://api.ccnvr.com/528546741e0.md): 恢复 hidden=false,通道重新出现在通道列表中。 - 通道 [通道列表](https://api.ccnvr.com/528546742e0.md): - 通道 [添加 RTMP/RTSP 通道(自动创建单通道虚拟设备)](https://api.ccnvr.com/528546743e0.md): - 通道 [通道详情](https://api.ccnvr.com/528546744e0.md): 返回单个通道的基础信息与云台能力(ptz 字段),用于播放页判断协议与云台是否可用。 - 通道 [修改通道(名称/流配置)](https://api.ccnvr.com/528546745e0.md): 修改通道显示名称与流配置;设备目录同步不会覆盖用户自定义的 name。 - 通道 [获取播放地址](https://api.ccnvr.com/528546746e0.md): - 通道 [停止播放](https://api.ccnvr.com/528546747e0.md): - 通道 [创建语音对讲票据](https://api.ccnvr.com/528546748e0.md): - 通道 [获取通道快照(缓存优先,过期后台刷新)](https://api.ccnvr.com/528546749e0.md): - 通道 [查询通道录像计划](https://api.ccnvr.com/528546750e0.md): - 通道 [绑定通道录像计划](https://api.ccnvr.com/528546751e0.md): - 通道 [解绑通道录像计划](https://api.ccnvr.com/528546752e0.md): - 通道 [云台控制](https://api.ccnvr.com/528546753e0.md): 按通道所属协议分发:GB28181 走 SIP MESSAGE(控制码遵循 GB/T 28181-2022 附录 A.3),ONVIF 走 ONVIF PTZ 服务; - 通道 [获取流媒体信息](https://api.ccnvr.com/528546754e0.md): - ONVIF [ONVIF 局域网设备发现](https://api.ccnvr.com/528546755e0.md): 添加 ONVIF 设备的步骤一:发送 WS-Discovery Probe,返回局域网设备 JSON。注意:这是普通 JSON 接口,不是 SSE。 - ONVIF [ONVIF 设备连接测试](https://api.ccnvr.com/528546756e0.md): 添加 ONVIF 设备的步骤二:用填写地址和账号试连,返回厂商/型号/固件。 - 录像 [录像计划列表](https://api.ccnvr.com/528546757e0.md): - 录像 [新建录像计划](https://api.ccnvr.com/528546758e0.md): - 录像 [录像计划详情](https://api.ccnvr.com/528546759e0.md): - 录像 [更新录像计划](https://api.ccnvr.com/528546760e0.md): - 录像 [删除录像计划并解绑通道](https://api.ccnvr.com/528546761e0.md): - 录像 [查询录像播放地址](https://api.ccnvr.com/528546762e0.md): - 录像 [查询录像时间轴](https://api.ccnvr.com/528546763e0.md): - 录像 [有录像的通道列表](https://api.ccnvr.com/528546764e0.md): 返回所有有录像的通道(含已删除但仍有录像的归档通道),以及录像段数、占用空间、时间跨度,和是否绑定了启用中的录像计划。 - 录像 [单通道录像汇总](https://api.ccnvr.com/528546765e0.md): 按通道 ID 查询该通道的录像汇总(段数/占用空间/时间跨度)。 - 录像 [删除该通道全部录像](https://api.ccnvr.com/528546766e0.md): 删除该通道的全部录像文件与记录。破坏性操作,前端需二次确认。 - 录像 [获取录像卡片快照(最新录像画面)](https://api.ccnvr.com/528546767e0.md): 从该通道最新一条已完成录像分片生成代表性 JPEG 封面,供录像卡片展示。首次生成可能需要数秒;未就绪时返回 404,并通过 Retry-After 指示客户端稍后重试。已删除但仍有录像的通道同样支持。 - 录像 [查询月份录像日期](https://api.ccnvr.com/528546768e0.md): - 录像 [删除时间范围内的录像](https://api.ccnvr.com/528546769e0.md): - 录像 [下载时间范围内的录像](https://api.ccnvr.com/528546770e0.md): - 流媒体 [流媒体服务器列表](https://api.ccnvr.com/528546771e0.md): - 流媒体 [更新流媒体服务器并重连 ZLM](https://api.ccnvr.com/528546772e0.md): - 配置 [获取 GB28181 配置摘要](https://api.ccnvr.com/528546773e0.md): - 配置 [更新 GB28181 SIP 配置](https://api.ccnvr.com/528546774e0.md): - 配置 [获取媒体服务器配置](https://api.ccnvr.com/528546775e0.md): - 配置 [更新媒体服务器配置](https://api.ccnvr.com/528546776e0.md): - 配置 [获取流媒体分发配置](https://api.ccnvr.com/528546777e0.md): - 配置 [更新流媒体分发配置](https://api.ccnvr.com/528546778e0.md): - 配置 [读取 config.toml 原文(配置编辑器)](https://api.ccnvr.com/528546779e0.md): - 配置 [保存 config.toml 原文(配置编辑器)](https://api.ccnvr.com/528546780e0.md): 流程:TOML 语法校验(失败拒绝)→ 严格解析检测未知键(产生 warning 不拦截)→ 备份旧文件到 .bak → 原子写入。写完不自动重启,由前端决定是否触发 /app/restart。 - 配置 [读取应用配置](https://api.ccnvr.com/528546781e0.md): - 配置 [更新应用名称、语言或初始化标记](https://api.ccnvr.com/528546782e0.md): - 配置 [更新当前界面语言(所有登录用户)](https://api.ccnvr.com/528546783e0.md): - 告警中心 [设备告警列表(国标 + ONVIF)](https://api.ccnvr.com/528546784e0.md): 统一告警中心数据源,国标和 ONVIF 告警共用此接口;ONVIF 告警传 source=onvif,国标传 source=gb28181。 - 告警中心 [告警详情](https://api.ccnvr.com/528546785e0.md): - 告警中心 [删除告警](https://api.ccnvr.com/528546786e0.md): - 告警中心 [获取告警快照图片](https://api.ccnvr.com/528546787e0.md): path 为告警记录返回的 snapshot 相对路径。 - 告警中心 [批量删除告警](https://api.ccnvr.com/528546788e0.md): ## Schemas - [DefaultOutput](https://api.ccnvr.com/314877631d0.md): - [AIWebhookOutput](https://api.ccnvr.com/314877632d0.md): - [Health](https://api.ccnvr.com/314877633d0.md): - [KV](https://api.ccnvr.com/314877634d0.md): - [Metrics](https://api.ccnvr.com/314877635d0.md): - [UserInfo](https://api.ccnvr.com/323299095d0.md): - [LoginInput](https://api.ccnvr.com/314877636d0.md): - [LoginOutput](https://api.ccnvr.com/314877637d0.md): - [PublicKey](https://api.ccnvr.com/314877638d0.md): - [UserAccessOutput](https://api.ccnvr.com/323299096d0.md): - [CredentialsInput](https://api.ccnvr.com/314877639d0.md): - [Pager](https://api.ccnvr.com/314877640d0.md): - [UserCreateInput](https://api.ccnvr.com/323299097d0.md): - [UserUpdateInput](https://api.ccnvr.com/323299098d0.md): - [Zone](https://api.ccnvr.com/314877642d0.md): - [PasswordResetInput](https://api.ccnvr.com/323299099d0.md): - [PermissionItem](https://api.ccnvr.com/323299100d0.md): - [PermissionGroup](https://api.ccnvr.com/323299101d0.md): - [PermissionCatalogOutput](https://api.ccnvr.com/323299102d0.md): - [AddDevice](https://api.ccnvr.com/314877646d0.md): - [RoleInput](https://api.ccnvr.com/323299103d0.md): - [EditDevice](https://api.ccnvr.com/314877647d0.md): - [Role](https://api.ccnvr.com/323299104d0.md): - [RoleListOutput](https://api.ccnvr.com/323299105d0.md): - [UserListItem](https://api.ccnvr.com/323299106d0.md): - [AddZone](https://api.ccnvr.com/314877650d0.md): - [UserResources](https://api.ccnvr.com/323299107d0.md): - [PlayOutput](https://api.ccnvr.com/314877651d0.md): - [UserListOutput](https://api.ccnvr.com/323299108d0.md): - [DeviceExt](https://api.ccnvr.com/314877641d0.md): - [SchedulePeriod](https://api.ccnvr.com/315199767d0.md): - [EventRecordingConfig](https://api.ccnvr.com/315199768d0.md): - [StreamConfig](https://api.ccnvr.com/314877643d0.md): - [Channel](https://api.ccnvr.com/314877644d0.md): - [Device](https://api.ccnvr.com/314877645d0.md): - [PTZ](https://api.ccnvr.com/314877654d0.md): - [Event](https://api.ccnvr.com/314877657d0.md): - [DeleteRecordings](https://api.ccnvr.com/314901461d0.md): - [ChannelRecordingPlan](https://api.ccnvr.com/315199771d0.md): - [AddChannel](https://api.ccnvr.com/314877648d0.md): - [Recording](https://api.ccnvr.com/314877655d0.md): - [RecordingPlay](https://api.ccnvr.com/314901460d0.md): - [EditChannel](https://api.ccnvr.com/314877649d0.md): - [SIP](https://api.ccnvr.com/314877661d0.md): - [ConfigInfo](https://api.ccnvr.com/314877662d0.md): - [Metadata](https://api.ccnvr.com/314877663d0.md): - [AIStats](https://api.ccnvr.com/314877664d0.md): - [RecordingPlanInput](https://api.ccnvr.com/315199769d0.md): - [AIKeepalive](https://api.ccnvr.com/314877665d0.md): - [RecordingPlan](https://api.ccnvr.com/315199770d0.md): - [AIStarted](https://api.ccnvr.com/314877666d0.md): - [AIStopped](https://api.ccnvr.com/314877667d0.md): - [AIBoundingBox](https://api.ccnvr.com/314877668d0.md): - [AINormBox](https://api.ccnvr.com/314877669d0.md): - [LogEntry](https://api.ccnvr.com/317062679d0.md): - [AIDetection](https://api.ccnvr.com/314877670d0.md): - [LogsOutput](https://api.ccnvr.com/317062680d0.md): - [OnvifDiscoveredDevice](https://api.ccnvr.com/323299400d0.md): - [MonthlyStats](https://api.ccnvr.com/314877656d0.md): - [AIDetectionInput](https://api.ccnvr.com/314877671d0.md): - [GetRawConfigOutput](https://api.ccnvr.com/317062681d0.md): - [OnvifDiscoverOutput](https://api.ccnvr.com/323299401d0.md): - [WebhookForward](https://api.ccnvr.com/314877672d0.md): - [UpdateRawConfigInput](https://api.ccnvr.com/317062682d0.md): - [RecordChannelArchive](https://api.ccnvr.com/323299109d0.md): - [OnvifProbeInput](https://api.ccnvr.com/323299402d0.md): - [ZLMStreamChanged](https://api.ccnvr.com/314877673d0.md): - [UpdateRawConfigOutput](https://api.ccnvr.com/317062683d0.md): - [OnvifProbeOutput](https://api.ccnvr.com/323299403d0.md): - [ZLMPublish](https://api.ccnvr.com/314877674d0.md): - [Alarm](https://api.ccnvr.com/317062678d0.md): - [AppPublicInfo](https://api.ccnvr.com/323299404d0.md): - [StreamPush](https://api.ccnvr.com/314877658d0.md): - [ZLMNoneReader](https://api.ccnvr.com/314877675d0.md): - [LicenseLimits](https://api.ccnvr.com/323299405d0.md): - [StreamProxy](https://api.ccnvr.com/314877659d0.md): - [ZLMRTPTimeout](https://api.ccnvr.com/314877676d0.md): - [LicenseState](https://api.ccnvr.com/323299406d0.md): - [MediaServer](https://api.ccnvr.com/314877660d0.md): - [ZLMRecordTS](https://api.ccnvr.com/314901255d0.md): - [LicenseMachine](https://api.ccnvr.com/323299407d0.md): - [DeviceList](https://api.ccnvr.com/314877678d0.md): - [EditMediaServerInput](https://api.ccnvr.com/323299110d0.md): - [LicenseUsage](https://api.ccnvr.com/323299408d0.md): - [ChannelList](https://api.ccnvr.com/314877679d0.md): - [VersionInfo](https://api.ccnvr.com/323299409d0.md): - [PendingUpdate](https://api.ccnvr.com/323299410d0.md): - [RecordingList](https://api.ccnvr.com/314877681d0.md): - [UploadInitOutput](https://api.ccnvr.com/323299411d0.md): - [StreamPushList](https://api.ccnvr.com/314877682d0.md): - [UploadCompleteOutput](https://api.ccnvr.com/323299412d0.md): - [StreamProxyList](https://api.ccnvr.com/314877683d0.md): - [MediaConfig](https://api.ccnvr.com/323299413d0.md): - [MediaServerList](https://api.ccnvr.com/314877684d0.md): - [DistributionConfig](https://api.ccnvr.com/323299414d0.md): - [ZoneList](https://api.ccnvr.com/314877685d0.md): - [SystemNicsOutput](https://api.ccnvr.com/323299415d0.md): - [TalkStart](https://api.ccnvr.com/323299416d0.md): - [Timeline](https://api.ccnvr.com/314877686d0.md): - [Profiles](https://api.ccnvr.com/314877688d0.md): - [Version](https://api.ccnvr.com/314877689d0.md): - [Msg](https://api.ccnvr.com/314877690d0.md): - [EventsResponse](https://api.ccnvr.com/314877691d0.md): - [MediaInfo](https://api.ccnvr.com/314877692d0.md): - [SystemCPU](https://api.ccnvr.com/315893014d0.md): - [AlarmList](https://api.ccnvr.com/317062684d0.md): - [SystemMemory](https://api.ccnvr.com/315893015d0.md): - [SystemNetworkInterface](https://api.ccnvr.com/315893016d0.md): - [SystemNetwork](https://api.ccnvr.com/315893017d0.md): - [SystemDisk](https://api.ccnvr.com/315893018d0.md): - [SystemHost](https://api.ccnvr.com/315893019d0.md): - [SystemApp](https://api.ccnvr.com/315893020d0.md): - [RecordChannelArchiveList](https://api.ccnvr.com/323299111d0.md): - [SystemPoint](https://api.ccnvr.com/315893021d0.md): - [EventList](https://api.ccnvr.com/314877680d0.md): - [StorageSummary](https://api.ccnvr.com/315893023d0.md): - [StorageChannel](https://api.ccnvr.com/315893024d0.md): - [StorageStats](https://api.ccnvr.com/315893025d0.md): - [SystemStats](https://api.ccnvr.com/315893022d0.md):