API概览
更新时间 2024-10-16 10:56:43
最近更新时间: 2024-10-16 10:56:43
本节主要介绍各个管理模块的API概览。
智能视图服务产品API概览请参考API概览。
设备管理
| 功能名称 | 英文名称 | 描述 |
|---|---|---|
| 创建设备 | createDevice | 本接口用于创建设备。 |
| 删除设备 | deleteDevice | 本接口用于删除设备。 |
| 修改设备 | modifyDevice | 本接口用于修改设备信息。 |
| 查询设备 | describeDevice | 本接口用于通过设备ID查询设备信息。 |
| 查询设备列表 | describeDevices | 本接口用于查询设备列表。 |
设备树管理
目录管理
| 功能名称 | 英文名称 | 描述 |
|---|---|---|
| 创建目录 | createVSSDir | 本接口用于创建目录。 |
| 删除目录 | deleteVSSDir | 本接口用于删除目录。 |
| 修改目录 | modifyVSSDir | 本接口用于修改单个目录信息。 |
| 查询目录 | describeVSSDir | 本接口用于查询目录信息。 |
| 查询目录列表 | describeVSSDirs | 本接口用于查询目录列表。 |
| 修改设备目录 | bindVSSDir | 本接口用于修改设备的目录。 |
凭证管理
GB28181凭证
| 功能名称 | 英文名称 | 描述 |
|---|---|---|
| 创建GB28181凭证 | createGBCert | 本接口用于创建GB28181凭证，该凭证用于GB28181设备注册。 |
| 删除GB28181凭证 | deleteGBCert | 本接口用于删除GB28181凭证。 |
| 更新GB28181凭证 | modifyGBCert | 本接口用于更新GB28181凭证。 |
| 查询GB28181凭证 | describeGBCert | 本接口用于查询GB28181凭证信息。 |
| 查询GB28181凭证列表 | describeGBCerts | 本接口用于查询GB28181凭证列表。 |
模板管理
视频存储模板
| 功能名称 | 英文名称 | 描述 |
|---|---|---|
| 创建存储模板 | createRecordTemplate | 本接口用于创建视频存储模板，支持配置录制类型、存储时长等。 |
| 删除存储模板 | deleteRecordTemplate | 本接口用于删除存储模板。 |
| 修改存储模板 | modifyRecordTemplate | 本接口用于修改视频存储模板，支持修改录制类型、存储时长等。 |
| 查询存储模板 | describeRecordTemplate | 本接口用于查询单个视频存储模板的信息。 |
| 查询存储模板列表 | describeRecordTemplates | 本接口用于查询视频存储模板列表。 |
| 查询存储模板绑定的设备列表 | describeRecordTemplateDevices | 本接口用于查询存储模板下绑定的设备列表。 |
视频设备
视频设备接入
| 功能名称 | 英文名称 | 描述 |
|---|---|---|
| 启用流 | startPush | 本接口用于启动设备拉流，该操作会启动设备上的所有流。 |
| 停用流 | stopPush | 本接口用于停止设备拉流，该操作会停止设备上的所有流。 |
视频流管理
| 功能名称 | 英文名称 | 描述 |
|---|---|---|
| 查询设备云端直播流 | descCloudLiveStreams | 本接口用于查询设备在云端的直播流。 |
视频存储管理
| 功能名称 | 英文名称 | 描述 |
|---|---|---|
| 绑定存储模板 | bindRecordTemplate | 本接口用于绑定视频存储模板至设备。 |
| 解绑存储模板 | unBindRecordTemplate | 本接口用于解绑设备的视频存储模板。 |
| 启动云端录制 | startRecordTask | 本接口用于启动设备的云端录制。 |
| 停止云端录制 | stopRecordTask | 本接口用于停止设备的云端录制。 |
| 查询设备绑定的存储模板 | describeDeviceRecordTemplates | 本接口用于查询设备绑定的视频存储模板。 |
| 查询录像列表 | describeRecords | 本接口用于查询设备录制于云端的录像文件列表，PlayUrl可用于点播该文件。 |
云台控制
| 功能名称 | 英文名称 | 描述 |
|---|---|---|
| 开启镜头转动 | startDeviceMove | 本接口用于开启镜头转动，如水平、垂直、缩放（变焦）等。 |
| 停止镜头转动 | stopDeviceMove | 本接口用于停止镜头转动，如水平、垂直、缩放（变焦）等。 |
| 开启镜头调节 | startDeviceAdjust | 本接口用于调节镜头聚焦或光圈。 |
| 停止镜头调节 | stopDeviceAdjust | 本接口用于停止镜头的聚焦或光圈调节。 |
回调管理
回调模板
| 功能名称 | 英文名称 | 描述 |
|---|---|---|
| 创建回调模板 | createCallbackTemplate | 本接口用于创建回调模板。 |
| 删除回调模板 | deleteCallbackTemplate | 本接口用于删除回调模板。 |
| 修改回调模板 | modifyCallbackTemplate | 本接口用于修改回调模板。 |
| 查询回调模板 | describeCallbackTemplate | 本接口用于查询单个回调模板的信息。 |
| 查询回调模板列表 | describeCallbackTemplates | 本接口用于查询回调模板列表。 |
回调规则
| 功能名称 | 英文名称 | 描述 |
|---|---|---|
| 创建回调规则 | createCallbackRule | 本接口用于创建回调规则，即绑定回调模板至设备。 |
| 删除回调规则 | deleteCallbackRule | 本接口用于删除回调规则，即解绑设备的回调模板。 |
| 查询回调规则 | describeCallbackRule | 本接口用于查询回调规则，即查询设备绑定的回调模板。 |
| 查询回调规则列表 | describeCallbackRules | 本接口用于查询回调规则列表，即查询回调模板绑定的设备列表。 |
计费管理
资源计费
| 功能名称 | 英文名称 | 描述 |
|---|---|---|
| 查询用户资源列表 | desResourcePkgs | 本接口用于查询用户名下有效的资源列表。 |
| 查询设备资源列表 | describeAttachedResources | 本接口用于查询指定设备的服务配置列表，包含视频、视图和AI配置等。 |
