{ "name": "iotvideoindustry", "display_name": "物联网智能视频服务（行业版）", "description": "设备管理、设备分组管理、视频流管理、录像管理、录制计划管理", "domain": "other", "api_version": "2020-12-01", "endpoint": "iotvideoindustry.tencentcloudapi.com", "actions": [ { "name": "BindGroupDevices", "description": "本接口(BindGroupDevices) 用于绑定设备到分组。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "分组ID", "example": "group-1234abcd" }, { "name": "DeviceList", "type": "array", "required": true, "description": "设备唯一标识列表", "example": "[\"test01\",\"test02\"]", "item_type": "string" } ], "required": [ "GroupId", "DeviceList" ] }, { "name": "ControlChannelLocalRecord", "description": "本接口（ControlChannelLocalRecord）用于对通道本地回放流进行控制，包括暂停、播放、拉动、结束等", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备唯一标识", "example": "34020000001180000036_34020000001320000092" }, { "name": "ChannelId", "type": "string", "required": true, "description": "通道唯一标识", "example": "34020000001180000036_34020000001320000092" }, { "name": "StreamId", "type": "string", "required": true, "description": "流Id，流的唯一标识", "example": "1038455659" }, { "name": "Command", "type": "string", "required": true, "description": "控制参数，转义的json字符串 目前支持的command： \"Command\": \"{\"Action\":\"PAUSE\"}\" 暂停 \"Command\": \"{\"Action\":\"PLAY\"}\" 暂停恢复 \"Command\": \"{\"Action\":\"PLAY\",\"Offset\":\"15\"}\" 基于文件起始时间点的位置偏移，单位秒", "example": "{\\\"Action\\\":\\\"pause\\\"}" } ], "required": [ "DeviceId", "ChannelId", "StreamId", "Command" ] }, { "name": "ControlChannelPTZ", "description": "本接口(ControlChannelPTZ) 用于对支持GB28181 PTZ信令的设备进行指定通道的远程控制。", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备唯一标识", "example": "99933020581320000064_99933020581320000064" }, { "name": "ChannelId", "type": "string", "required": true, "description": "通道唯一标识", "example": "34020000001180000036_34020000001320000092" }, { "name": "Command", "type": "string", "required": true, "description": "PTZ控制命令类型： stop - 停止当前PTZ信令 left - 向左移动 right - 向右移动 up - 向上移动 down - 向下移动 leftUp - 左上移动 leftDown - 左下移动 rightUp - 右上移动 rightDown - 右下移动 zoomOut - 镜头缩小 zoomIn - 镜头放大 irisIn - 光圈缩小 irisOut - 光圈放大 focusIn - 焦距变近 focusOut - 焦距变远", "example": "left" } ], "required": [ "DeviceId", "ChannelId", "Command" ] }, { "name": "ControlDevicePTZ", "description": "本接口(ControlDevicePTZ) 用于对支持GB28181 PTZ信令的设备进行远程控制。 请使用ControlChannelPTZ接口", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备唯一标识", "example": "99933020581320000064_99933020581320000064" }, { "name": "Command", "type": "string", "required": true, "description": "PTZ控制命令类型： stop - 停止当前PTZ信令 left - 向左移动 right - 向右移动 up - 向上移动 down - 向下移动 leftUp - 左上移动 leftDown - 左下移动 rightUp - 右上移动 rightDown - 右下移动 zoomOut - 镜头缩小 zoomIn - 镜头放大 irisIn - 光圈缩小 irisOut - 光圈放大 focusIn - 焦距变近 focusOut - 焦距变远", "example": "left" }, { "name": "ChannelId", "type": "string", "required": false, "description": "通道唯一标识", "example": "34020000001180000036_34020000001320000092" } ], "required": [ "DeviceId", "Command" ] }, { "name": "ControlHomePosition", "description": "看守位控制", "status": "online", "parameters": [ { "name": "ChannelId", "type": "string", "required": true, "description": "通道ID", "example": "99576636581320000310_99782261871320000002" }, { "name": "DeviceId", "type": "string", "required": true, "description": "设备Id", "example": "99576636581320000310_99782261871320000002" }, { "name": "Enable", "type": "integer", "required": false, "description": "看守位使能 0-停用看守位 1-启用看守位", "example": "0" }, { "name": "PresetId", "type": "integer", "required": false, "description": "预置位编码 范围1-8，启用看守位时必填", "example": "4" }, { "name": "ResetTime", "type": "integer", "required": false, "description": "看守位自动归位时间， 启用看守位时必填", "example": "1628600451" } ], "required": [ "ChannelId", "DeviceId" ] }, { "name": "ControlPreset", "description": "预置位控制", "status": "online", "parameters": [ { "name": "ChannelId", "type": "string", "required": true, "description": "通道ID", "example": "99576636581320000310_99782261871320000002" }, { "name": "Command", "type": "string", "required": true, "description": "控制命令： Set-设置当前位置为预置位 Del-删除指定的预置位 Call-调用指定的预置位", "example": "Del" }, { "name": "PresetId", "type": "integer", "required": true, "description": "预置位编码 范围1-8", "example": "1" }, { "name": "DeviceId", "type": "string", "required": true, "description": "设备Id", "example": "99576636581320000310_99782261871320000002" } ], "required": [ "ChannelId", "Command", "PresetId", "DeviceId" ] }, { "name": "ControlRecordStream", "description": "对回放流进行控制，包括暂停、播放、拉动、结束等 请使用ControlChannelLocalRecord接口", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备Id，设备的唯一标识", "example": "34020000001180000036_34020000001320000092" }, { "name": "StreamId", "type": "string", "required": true, "description": "流Id，流的唯一标识", "example": "1038455659" }, { "name": "Command", "type": "string", "required": true, "description": "|控制参数，CmdJson结构转义的json字符串。| Action | string |是|控制动作，play(用于暂停后恢复播放)、pause（暂停）、teardown(停止)、jump(拖动播放) | Offset | uint |否|拖动播放时的时间偏移量（相对于起始时间）,单位：秒 目前支持的command： \"Command\": \"{\"Action\":\"PAUSE\"}\" 暂停 \"Command\": \"{\"Action\":\"PLAY\"}\" 暂停恢复 \"Command\": \"{\"Action\":\"PLAY\",\"Offset\":\"15\"}\" 位置偏移，可以替代jump操作", "example": "{\\\"Action\\\":\\\"pause\\\"}" }, { "name": "ChannelId", "type": "string", "required": false, "description": "通道唯一标识", "example": "34020000001180000036_34020000001320000092" } ], "required": [ "DeviceId", "StreamId", "Command" ] }, { "name": "CreateDevice", "description": "本接口(CreateDevice) 用于创建设备。", "status": "online", "parameters": [ { "name": "NickName", "type": "string", "required": true, "description": "设备名称", "example": "myDevice" }, { "name": "PassWord", "type": "string", "required": true, "description": "设备密码", "example": "password" }, { "name": "DeviceType", "type": "integer", "required": false, "description": "设备类型，1：国标VMS设备(公有云不支持此类型)，2：国标IPC设备，3：国标NVR设备，9：智能告警设备(公有云不支持此类型)", "example": "2" }, { "name": "GroupId", "type": "string", "required": false, "description": "设备需要绑定的分组ID，参数为空则默认绑定到根分组", "example": "groupID" } ], "required": [ "NickName", "PassWord" ] }, { "name": "CreateDeviceGroup", "description": "本接口(CreateDeviceGroup) 用于创建设备管理分组。", "status": "online", "parameters": [ { "name": "GroupName", "type": "string", "required": true, "description": "分组名称", "example": "myGroup" }, { "name": "ParentId", "type": "string", "required": true, "description": "父分组ID", "example": "group_root" }, { "name": "GroupDescribe", "type": "string", "required": false, "description": "分组描述", "example": "test1" } ], "required": [ "GroupName", "ParentId" ] }, { "name": "CreateLiveChannel", "description": "创建直播频道", "status": "online", "parameters": [ { "name": "LiveChannelName", "type": "string", "required": true, "description": "直播频道名称", "example": "直播频道001" }, { "name": "LiveChannelType", "type": "integer", "required": true, "description": "直播频道类型 1：固定直播；2：移动直播", "example": "1" } ], "required": [ "LiveChannelName", "LiveChannelType" ] }, { "name": "CreateLiveRecordPlan", "description": "创建直播录制计划，直播录制接口，暂时下线中，只有国标接口支持云端录制", "status": "online", "parameters": [ { "name": "PlanName", "type": "string", "required": true, "description": "录制计划名", "example": "固定直播录制008" }, { "name": "PlanType", "type": "integer", "required": true, "description": "计划类型 1：固定直播 2：移动直播", "example": "1" }, { "name": "TemplateId", "type": "string", "required": false, "description": "时间模板ID,固定直播时为必填", "example": "tgrp-cyjjxyyyds" }, { "name": "RecordStorageTime", "type": "integer", "required": false, "description": "录制文件存储时长，单位天，默认30天", "example": "30" }, { "name": "LiveChannelIds", "type": "array", "required": false, "description": "绑定的直播频道ID列表", "example": "[\"channel-01\",\"channel-02\"]", "item_type": "string" } ], "required": [ "PlanName", "PlanType" ] }, { "name": "CreateMessageForward", "description": "创建消息转发配置", "status": "online", "parameters": [ { "name": "RegionId", "type": "string", "required": true, "description": "区域ID", "example": "gz" }, { "name": "RegionName", "type": "string", "required": true, "description": "区域名称", "example": "广州" }, { "name": "Instance", "type": "string", "required": true, "description": "实例ID", "example": "kafka_instance" }, { "name": "InstanceName", "type": "string", "required": true, "description": "实例名称", "example": "实例名称" }, { "name": "MessageType", "type": "string", "required": true, "description": "json数组， 转发类型 1: 告警 2:GPS", "example": "[1,2]" }, { "name": "TopicId", "type": "string", "required": true, "description": "kafka topic id", "example": "topic1" }, { "name": "TopicName", "type": "string", "required": true, "description": "kafka topic 名称", "example": "topname11" } ], "required": [ "RegionId", "RegionName", "Instance", "InstanceName", "MessageType", "TopicId", "TopicName" ] }, { "name": "CreateRecordPlan", "description": "本接口(CreateRecordPlan) 用于创建录制计划，使设备与时间模板绑定，以便及时启动录制 请使用CreateRecordingPlan代替", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "计划名称", "example": "myPlan" }, { "name": "TimeTemplateId", "type": "string", "required": true, "description": "时间模板ID", "example": "template-xxxxx" }, { "name": "EventId", "type": "integer", "required": true, "description": "触发录制的事件类别 1:全部", "example": "1" }, { "name": "Devices", "type": "array", "required": false, "description": "该录制计划绑定的设备列表", "example": "无", "item_type": "object", "children": [ { "name": "DeviceId", "type": "string", "required": false, "description": "设备唯一标识", "example": "34020000001180000036_34020000001320000092" }, { "name": "ChannelId", "type": "string", "required": false, "description": "通道唯一标识", "example": "34020000001180000036_34020000001320000092" } ] }, { "name": "RecordStorageTime", "type": "integer", "required": false, "description": "存储周期", "example": "2" } ], "required": [ "Name", "TimeTemplateId", "EventId" ] }, { "name": "CreateRecordingPlan", "description": "本接口(CreateRecordingPlan) 用于创建录制计划，使通道与时间模板绑定，以便及时启动录制", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "计划名称", "example": "allday" }, { "name": "TimeTemplateId", "type": "string", "required": true, "description": "时间模板ID", "example": "template-all" }, { "name": "Channels", "type": "array", "required": false, "description": "该录制计划绑定的通道列表", "example": "无", "item_type": "object", "children": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备唯一标识", "example": "34020000001180000036_34020000001320000092" }, { "name": "ChannelId", "type": "string", "required": true, "description": "通道唯一标识", "example": "34020000001180000036_34020000001320000092" } ] }, { "name": "RecordStorageTime", "type": "integer", "required": false, "description": "存储周期(天)；默认存储30天", "example": "30" } ], "required": [ "Name", "TimeTemplateId" ] }, { "name": "CreateScene", "description": "创建场景", "status": "online", "parameters": [ { "name": "SceneName", "type": "string", "required": true, "description": "场景名称", "example": "告警录制" }, { "name": "SceneTrigger", "type": "string", "required": true, "description": "场景触发规则", "example": "{\"2\":{\"Name\":\"设备报警\",\"WarnType\":{\"1\":\"视频丢失报警\",\"2\":\"设备防拆报警\",\"3\":\"存" }, { "name": "RecordDuration", "type": "integer", "required": true, "description": "录制时长 (秒)", "example": "3600" }, { "name": "StoreDuration", "type": "integer", "required": true, "description": "录像存储时长(天)", "example": "30" }, { "name": "Devices", "type": "array", "required": false, "description": "设备列表(不推荐使用)", "example": "无", "item_type": "object", "children": [ { "name": "DeviceId", "type": "string", "required": false, "description": "设备唯一标识", "example": "34020000001180000036_34020000001320000092" }, { "name": "ChannelId", "type": "string", "required": false, "description": "通道唯一标识", "example": "34020000001180000036_34020000001320000092" } ] }, { "name": "Channels", "type": "array", "required": false, "description": "通道列表", "example": "无", "item_type": "object", "children": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备唯一标识", "example": "34020000001180000036_34020000001320000092" }, { "name": "ChannelId", "type": "string", "required": true, "description": "通道唯一标识", "example": "34020000001180000036_34020000001320000092" } ] } ], "required": [ "SceneName", "SceneTrigger", "RecordDuration", "StoreDuration" ] }, { "name": "CreateTimeTemplate", "description": "本接口(CreateTimeTemplate) 用于根据模板描述的具体录制时间片段，创建定制化的时间模板。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "时间模板名称", "example": "myTemplate" }, { "name": "IsAllWeek", "type": "integer", "required": true, "description": "是否为每周全时录制（即7*24h录制），0：非全时录制，1；全时录制，默认0", "example": "0" }, { "name": "TimeTemplateSpecs", "type": "array", "required": false, "description": "当IsAllWeek为0时必选，用于描述模板的各个时间片段", "example": "无", "item_type": "object", "children": [ { "name": "DayofWeek", "type": "integer", "required": true, "description": "一周中的周几", "example": "2" }, { "name": "BeginTime", "type": "string", "required": true, "description": "时间片段的开始时分。格式【HH:MM】", "example": "12:30" }, { "name": "EndTime", "type": "string", "required": true, "description": "时间片段的结束时分。格式【HH:MM】", "example": "14:30" } ] } ], "required": [ "Name", "IsAllWeek" ] }, { "name": "DeleteChannel", "description": "本接口用于删除设备下的通道 注意： 在线状态的设备不允许删除", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备ID", "example": "99576636581320000310_99782261871320000002" }, { "name": "ChannelId", "type": "string", "required": true, "description": "通道ID", "example": "99576636581320000310_99782261871320000002" } ], "required": [ "DeviceId", "ChannelId" ] }, { "name": "DeleteDevice", "description": "本接口(DeleteDevice)用于删除设备。", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备唯一标识", "example": "device01" } ], "required": [ "DeviceId" ] }, { "name": "DeleteDeviceGroup", "description": "本接口(DeleteDeviceGroup)用于删除分组。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "分组ID", "example": "group-xxx" } ], "required": [ "GroupId" ] }, { "name": "DeleteLiveChannel", "description": "删除直播接口", "status": "online", "parameters": [ { "name": "LiveChannelId", "type": "string", "required": true, "description": "直播频道ID", "example": "72f556500f0311ec806aacde48001122" } ], "required": [ "LiveChannelId" ] }, { "name": "DeleteLiveRecordPlan", "description": "删除直播录制计划", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "录制计划ID", "example": "plan-001" } ], "required": [ "PlanId" ] }, { "name": "DeleteLiveVideoList", "description": "直播录像删除", "status": "online", "parameters": [ { "name": "IntIDs", "type": "array", "required": true, "description": "视频ID 列表, 大小限制(100)", "example": "[1234,5667,8845]", "item_type": "integer" } ], "required": [ "IntIDs" ] }, { "name": "DeleteMessageForward", "description": "删除消息转发配置", "status": "online", "parameters": [ { "name": "IntId", "type": "integer", "required": true, "description": "配置ID", "example": "16242" } ], "required": [ "IntId" ] }, { "name": "DeleteRecordPlan", "description": "本接口(DeleteRecordPlan)用于删除录制计划 录制计划删除的同时，会停止该录制计划下的全部录制任务。 请使用DeleteRecordingPlan接口", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "录制计划ID", "example": "plan-xxxxx" } ], "required": [ "PlanId" ] }, { "name": "DeleteRecordingPlan", "description": "本接口(DeleteRecordingPlan)用于删除录制计划 录制计划删除的同时，会停止该录制计划下的全部录制任务。", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "录制计划ID", "example": "plan-xxxxx" } ], "required": [ "PlanId" ] }, { "name": "DeleteScene", "description": "删除场景", "status": "online", "parameters": [ { "name": "IntId", "type": "integer", "required": true, "description": "场景ID", "example": "11" } ], "required": [ "IntId" ] }, { "name": "DeleteTimeTemplate", "description": "本接口(DeleteTimeTemplate) 用于删除时间模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "时间模板ID", "example": "tgrp-jfs89ah1" } ], "required": [ "TemplateId" ] }, { "name": "DeleteVideoList", "description": "删除录像存储列表", "status": "online", "parameters": [ { "name": "InitIDs", "type": "array", "required": true, "description": "视频ID列表长度限制100内", "example": "[12424,43535]", "item_type": "integer" } ], "required": [ "InitIDs" ] }, { "name": "DeleteWarning", "description": "设备告警-删除告警", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": false, "description": "告警ID", "example": "3" }, { "name": "Index", "type": "string", "required": false, "description": "告警索引", "example": "1624204800" } ], "required": [] }, { "name": "DescribeAbnormalEvents", "description": "获取异常事件统计", "status": "online", "parameters": [ { "name": "StartTime", "type": "integer", "required": true, "description": "开始时间", "example": "1624204800" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束时间", "example": "1624204800" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeAllDeviceList", "description": "本接口(DescribeAllDeviceList) 用于获取设备列表。 请使用DescribeDevicesList接口", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制，默认200", "example": "10" }, { "name": "NickName", "type": "string", "required": false, "description": "设备名称，需要模糊匹配设备名称时为必填", "example": "myDevice" }, { "name": "DeviceIds", "type": "array", "required": false, "description": "DeviceId列表，需要精确查找设备时为必填", "example": "99870353841320000007_99870353841320000007", "item_type": "string" }, { "name": "DeviceTypes", "type": "array", "required": false, "description": "设备类型过滤，设备类型，1：国标VMS设备(公有云不支持此类型)，2：国标IPC设备，3：国标NVR设备，9：智能告警设备(公有云不支持此类型)", "example": "2,3", "item_type": "integer" } ], "required": [] }, { "name": "DescribeBindSceneChannels", "description": "获取场景绑定通道列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "条数限制最大不能超过1000", "example": "100" }, { "name": "SceneId", "type": "integer", "required": false, "description": "场景ID", "example": "23" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移值", "example": "0" } ], "required": [ "Limit" ] }, { "name": "DescribeBindSceneDevices", "description": "获取场景绑定设备列表", "status": "online", "parameters": [ { "name": "SceneId", "type": "integer", "required": false, "description": "场景ID", "example": "23" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移值", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "条数限制最大不能超过1000", "example": "100" } ], "required": [] }, { "name": "DescribeChannelLiveStreamURL", "description": "本接口(DescribeChannelLiveStreamURL)用于获取设备指定通道实时流地址，地址是动态生成，如重新播放需要调用此接口重新获取最新播放地址。 正常推流，如未设置对应录制计划，且180s无人观看此流，将会被自动掐断。", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备唯一标识，必填参数", "example": "99933020581320000064_99933020581320000064" }, { "name": "ChannelId", "type": "string", "required": true, "description": "通道唯一标识（接口升级字段为必填），必填参数", "example": "99933020581320000064_99933020581320000064" } ], "required": [ "DeviceId", "ChannelId" ] }, { "name": "DescribeChannelLocalRecordURL", "description": "本接口（DescribeChannelLocalRecordURL）用于将NVR等设备对应通道本地回放文件，通过GB28181信令推送至云端，并生成对应的实时视频流URL，流地址URL是动态生成，如需重新播放请重新调用此接口获取最新地址。 正常推流，如未设置对应录制计划，且180s无人观看此流，将会被自动掐断。", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备唯一标识", "example": "34020000001180000036_34020000001320000092" }, { "name": "ChannelId", "type": "string", "required": true, "description": "通道唯一标识", "example": "34020000001180000036_34020000001320000092" }, { "name": "RecordId", "type": "string", "required": true, "description": "录像文件Id，通过获取本地录像返回", "example": "1615995219_1616001641" }, { "name": "ExpireTime", "type": "integer", "required": true, "description": "UNIX 时间戳，30天内，URL失效时间，如180s无人观看此流则URL提前失效", "example": "1616914614" }, { "name": "StartTime", "type": "integer", "required": false, "description": "录像文件推送的开始时间，需要在RecordId参数起始时间内，可以通过此参数控制回放流起始点", "example": "1615995219" }, { "name": "EndTime", "type": "integer", "required": false, "description": "录像文件推送的结束时间，需要在RecordId参数起始时间内，可以通过此参数控制回放流起始点", "example": "1616001641" } ], "required": [ "DeviceId", "ChannelId", "RecordId", "ExpireTime" ] }, { "name": "DescribeChannelStreamURL", "description": "本接口(DescribeChannelStreamURL)用于获取设备指定通道实时流地址，地址是动态生成，如重新播放需要调用此接口重新获取最新播放地址。 正常推流，如未设置对应录制计划，且180s无人观看此流，将会被自动掐断。", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备唯一标识，必填参数", "example": "99933020581320000064_99933020581320000064" }, { "name": "ExpireTime", "type": "integer", "required": true, "description": "流地址失效时间，固定值填写0，其他参数无效，必填参数", "example": "1610199034" }, { "name": "ChannelId", "type": "string", "required": false, "description": "通道唯一标识（接口升级字段为必填），必填参数", "example": "99933020581320000064_99933020581320000064" } ], "required": [ "DeviceId", "ExpireTime" ] }, { "name": "DescribeChannels", "description": "本接口（DescribeChannels）用于获取设备下属通道列表", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备Id", "example": "34020000001180000036_34020000001320000092" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制，默认0", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认0", "example": "0" }, { "name": "ChannelTypes", "type": "array", "required": false, "description": "通道类型 0: 未知类型 1: 视频通道 2: 音频通道 3: 告警通道", "example": "[0]", "item_type": "integer" }, { "name": "PlanId", "type": "string", "required": false, "description": "录制计划ID， 当为\"null\"值时未绑定录制计划", "example": "1624204800" }, { "name": "SceneId", "type": "integer", "required": false, "description": "告警联动场景ID， 当为 -1 值时未绑定场景", "example": "243" } ], "required": [ "DeviceId" ] }, { "name": "DescribeChannelsByLiveRecordPlan", "description": "根据直播录制计划获取频道列表", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "录制计划ID", "example": "1" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页大小", "example": "20" } ], "required": [ "PlanId" ] }, { "name": "DescribeCurrentDeviceData", "description": "查询设备统计当前信息", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeDevice", "description": "获取指定设备详细信息", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备ID", "example": "34020000001180000036_34020000001320000092" } ], "required": [ "DeviceId" ] }, { "name": "DescribeDeviceEvent", "description": "获取设备事件", "status": "online", "parameters": [ { "name": "StartTime", "type": "integer", "required": true, "description": "开始时间，秒级时间戳", "example": "1624204800" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束时间，秒级时间戳", "example": "1624204800" }, { "name": "DeviceId", "type": "string", "required": false, "description": "设备Id", "example": "99576636581320000310_99782261871320000002" }, { "name": "EventTypes", "type": "array", "required": false, "description": "默认为全部 事件类型 1:注册 2:心跳 4:录制异常 5:播放异常 6:流中断", "example": "[1]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移值", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "limit限制值", "example": "100" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribeDeviceGroup", "description": "本接口(DescribeDeviceGroup)用于根据设备ID查询设备所在分组信息，可批量查询。", "status": "online", "parameters": [ { "name": "DeviceIds", "type": "array", "required": false, "description": "设备唯一标识列表", "example": "99999999991320000001_99999999991320000001", "item_type": "string" } ], "required": [] }, { "name": "DescribeDeviceList", "description": "本接口(DescribeDeviceList) 用于获取设备列表，支持模糊搜索", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制，默认200", "example": "10" }, { "name": "NickName", "type": "string", "required": false, "description": "设备名前缀", "example": "myDevice" }, { "name": "DeviceTypes", "type": "array", "required": false, "description": "设备类型，1：国标VMS设备(公有云不支持此类型)，2：国标IPC设备，3：国标NVR设备，9：智能告警设备(公有云不支持此类型)", "example": "2,3", "item_type": "integer" } ], "required": [] }, { "name": "DescribeDeviceMonitorData", "description": "查询设备统计monitor信息", "status": "online", "parameters": [ { "name": "StartTime", "type": "integer", "required": true, "description": "开始时间戳", "example": "1624204800" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束时间戳", "example": "1624204800" }, { "name": "Type", "type": "string", "required": true, "description": "类型 支持 OnlineChannels/OnlineDevices/RecordingChannels", "example": "OnlineChannels" }, { "name": "TimesSpec", "type": "string", "required": true, "description": "时间粒度 目前只支持 1h", "example": "1h" } ], "required": [ "StartTime", "EndTime", "Type", "TimesSpec" ] }, { "name": "DescribeDevicePassWord", "description": "本接口(DescribeDevicePassWord)用于查询设备密码。", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备唯一标识", "example": "99299744331320000002_99299744331320000002" } ], "required": [ "DeviceId" ] }, { "name": "DescribeDeviceStreams", "description": "本接口(DescribeDeviceStreams)用于获取设备实时流地址。 请使用DescribeChannelStreamURL接口", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备唯一标识", "example": "99933020581320000064_99933020581320000064" }, { "name": "ExpireTime", "type": "integer", "required": true, "description": "流地址失效时间", "example": "1610199034" }, { "name": "ChannelId", "type": "string", "required": false, "description": "通道唯一标识（接口升级字段为必填）", "example": "99933020581320000064_99933020581320000064" } ], "required": [ "DeviceId", "ExpireTime" ] }, { "name": "DescribeGroupById", "description": "本接口(DescribeGroupById)用于根据分组ID查询分组。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "分组ID", "example": "gro-30to7hxt" } ], "required": [ "GroupId" ] }, { "name": "DescribeGroupByPath", "description": "根据分组路径查询分组", "status": "online", "parameters": [ { "name": "GroupPath", "type": "string", "required": true, "description": "分组路径，格式为/aaa(/bbb/ccc)", "example": "/group-aaa/group-bbb" } ], "required": [ "GroupPath" ] }, { "name": "DescribeGroupDevices", "description": "本接口(DescribeGroupDevices)用于查询分组下的设备列表。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": true, "description": "分组ID", "example": "group-1234abcd" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制值，默认200", "example": "10" }, { "name": "NickName", "type": "string", "required": false, "description": "设备名称，根据设备名称模糊匹配时必填", "example": "nickname" }, { "name": "Recordable", "type": "integer", "required": false, "description": "过滤不可录制设备", "example": "1" }, { "name": "DeviceTypes", "type": "array", "required": false, "description": "当Group是普通组的时候，支持根据DeviceTypes筛选类型， 设备类型，1：国标VMS设备(公有云不支持此类型)，2：国标IPC设备，3：国标NVR设备，9：智能告警设备(公有云不支持此类型)", "example": "1", "item_type": "integer" } ], "required": [ "GroupId" ] }, { "name": "DescribeGroups", "description": "本接口(DescribeGroups)用于批量查询分组信息。", "status": "online", "parameters": [ { "name": "GroupIds", "type": "array", "required": false, "description": "分组ID列表", "example": "[\"gro-30to7hxt\",\"gro-wnvharsw\"]", "item_type": "string" } ], "required": [] }, { "name": "DescribeIPCChannels", "description": "获取IPC设备下属通道 请使用DescribeChannels接口", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制，默认0", "example": "100" }, { "name": "DeviceId", "type": "string", "required": false, "description": "设备Id", "example": "34020000001180000036_34020000001320000092" }, { "name": "ChannelTypes", "type": "array", "required": false, "description": "通道类型 0: 未知类型 1: 视频通道 2: 音频通道 3: 告警通道", "example": "[0]", "item_type": "integer" } ], "required": [] }, { "name": "DescribeLiveChannel", "description": "直播详情接口", "status": "online", "parameters": [ { "name": "LiveChannelId", "type": "string", "required": true, "description": "频道ID", "example": "e4a6427192a34cca8ea1d74815b7f458" } ], "required": [ "LiveChannelId" ] }, { "name": "DescribeLiveChannelList", "description": "直播列表接口", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "最大数", "example": "20" }, { "name": "LiveChannelType", "type": "integer", "required": false, "description": "直播频道类型，1：固定直播；2：移动直播", "example": "1" }, { "name": "RecordPlanId", "type": "string", "required": false, "description": "直播录制计划ID, null: 直播录制计划为空", "example": "lrplan-w3oovckd" }, { "name": "LiveChannelName", "type": "string", "required": false, "description": "频道名称 (支持模糊搜索)", "example": "w3oovckd" } ], "required": [ "Offset", "Limit" ] }, { "name": "DescribeLiveRecordPlanById", "description": "获取直播录制计划详情", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "录制计划ID", "example": "plan-001" } ], "required": [ "PlanId" ] }, { "name": "DescribeLiveRecordPlanIds", "description": "获取直播录制计划列表", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": false, "description": "时间模板ID", "example": "plan-001" }, { "name": "Offset", "type": "integer", "required": false, "description": "分页偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "分页大小", "example": "20" } ], "required": [] }, { "name": "DescribeLiveStream", "description": "直播拉流接口", "status": "online", "parameters": [ { "name": "LiveChannelId", "type": "string", "required": true, "description": "频道ID", "example": "e4a6427192a34cca8ea1d74815b7f458" }, { "name": "ExpireTime", "type": "integer", "required": true, "description": "过期时间 秒级unix时间戳", "example": "124177555" } ], "required": [ "LiveChannelId", "ExpireTime" ] }, { "name": "DescribeLiveVideoList", "description": "直播录像回放列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "分页的每页数量", "example": "20" }, { "name": "LiveChannelId", "type": "string", "required": true, "description": "直播频道ID", "example": "cea6f74f29164253b43411fd888f4dc3" }, { "name": "StartRecordTime", "type": "integer", "required": false, "description": "开始录制开始时间", "example": "1631007668" }, { "name": "EndRecordTime", "type": "integer", "required": false, "description": "开始录制结束时间", "example": "1631007968" }, { "name": "StartExpireTime", "type": "integer", "required": false, "description": "过期开始时间", "example": "1631117668" }, { "name": "EndExpireTime", "type": "integer", "required": false, "description": "过期结束时间", "example": "1631227668" }, { "name": "StartFileSize", "type": "integer", "required": false, "description": "文件大小范围 Byte", "example": "1024" }, { "name": "EndFileSize", "type": "integer", "required": false, "description": "文件大小范围 Byte", "example": "1024" }, { "name": "IsRecording", "type": "integer", "required": false, "description": "录制状态，5: 录制回写完", "example": "5" } ], "required": [ "Offset", "Limit", "LiveChannelId" ] }, { "name": "DescribeMessageForward", "description": "查看消息转发配置详情", "status": "online", "parameters": [ { "name": "IntId", "type": "integer", "required": true, "description": "配置ID", "example": "16242" } ], "required": [ "IntId" ] }, { "name": "DescribeMessageForwards", "description": "查看消息转发配置列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "数量限制", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移", "example": "1" } ], "required": [ "Limit" ] }, { "name": "DescribeMonitorDataByDate", "description": "运营中心-设备录像存储统计", "status": "online", "parameters": [ { "name": "StartTime", "type": "integer", "required": true, "description": "开始时间戳", "example": "1624204800" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束时间戳 最多显示30天数据", "example": "1624204800" } ], "required": [ "StartTime", "EndTime" ] }, { "name": "DescribePresetList", "description": "获取预置位列表", "status": "online", "parameters": [ { "name": "ChannelId", "type": "string", "required": true, "description": "视频通道唯一标识", "example": "99576636581320000310_99782261871320000002" }, { "name": "DeviceId", "type": "string", "required": true, "description": "设备唯一标识", "example": "99576636581320000310_99782261871320000002" } ], "required": [ "ChannelId", "DeviceId" ] }, { "name": "DescribeRecordDatesByChannel", "description": "本接口(DescribeRecordDatesByChannel)用于查询设备含有录像文件的日期列表。", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备唯一标识", "example": "99870353841320000007_99870353841320000007" }, { "name": "ChannelId", "type": "string", "required": true, "description": "通道唯一标识", "example": "99870353841320000007_99870353841320000007" }, { "name": "Type", "type": "integer", "required": true, "description": "1: 云端录制 2: 本地录制", "example": "1" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制量，默认200", "example": "10" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认0", "example": "0" } ], "required": [ "DeviceId", "ChannelId", "Type" ] }, { "name": "DescribeRecordDatesByLive", "description": "直播录像存储日期列表", "status": "online", "parameters": [ { "name": "LiveChannelId", "type": "string", "required": true, "description": "直播频道ID", "example": "cea6f74f29164253b43411fd888f4dc3" }, { "name": "Offset", "type": "integer", "required": true, "description": "分页值，本地录制时参数无效", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制值，本地录制时参数无效", "example": "20" } ], "required": [ "LiveChannelId", "Offset", "Limit" ] }, { "name": "DescribeRecordStream", "description": "获取回放视频流地址 请使用DescribeChannelLocalRecordURL接口 RecordId和StartTime/EndTime互斥 当存在RecordId时，StartTime和EndTime无效 当RecordId为空，StartTime和EndTime生效", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备Id", "example": "34020000001180000036_34020000001320000092" }, { "name": "ExpireTime", "type": "integer", "required": true, "description": "流失效时间，UNIX时间戳，30天内", "example": "1616914614" }, { "name": "RecordId", "type": "string", "required": false, "description": "录像文件ID", "example": "1615995219_1616001641" }, { "name": "StartTime", "type": "integer", "required": false, "description": "录像流开始时间，当录像文件ID为空时有效，UNIX时间戳", "example": "1615995219" }, { "name": "EndTime", "type": "integer", "required": false, "description": "录像流结束时间，当录像文件iD为空时有效，UNIX时间戳", "example": "1616001641" }, { "name": "ChannelId", "type": "string", "required": false, "description": "通道唯一标识（此接口升级为必填字段）", "example": "34020000001180000036_34020000001320000092" } ], "required": [ "DeviceId", "ExpireTime" ] }, { "name": "DescribeRecordingPlanById", "description": "本接口(DescribeRecordingPlanById)用于根据录制计划ID获取录制计划。", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "录制计划ID", "example": "plan-fyw1k9l5" } ], "required": [ "PlanId" ] }, { "name": "DescribeRecordingPlans", "description": "本接口(DescribeRecordingPlans)用于获取用户的全部录制计划。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeSIPServer", "description": "本接口用于获取SIP服务器相关配置，用户可以通过这些配置项，将设备通过GB28181协议注册到本服务。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeScene", "description": "场景详情", "status": "online", "parameters": [ { "name": "IntId", "type": "integer", "required": true, "description": "场景ID", "example": "200" } ], "required": [ "IntId" ] }, { "name": "DescribeScenes", "description": "获取场景列表", "status": "online", "parameters": [ { "name": "Limit", "type": "integer", "required": true, "description": "条数限制", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移", "example": "0" } ], "required": [ "Limit" ] }, { "name": "DescribeStatisticDetails", "description": "本接口(DescribeStatisticDetails)用于查询指定统计项详情，返回结果按天为单位聚合，支持的最大时间查询范围为31天。", "status": "online", "parameters": [ { "name": "StartDate", "type": "string", "required": true, "description": "开始日期，格式【YYYY-MM-DD】", "example": "2020-12-09" }, { "name": "EndDate", "type": "string", "required": true, "description": "结束日期，格式【YYYY-MM-DD】", "example": "2020-12-14" }, { "name": "StatisticField", "type": "string", "required": true, "description": "统计项。取值范围： 1.录制设备数：RecordingDevice 2.非录制设备数：NonRecordingDevice 3.观看流量总数：WatchFlux 4.已用存储容量总数：StorageUsage 5. X-P2P分享流量: P2PFluxTotal 6. X-P2P峰值带宽: P2PPeakValue 7. RTMP推流路数(直播推流): LivePushTotal", "example": "StorageUsage" } ], "required": [ "StartDate", "EndDate", "StatisticField" ] }, { "name": "DescribeStatisticSummary", "description": "本接口(DescribeStatisticSummary)用于查询用户昨日的概览数据。", "status": "online", "parameters": [ { "name": "Date", "type": "string", "required": true, "description": "指定日期。格式【YYYY-MM-DD】", "example": "2020-12-09" } ], "required": [ "Date" ] }, { "name": "DescribeSubGroups", "description": "本接口(DescribeSubGroups)用于查询分组下的子分组列表。", "status": "online", "parameters": [ { "name": "GroupId", "type": "string", "required": false, "description": "分组ID", "example": "group_root" }, { "name": "GroupName", "type": "string", "required": false, "description": "分组名称，根据名称模糊匹配子分组时为必填", "example": "groupA" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制数，默认200", "example": "10" }, { "name": "OnlyGroup", "type": "integer", "required": false, "description": "是否统计子分组下的设备数，0：统计，1：不统计", "example": "1" } ], "required": [] }, { "name": "DescribeSubscriptionStatus", "description": "查询主设备订阅状态", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备ID", "example": "99576636581320000310_99782261871320000002" } ], "required": [ "DeviceId" ] }, { "name": "DescribeVideoList", "description": "根据时间获取云端录制文件列表", "status": "online", "parameters": [ { "name": "Offset", "type": "integer", "required": true, "description": "偏移", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制", "example": "10" }, { "name": "StartTime", "type": "integer", "required": false, "description": "开始时间戳，秒级", "example": "1616660711" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结束时间戳，秒级", "example": "1616661017" }, { "name": "DeviceId", "type": "string", "required": false, "description": "设备Id", "example": "99870353841320000007_99870353841320000007" }, { "name": "StartRecordTime", "type": "integer", "required": false, "description": "开始录制范围 开始", "example": "1624204800" }, { "name": "EndRecordTime", "type": "integer", "required": false, "description": "开始录制范围 结束", "example": "1624204800" }, { "name": "StartExpireTime", "type": "integer", "required": false, "description": "过期时间范围 开始", "example": "1624204800" }, { "name": "EndExpireTime", "type": "integer", "required": false, "description": "过期时间范围 结束", "example": "1624204800" }, { "name": "StartFileSize", "type": "integer", "required": false, "description": "文件大小范围 开始 单位byte", "example": "20" }, { "name": "EndFileSize", "type": "integer", "required": false, "description": "文件大小范围 结束 单位byte", "example": "50 " }, { "name": "IsRecording", "type": "integer", "required": false, "description": "录制状态 99: 录制方已经回写状态 1: 开始录制了，等待回写 2: 已经到了时间模板的停止时间，在等待录制方回写", "example": "99" }, { "name": "ChannelId", "type": "string", "required": false, "description": "通道ID默认必传", "example": "99576636581320000310_99782261871320000002" }, { "name": "PlanId", "type": "string", "required": false, "description": "录制计划ID", "example": "planidyyysssdd" }, { "name": "SceneId", "type": "integer", "required": false, "description": "场景ID", "example": "3445" }, { "name": "WarnId", "type": "integer", "required": false, "description": "告警ID", "example": "34455" }, { "name": "RecordType", "type": "array", "required": false, "description": "录制类型 1: 联动计划录制 2: 告警录制", "example": "[1]", "item_type": "integer" } ], "required": [ "Offset", "Limit" ] }, { "name": "DescribeVideoListByChannel", "description": "本接口(DescribeVideoListByChannel)用于查询指定通道的录制文件列表", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备唯一标识", "example": "99870353841320000007_99870353841320000007" }, { "name": "ChannelId", "type": "string", "required": true, "description": "通道唯一标识", "example": "99870353841320000007_99870353841320000007" }, { "name": "Type", "type": "integer", "required": true, "description": "1: 云端录制 2: 本地录制", "example": "1" }, { "name": "Date", "type": "string", "required": false, "description": "指定某天。取值【YYYY-MM-DD】 为空时默认查询最近一天的记录", "example": "2021-01-01" }, { "name": "Limit", "type": "integer", "required": false, "description": "限制量，默认2000", "example": "100" }, { "name": "Offset", "type": "integer", "required": false, "description": "偏移量，默认0", "example": "0" } ], "required": [ "DeviceId", "ChannelId", "Type" ] }, { "name": "DescribeWarnMod", "description": "告警等级列表", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeWarnings", "description": "获取告警列表", "status": "online", "parameters": [ { "name": "OrderType", "type": "integer", "required": true, "description": "1:创建时间倒序 2：创建时间升序 3：level倒序 4：leve升序", "example": "1" }, { "name": "DeviceId", "type": "string", "required": false, "description": "可选设备id", "example": "99576636581320000310_99782261871320000002" }, { "name": "WarnLevelArray", "type": "array", "required": false, "description": "如果不传则查询所有，取值参见配置", "example": "[1]", "item_type": "integer" }, { "name": "WarnModeArray", "type": "array", "required": false, "description": "如果不传则查询所有，取值参见配置", "example": "[0]", "item_type": "integer" }, { "name": "Offset", "type": "integer", "required": false, "description": "不传认为是0", "example": "0" }, { "name": "Limit", "type": "integer", "required": false, "description": "不传认为是20", "example": "20" }, { "name": "DateBegin", "type": "string", "required": false, "description": "形似：2021-05-21 00:00:00 .取值在当前日前30天内，不传默认是当前日前30天日期", "example": "2021-05-21 00:00:00" }, { "name": "DateEnd", "type": "string", "required": false, "description": "形似：2021-05-21 23:59:59 .取值在当前日前30天内，不传默认是当前日前30天日期", "example": "2021-05-21 00:00:00" } ], "required": [ "OrderType" ] }, { "name": "DescribeXP2PData", "description": "获取X-P2P的统计数据", "status": "online", "parameters": [ { "name": "P2PAppId", "type": "string", "required": true, "description": "P2P应用ID", "example": "1624204800" }, { "name": "From", "type": "integer", "required": true, "description": "查询开始时间，时间戳秒", "example": "1624204800" }, { "name": "To", "type": "integer", "required": true, "description": "查询结束时间，时间戳秒", "example": "1624204800" }, { "name": "P2PChannelId", "type": "string", "required": false, "description": "P2P通路ID", "example": "1624204800fasffsgg" } ], "required": [ "P2PAppId", "From", "To" ] }, { "name": "GetRecordDatesByDev", "description": "本接口(GetRecordDatesByDev)用于查询设备含有录像文件的日期列表。 请使用DescribeRecordDatesByChannel接口", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备唯一标识", "example": "99870353841320000007_99870353841320000007" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制量，默认200", "example": "10" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量，默认0", "example": "0" }, { "name": "ChannelId", "type": "string", "required": false, "description": "通道唯一标识，对于NVR设备，多通道IPC设备，设备编码与通道编码不一致的IPC设备，此字段为必填", "example": "99870353841320000007_99870353841320000007" }, { "name": "Type", "type": "integer", "required": false, "description": "1: 云端录制 2: 本地录制", "example": "1" } ], "required": [ "DeviceId", "Limit", "Offset" ] }, { "name": "GetRecordPlanByDev", "description": "本接口(GetRecordPlanByDev)用于根据设备ID查询其绑定的录制计划. 这个接口没有业务逻辑用到, 已废弃，统一用DescribeDevice", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备唯一标识", "example": "devicename" } ], "required": [ "DeviceId" ] }, { "name": "GetRecordPlanById", "description": "本接口(GetRecordPlanById)用于根据录制计划ID获取录制计划。 请使用DescribeRecordingPlanById接口", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "录制计划ID", "example": "plan-fyw1k9l5" } ], "required": [ "PlanId" ] }, { "name": "GetRecordPlans", "description": "本接口(GetRecordPlans)用于获取用户的全部录制计划。 请使用DescribeRecordingPlans接口", "status": "online", "parameters": [], "required": [] }, { "name": "GetTimeTemplateById", "description": "本接口(GetTimeTemplateById)用于根据模板ID获取时间模板详情。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "时间模板ID", "example": "tgrp-fyw1k9l5" } ], "required": [ "TemplateId" ] }, { "name": "GetTimeTemplates", "description": "本接口(GetTimeTemplates)用于获取时间模板列表。", "status": "online", "parameters": [], "required": [] }, { "name": "GetVideoListByCon", "description": "本接口(GetVideoListByCon)用于查询设备的录制文件列表 请使用DescribeVideoListByChannel接口", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备唯一标识", "example": "99870353841320000007_99870353841320000007" }, { "name": "Offset", "type": "integer", "required": true, "description": "偏移量", "example": "0" }, { "name": "Limit", "type": "integer", "required": true, "description": "限制量", "example": "100" }, { "name": "ChannelId", "type": "string", "required": false, "description": "通道唯一标识，对于NVR设备，多通道IPC设备，设备编码与通道编码不一致的IPC设备，此字段为必填", "example": "99870353841320000007_99870353841320000007" }, { "name": "LatestDay", "type": "integer", "required": false, "description": "0：查询指定日期的录像；1：查询最近一天的录像；默认0", "example": "1" }, { "name": "Date", "type": "string", "required": false, "description": "指定某天。取值【YYYY-MM-DD】 为空时默认查询最近一天的记录", "example": "2021-01-01" }, { "name": "Type", "type": "integer", "required": false, "description": "1: 云端录制 2: 本地录制", "example": "1" } ], "required": [ "DeviceId", "Offset", "Limit" ] }, { "name": "ModifyBindPlanLiveChannel", "description": "直播录制计划绑定解绑直播频道", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "直播录制计划ID", "example": "lrplan-w3oovckd" }, { "name": "Type", "type": "integer", "required": true, "description": "1: 绑定 2: 解绑", "example": "1" }, { "name": "LiveChannelIds", "type": "array", "required": true, "description": "直播频道ID列表", "example": "[\"20a15bbc31fd45b1a5625c08e5e23a7f\"]", "item_type": "string" } ], "required": [ "PlanId", "Type", "LiveChannelIds" ] }, { "name": "ModifyBindRecordingPlan", "description": "本接口(ModifyBindRecordingPlan)用于更新录制计划绑定的通道", "status": "online", "parameters": [ { "name": "Type", "type": "integer", "required": true, "description": "操作类型： 1-绑定设备 ；2-解绑设备", "example": "1" }, { "name": "PlanId", "type": "string", "required": true, "description": "录制计划ID", "example": "plan-zn3ro30w" }, { "name": "Channels", "type": "array", "required": false, "description": "录制通道列表", "example": "无", "item_type": "object", "children": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备唯一标识", "example": "34020000001180000036_34020000001320000092" }, { "name": "ChannelId", "type": "string", "required": true, "description": "通道唯一标识", "example": "34020000001180000036_34020000001320000092" } ] } ], "required": [ "Type", "PlanId" ] }, { "name": "ModifyBindSceneChannels", "description": "场景绑定解绑通道接口", "status": "online", "parameters": [ { "name": "SceneId", "type": "integer", "required": true, "description": "场景ID", "example": "100" }, { "name": "Type", "type": "integer", "required": true, "description": "1: 绑定 2: 解绑", "example": "1" }, { "name": "Channels", "type": "array", "required": true, "description": "通道列表", "example": "无", "item_type": "object", "children": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备唯一标识", "example": "34020000001180000036_34020000001320000092" }, { "name": "ChannelId", "type": "string", "required": true, "description": "通道唯一标识", "example": "34020000001180000036_34020000001320000092" } ] } ], "required": [ "SceneId", "Type", "Channels" ] }, { "name": "ModifyBindSceneDevice", "description": "场景绑定/解绑通道接口", "status": "online", "parameters": [ { "name": "SceneId", "type": "integer", "required": true, "description": "场景ID", "example": "100" }, { "name": "Type", "type": "integer", "required": true, "description": "1: 绑定 2: 解绑", "example": "1" }, { "name": "Devices", "type": "array", "required": true, "description": "设备列表", "example": "无", "item_type": "object", "children": [ { "name": "DeviceId", "type": "string", "required": false, "description": "设备唯一标识", "example": "34020000001180000036_34020000001320000092" }, { "name": "ChannelId", "type": "string", "required": false, "description": "通道唯一标识", "example": "34020000001180000036_34020000001320000092" } ] } ], "required": [ "SceneId", "Type", "Devices" ] }, { "name": "ModifyDeviceData", "description": "本接口(ModifyDeviceData)用于编辑设备信息。", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备唯一标识", "example": "99424891421320000101_ 99424891421320000101" }, { "name": "NickName", "type": "string", "required": true, "description": "设备名称", "example": "开发测试设备001" } ], "required": [ "DeviceId", "NickName" ] }, { "name": "ModifyLiveChannel", "description": "编辑直播接口", "status": "online", "parameters": [ { "name": "LiveChannelId", "type": "string", "required": true, "description": "直播频道ID", "example": "e4a6427192a34cca8ea1d74815b7f458" }, { "name": "LiveChannelName", "type": "string", "required": true, "description": "直播频道名", "example": "直播004" } ], "required": [ "LiveChannelId", "LiveChannelName" ] }, { "name": "ModifyLiveRecordPlan", "description": "编辑直播录制计划", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "录制计划ID", "example": "plan-001" }, { "name": "PlanName", "type": "string", "required": true, "description": "录制计划名", "example": "直播录制001" }, { "name": "TemplateId", "type": "string", "required": false, "description": "时间模板ID，固定直播时为必填", "example": "template-001" } ], "required": [ "PlanId", "PlanName" ] }, { "name": "ModifyLiveVideo", "description": "直播录像编辑", "status": "online", "parameters": [ { "name": "IntIDs", "type": "array", "required": true, "description": "视频ID 列表, 大小限制(100)", "example": "[3352901]", "item_type": "integer" }, { "name": "ExpireTime", "type": "integer", "required": true, "description": "过期时间 秒 (-1: 为永不过期)", "example": "1633599083" } ], "required": [ "IntIDs", "ExpireTime" ] }, { "name": "ModifyMessageForward", "description": "修改消息转发配置", "status": "online", "parameters": [ { "name": "IntId", "type": "integer", "required": true, "description": "配置ID", "example": "1624" }, { "name": "MessageType", "type": "string", "required": true, "description": "json数组， 转发类型 1: 告警 2:GPS", "example": "[1,2]" } ], "required": [ "IntId", "MessageType" ] }, { "name": "ModifyPreset", "description": "编辑预置位信息", "status": "online", "parameters": [ { "name": "ChannelId", "type": "string", "required": true, "description": "通道ID", "example": "99576636581320000310_99782261871320000002" }, { "name": "PresetId", "type": "integer", "required": true, "description": "预置位编码 范围1-8", "example": "1" }, { "name": "PresetName", "type": "string", "required": true, "description": "预制位名称", "example": "大门" }, { "name": "DeviceId", "type": "string", "required": true, "description": "设备Id", "example": "99576636581320000310_99782261871320000002" } ], "required": [ "ChannelId", "PresetId", "PresetName", "DeviceId" ] }, { "name": "ModifyRecordingPlan", "description": "本接口(ModifyRecordingPlan)用于更新录制计划。", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "录制计划ID", "example": "plan-all" }, { "name": "Name", "type": "string", "required": false, "description": "计划名称", "example": "all" }, { "name": "TimeTemplateId", "type": "string", "required": false, "description": "时间模板ID", "example": "tgrp-all" } ], "required": [ "PlanId" ] }, { "name": "ModifyScene", "description": "修改场景", "status": "online", "parameters": [ { "name": "IntId", "type": "integer", "required": true, "description": "场景ID", "example": "200" }, { "name": "SceneName", "type": "string", "required": false, "description": "场景名称", "example": "场景录制" }, { "name": "SceneTrigger", "type": "string", "required": false, "description": "触发条件", "example": "{\"2\":{\"Name\":\"设备报警\",\"WarnType\":{\"1\":\"视频丢失报警\",\"2\":\"设备防拆报警\",\"3\":\"存" }, { "name": "RecordDuration", "type": "integer", "required": false, "description": "录制时长(秒)", "example": "3600" } ], "required": [ "IntId" ] }, { "name": "ModifySubscriptionStatus", "description": "编辑设备订阅状态", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备ID", "example": "99576636581320000310_99782261871320000002" }, { "name": "Status", "type": "integer", "required": true, "description": "订阅状态 1：关闭订阅 2：开启订阅", "example": "1" }, { "name": "SubscriptionItem", "type": "string", "required": false, "description": "订阅类型 Alarm:告警订阅 Catalog:目录订阅 MobilePosition:移动位置订阅", "example": "Alarm" } ], "required": [ "DeviceId", "Status" ] }, { "name": "ModifyVideoInfo", "description": "修改录像存储列表", "status": "online", "parameters": [ { "name": "InitIDs", "type": "array", "required": true, "description": "视频ID列表长度限制100内", "example": "[0]", "item_type": "integer" }, { "name": "ExpireTime", "type": "integer", "required": true, "description": "过期时间 时间戳 -1: 永不过期 0: 无效值", "example": "1624204800" } ], "required": [ "InitIDs", "ExpireTime" ] }, { "name": "ResetWarning", "description": "重置设备告警", "status": "online", "parameters": [ { "name": "Id", "type": "integer", "required": false, "description": "告警ID", "example": "2" }, { "name": "Index", "type": "string", "required": false, "description": "Es中告警ID", "example": "1624204800" } ], "required": [] }, { "name": "UpdateDeviceGroup", "description": "本接口(UpdateDeviceGroup)用于修改分组信息。", "status": "online", "parameters": [ { "name": "GroupName", "type": "string", "required": true, "description": "分组名称", "example": "testgroup" }, { "name": "GroupId", "type": "string", "required": true, "description": "分组ID", "example": "aaaa" }, { "name": "GroupDescribe", "type": "string", "required": false, "description": "分组描述", "example": "this is test" }, { "name": "NewParentId", "type": "string", "required": false, "description": "新父分组ID，用于修改分组路径", "example": "newgroupid" } ], "required": [ "GroupName", "GroupId" ] }, { "name": "UpdateDevicePassWord", "description": "本接口(UpdateDevicePassWord)用于修改设备密码。", "status": "online", "parameters": [ { "name": "PassWord", "type": "string", "required": true, "description": "设备密码", "example": "password" }, { "name": "DeviceId", "type": "string", "required": true, "description": "设备唯一标识", "example": "99870353841320000007_99870353841320000007" } ], "required": [ "PassWord", "DeviceId" ] }, { "name": "UpdateRecordPlan", "description": "本接口(UpdateRecordPlan)用于更新录制计划。 请使用 ModifyRecordingPlan接口和ModifyBindRecordingPlan接口", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "录制计划ID", "example": "plan-allday" }, { "name": "Name", "type": "string", "required": false, "description": "计划名称", "example": "allday" }, { "name": "TimeTemplateId", "type": "string", "required": false, "description": "时间模板ID", "example": "tgrp-allday" }, { "name": "EventId", "type": "integer", "required": false, "description": "触发录制的事件 1：全部", "example": "1" }, { "name": "Devices", "type": "array", "required": false, "description": "录制设备列表", "example": "无", "item_type": "object", "children": [ { "name": "DeviceId", "type": "string", "required": false, "description": "设备唯一标识", "example": "34020000001180000036_34020000001320000092" }, { "name": "ChannelId", "type": "string", "required": false, "description": "通道唯一标识", "example": "34020000001180000036_34020000001320000092" } ] }, { "name": "IsModifyDevices", "type": "integer", "required": false, "description": "是否更新绑定此录制计划的设备列表 0 - 不更新 1 - 更新，如果Devices参数为空则清空设备列表，Devices不为空则全量更新设备列表", "example": "1" } ], "required": [ "PlanId" ] }, { "name": "UpdateTimeTemplate", "description": "本接口(UpdateTimeTemplate)用于更新时间模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "时间模板ID", "example": "tgrp-fmwq1f1a" }, { "name": "Name", "type": "string", "required": false, "description": "时间模板名称", "example": "fmwq1f1a" }, { "name": "IsAllWeek", "type": "integer", "required": false, "description": "是否全时录制，即7*24小时录制。 0：非全时录制；1：全时录制。默认1", "example": "0" }, { "name": "TimeTemplateSpecs", "type": "array", "required": false, "description": "录制时间片段", "example": "allday", "item_type": "object", "children": [ { "name": "DayofWeek", "type": "integer", "required": true, "description": "一周中的周几", "example": "2" }, { "name": "BeginTime", "type": "string", "required": true, "description": "时间片段的开始时分。格式【HH:MM】", "example": "12:30" }, { "name": "EndTime", "type": "string", "required": true, "description": "时间片段的结束时分。格式【HH:MM】", "example": "14:30" } ] } ], "required": [ "TemplateId" ] } ] }