{ "name": "iss", "display_name": "智能视图计算平台", "description": "介绍如何使用API进行监控设备的增删改查、如何进行实况预览或录像回放功能。", "domain": "other", "api_version": "2023-05-17", "endpoint": "iss.tencentcloudapi.com", "actions": [ { "name": "AddAITask", "description": "添加AI任务", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "AI 任务名称。仅支持中文、英文、数字、_、-，长度不超过32个字符", "example": "测试任务" }, { "name": "ChannelList", "type": "array", "required": true, "description": "通道 ID 列表。不能添加存在于其他 AI 任务的通道，限制1000个通道。", "example": "f8656fa3-e7fa-4cad-a4cc-****", "item_type": "string" }, { "name": "Templates", "type": "array", "required": true, "description": "AI 配置列表", "example": "无", "item_type": "object", "children": [ { "name": "Tag", "type": "string", "required": true, "description": "AI 类别。可选值 AI(AI 分析)和 Snapshot(截图)，Templates 列表中只能出现一种类型。", "example": "AI" }, { "name": "AIConfig", "type": "object", "required": false, "description": "AI 分析配置。和\"SnapshotConfig\"二选一。", "example": "无", "children": [ { "name": "DetectType", "type": "string", "required": true, "description": "AI 分析类型。可选值为 Facemask(口罩识别)、Chefhat(厨师帽识别)、Smoking(抽烟检测)、Chefcloth(厨师服识别)、PhoneCall(接打电话识别)、Pet(宠物识别)、Body(人体识别)和Car(车辆车牌识别)等", "example": "Pet" }, { "name": "TimeInterval", "type": "integer", "required": true, "description": "截图频率。可选值1～20秒", "example": "10" }, { "name": "OperTimeSlot", "type": "array", "required": true, "description": "模板生效的时间段。最多包含5组时间段", "example": "无", "item_type": "object", "children": [ { "name": "Start", "type": "string", "required": true, "description": "开始时间。格式为\"hh:mm:ss\"，且 Start 必须小于 End", "example": "10:00:00" }, { "name": "End", "type": "string", "required": true, "description": "结束时间。格式为\"hh:mm:ss\"，且 Start 必须小于 End", "example": "20:00:00" } ] } ] }, { "name": "SnapshotConfig", "type": "object", "required": false, "description": "截图配置。和\"AIConfig\"二选一。", "example": "无", "children": [ { "name": "TimeInterval", "type": "integer", "required": true, "description": "截图频率。可选值1～20秒", "example": "10" }, { "name": "OperTimeSlot", "type": "array", "required": true, "description": "模板生效的时间段。最多包含5组时间段", "example": "无", "item_type": "object", "children": [ { "name": "Start", "type": "string", "required": true, "description": "开始时间。格式为\"hh:mm:ss\"，且 Start 必须小于 End", "example": "10:00:00" }, { "name": "End", "type": "string", "required": true, "description": "结束时间。格式为\"hh:mm:ss\"，且 Start 必须小于 End", "example": "20:00:00" } ] } ] } ] }, { "name": "Desc", "type": "string", "required": false, "description": "AI 任务描述。仅支持中文、英文、数字、_、-，长度不超过128个字符", "example": "宠物识别" }, { "name": "CallbackUrl", "type": "string", "required": false, "description": "AI 结果回调地址", "example": "http(s)://xxxx" }, { "name": "IsStartTheTask", "type": "boolean", "required": false, "description": "是否立即开启 AI 任务。\"true\"代表立即开启 AI 任务，\"false\"代表暂不开启 AI 任务，默认为 false。", "example": "true" } ], "required": [ "Name", "ChannelList", "Templates" ] }, { "name": "AddOrganization", "description": "用于新增组织。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "组织名称（仅支持中文、英文、数字、空格、中英文括号、_、-, 长度不超过64位，且组织名称不能重复）", "example": "组织123" }, { "name": "ParentId", "type": "string", "required": true, "description": "组织父节点 ID（从查询组织接口DescribeOrganization中获取，填0代表根组织）", "example": "237" } ], "required": [ "Name", "ParentId" ] }, { "name": "AddRecordBackupPlan", "description": "用于新增录像上云计划 （当前仅适用于通过GB28181协议和网关接入的设备/视频通道）", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "录制模板ID（录像计划关联的模板ID，从查询录像上云模板列表接口ListRecordBackupTemplates中获取）", "example": "584fd9d0-569c-4153-aff7-************" }, { "name": "PlanName", "type": "string", "required": true, "description": "录像计划名称（仅支持中文、英文、数字、_、-，长度不超过32个字符，计划名称全局唯一，不能为空，不能重复）", "example": "录像上云计划1" }, { "name": "Describe", "type": "string", "required": true, "description": "录像计划描述（仅支持中文、英文、数字、_、-，长度不超过128个字符）", "example": "这是计划的一部分" }, { "name": "LifeCycle", "type": "object", "required": true, "description": "生命周期（录像文件生命周期设置，管理文件冷、热存储的时间）", "example": "无", "children": [ { "name": "Transition", "type": "integer", "required": true, "description": "云文件热存储时长，单位天，最小1天，最大3650天", "example": "7" }, { "name": "Expiration", "type": "integer", "required": true, "description": "云文件冷存储时长， 单位天，0表示不设置，设置时最小60天，Expiration字段加Transition字段不超过3650天", "example": "90" } ] }, { "name": "Channels", "type": "array", "required": false, "description": "通道及通道所属设备（添加录像的设备的通道信息，一次添加通道总数不超过5000个，包括组织目录下的通道数量）", "example": "无", "item_type": "object", "children": [ { "name": "DeviceId", "type": "string", "required": true, "description": "通道所属的设备ID", "example": "f8656fa3-e7fa-4cad-a4cc-************" }, { "name": "ChannelId", "type": "string", "required": true, "description": "设备通道ID，一个设备通道只允许被一个上云计划添加", "example": "f7ca505f-be1b-4ce8-849b-************" } ] }, { "name": "OrganizationId", "type": "array", "required": false, "description": "添加组织目录下所有设备通道（Json数组，可以为空，通道总数量不超过5000个（包括Channel字段的数量））", "example": " 237", "item_type": "string" } ], "required": [ "TemplateId", "PlanName", "Describe", "LifeCycle" ] }, { "name": "AddRecordBackupTemplate", "description": "用于新增录像上云模板。 \u003e 该功能本质是拉取设备本地录像数据上云（即存在 IPC 摄像头存储卡或 NVR 硬盘中的录像），操作时需先设定录像时间段（即想要上云的设备本地录像），再设定上云时间段和上云倍速，平台将于上云时间段倍速拉取设备对应前一天的录像时间段数据。 \u003e 设定需至少满足（上云时间段=前一天的录像时间段/上云倍速），建议上云时间段可多设定10%左右\ufffd\ufffd...", "status": "online", "parameters": [ { "name": "TemplateName", "type": "string", "required": true, "description": "模板名称（仅支持中文、英文、数字、_、-，长度不超过32个字符，模板名称全局唯一，不能为空，不能重复）", "example": "模板1" }, { "name": "TimeSections", "type": "array", "required": true, "description": "上云时间段（按周进行设置，支持一天设置多个时间段，每个时间段不小于10分钟）", "example": "无", "item_type": "object", "children": [ { "name": "DayOfWeek", "type": "integer", "required": true, "description": "周日期，取值范围1～7（对应周一～周日", "example": "1" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，格式：HH:MM:SS，范围：[00:00:00～23:59:59]", "example": "08:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，格式：HH:MM:SS，范围：[00:00:00～23:59:59]", "example": "12:00:00" } ] }, { "name": "DevTimeSections", "type": "array", "required": true, "description": "录像时间段（按周进行设置，支持一天设置多个时间段，每个时间段不小于10分钟）", "example": "无", "item_type": "object", "children": [ { "name": "DayOfWeek", "type": "integer", "required": true, "description": "周日期，取值范围1～7（对应周一～周日", "example": "1" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，格式：HH:MM:SS，范围：[00:00:00～23:59:59]", "example": "08:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，格式：HH:MM:SS，范围：[00:00:00～23:59:59]", "example": "12:00:00" } ] }, { "name": "Scale", "type": "integer", "required": true, "description": "上云倍速（支持1，2，4倍速）", "example": "2" } ], "required": [ "TemplateName", "TimeSections", "DevTimeSections", "Scale" ] }, { "name": "AddRecordPlan", "description": "用于新增实时上云计划", "status": "online", "parameters": [ { "name": "PlanName", "type": "string", "required": true, "description": "实时上云计划名称，仅支持中文、英文、数字、_、-，长度不超过32个字符，计划名称全局唯一，不能为空，不能重复", "example": "工作日计划" }, { "name": "TemplateId", "type": "string", "required": true, "description": "实时上云模板ID", "example": "全天模板" }, { "name": "LifeCycle", "type": "object", "required": true, "description": "生命周期", "example": "无", "children": [ { "name": "Transition", "type": "integer", "required": true, "description": "云文件热存储时长，单位天，最小1天，最大3650天", "example": "7" }, { "name": "Expiration", "type": "integer", "required": true, "description": "云文件冷存储时长， 单位天，0表示不设置，设置时最小60天，Expiration字段加Transition字段不超过3650天", "example": "90" } ] }, { "name": "Describe", "type": "string", "required": false, "description": "上云计划描述，仅支持中文、英文、数字、_、-，长度不超过128个字符", "example": "周一到周五" }, { "name": "StreamType", "type": "string", "required": false, "description": "码流类型，default:不指定码流类型，以设备默认推送类型为主， main:主码流，sub:子码流，其他根据设备能力集自定义，不填按默认类型处理，长度不能超过32个字节", "example": "main" }, { "name": "Channels", "type": "array", "required": false, "description": "添加录像的设备的通道信息，一次添加通道总数不超过5000个，包括组织目录下的通道数量", "example": "无", "item_type": "object", "children": [ { "name": "DeviceId", "type": "string", "required": true, "description": "通道所属的设备ID", "example": "f8656fa3-e7fa-4cad-a4cc-************" }, { "name": "ChannelId", "type": "string", "required": true, "description": "设备通道ID，一个设备通道只允许被一个上云计划添加", "example": "f7ca505f-be1b-4ce8-849b-************" } ] }, { "name": "OrganizationId", "type": "array", "required": false, "description": "添加组织目录下所有设备通道，Json数组，可以为空，通道总数量不超过5000个（包括Channel字段的数量）", "example": "10", "item_type": "string" }, { "name": "RepairMode", "type": "integer", "required": false, "description": "录像补录模式（0:不启用，1:启用），无该字段，默认不启用", "example": "0" } ], "required": [ "PlanName", "TemplateId", "LifeCycle" ] }, { "name": "AddRecordRetrieveTask", "description": "用于新建取回任务", "status": "online", "parameters": [ { "name": "TaskName", "type": "string", "required": true, "description": "任务名称，仅支持中文、英文、数字、_、-，长度不超过32个字符，名称全局唯一，不能为空，不能重复", "example": "task1" }, { "name": "StartTime", "type": "integer", "required": true, "description": "取回录像的开始时间，UTC秒数，例如：1662114146，开始和结束时间段最长为一天，且不能跨天", "example": "1687688595" }, { "name": "EndTime", "type": "integer", "required": true, "description": "取回录像的结束时间，UTC秒数，例如：1662114146，开始和结束时间段最长为一天，且不能跨天", "example": "1687692195" }, { "name": "Mode", "type": "integer", "required": true, "description": "取回模式， 1:极速模式，其他暂不支持", "example": "1" }, { "name": "Expiration", "type": "integer", "required": true, "description": "取回录像副本有效期，最小为1天，最大为365天", "example": "3" }, { "name": "Channels", "type": "array", "required": true, "description": "设备通道，一个任务最多32个设备通道", "example": "无", "item_type": "object", "children": [ { "name": "DeviceId", "type": "string", "required": true, "description": "通道所属的设备ID", "example": "f8656fa3-e7fa-4cad-a4cc-************" }, { "name": "ChannelId", "type": "string", "required": true, "description": "设备通道ID，一个设备通道只允许被一个上云计划添加", "example": "f7ca505f-be1b-4ce8-849b-************" } ] }, { "name": "Describe", "type": "string", "required": false, "description": "取回任务描述", "example": "task" } ], "required": [ "TaskName", "StartTime", "EndTime", "Mode", "Expiration", "Channels" ] }, { "name": "AddRecordTemplate", "description": "用于新增实时上云模板", "status": "online", "parameters": [ { "name": "TemplateName", "type": "string", "required": true, "description": "模板名称， 仅支持中文、英文、数字、_、-，长度不超过32个字符，模板名称全局唯一，不能为空，不能重复", "example": "全天模板" }, { "name": "TimeSections", "type": "array", "required": true, "description": "上云时间段，按周进行设置，支持一天设置多个时间段，每个时间段不小于10分钟", "example": "无", "item_type": "object", "children": [ { "name": "DayOfWeek", "type": "integer", "required": true, "description": "周日期，取值范围1～7（对应周一～周日", "example": "1" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，格式：HH:MM:SS，范围：[00:00:00～23:59:59]", "example": "08:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，格式：HH:MM:SS，范围：[00:00:00～23:59:59]", "example": "12:00:00" } ] } ], "required": [ "TemplateName", "TimeSections" ] }, { "name": "AddStreamAuth", "description": "用于设置推拉流鉴权配置。", "status": "online", "parameters": [ { "name": "Id", "type": "string", "required": true, "description": "鉴权配置ID（uuid）", "example": "e8317c5b-7087-4126-bca0-************" }, { "name": "PullState", "type": "integer", "required": true, "description": "是否开播放鉴权（1:开启,0:关闭）", "example": "1" }, { "name": "PullSecret", "type": "string", "required": true, "description": "播放密钥（仅支持字母数字，长度0-10位）", "example": "aaaaaaaaaa" }, { "name": "PullExpired", "type": "integer", "required": true, "description": "播放过期时间（单位：分钟）", "example": "10" }, { "name": "PushState", "type": "integer", "required": true, "description": "是否开启推流鉴权（1:开启,0:关闭）", "example": "1" }, { "name": "PushSecret", "type": "string", "required": true, "description": "推流密钥（仅支持字母数字，长度0-10位）", "example": "bbbbbbbbbb" }, { "name": "PushExpired", "type": "integer", "required": true, "description": "推流过期时间（单位：分钟）", "example": "10" } ], "required": [ "Id", "PullState", "PullSecret", "PullExpired", "PushState", "PushSecret", "PushExpired" ] }, { "name": "AddUserDevice", "description": "用于新增单个设备。添加设备之后，可根据返回结果到设备上进行配置，配置后等待设备注册/推流。", "status": "online", "parameters": [ { "name": "Name", "type": "string", "required": true, "description": "设备名称，仅支持中文、英文、数字、空格、中英文括号、_、-, 长度不超过128位；（设备名称无需全局唯一，可以重复）", "example": "设备1" }, { "name": "AccessProtocol", "type": "integer", "required": true, "description": "设备接入协议（1:RTMP,2:GB,3:GW,6:ISUP）", "example": "2" }, { "name": "Type", "type": "integer", "required": true, "description": "设备类型，1:IPC,2:NVR；（若设备接入协议选择RTMP,IVCP，则设备类型只能选择IPC）", "example": "1" }, { "name": "OrganizationId", "type": "string", "required": true, "description": "设备所属组织ID，从查询组织接口DescribeOrganization中获取", "example": "237" }, { "name": "ClusterId", "type": "string", "required": true, "description": "设备接入服务节点ID（从查询设备可用服务节点接口DescribeDeviceRegion中获取的Value字段）", "example": "b2181417-03ce-4ea3-ae39-************" }, { "name": "TransportProtocol", "type": "integer", "required": false, "description": "设备流传输协议，1:UDP,2:TCP；(国标设备有效，不填写则默认UDP协议)", "example": "1" }, { "name": "Password", "type": "string", "required": false, "description": "设备密码（国标，网关设备必填，长度为1-64个字符）", "example": "37********10" }, { "name": "Description", "type": "string", "required": false, "description": "设备描述，长度不超过128个字符", "example": "这是设备1" }, { "name": "GatewayId", "type": "string", "required": false, "description": "设备接入网关ID，从查询网关列表接口中ListGateways获取（仅网关接入需要）", "example": "f6d2540d-1d13-4873-b10e-************" }, { "name": "ProtocolType", "type": "integer", "required": false, "description": "网关接入协议类型（从查询网关接入协议接口DescribeGatewayProtocol中获取）1.海康SDK，2.大华SDK，3.宇视SDK，4.Onvif（仅网关接入需要）", "example": "1" }, { "name": "Ip", "type": "string", "required": false, "description": "设备接入IP（仅网关接入需要）", "example": "192.168.*.1" }, { "name": "Port", "type": "integer", "required": false, "description": "设备端口（仅网关接入需要）", "example": "9000" }, { "name": "Username", "type": "string", "required": false, "description": "设备用户名（仅网关接入需要）", "example": "admin" }, { "name": "SNCode", "type": "string", "required": false, "description": "设备 SN，仅IVCP 协议设备需要", "example": "110123111600****" }, { "name": "AppName", "type": "string", "required": false, "description": "RTMP推流地址自定义AppName（仅RTMP需要，支持英文、数字、_、-、.、长度不超过64位）", "example": "live" }, { "name": "StreamName", "type": "string", "required": false, "description": "RTMP推流地址自定义StreamName（仅RTMP需要，支持英文、数字、_、-、.、长度不超过64位）", "example": "00cuDZBadN" } ], "required": [ "Name", "AccessProtocol", "Type", "OrganizationId", "ClusterId" ] }, { "name": "BatchDeleteVideoDownloadTask", "description": "用于批量删除本地录像下载失败的任务", "status": "online", "parameters": [ { "name": "DownloadTaskIds", "type": "array", "required": false, "description": "本地录像下载任务 ID 列表", "example": "[\"uuid\",\"uuid\"]", "item_type": "string" } ], "required": [] }, { "name": "BatchOperateDevice", "description": "用于批量操作（启用，禁用，删除）设备", "status": "online", "parameters": [ { "name": "DeviceIds", "type": "array", "required": true, "description": "设备 ID 数组（从获取设备列表接口ListDevices中获取）", "example": "['f8656fa3-e7fa-4cad-a4cc-************']", "item_type": "string" }, { "name": "Cmd", "type": "string", "required": true, "description": "操作命令（enable：启用；disable：禁用；delete：删除；sync：同步设备通道；upgrade：固件升级；reset：恢复出厂设置；reboot：重启）", "example": "enable" } ], "required": [ "DeviceIds", "Cmd" ] }, { "name": "CallISAPI", "description": "本接口可基于海康ISUP 5.0协议实现透传ISAPI的请求数据，调用接口前需确保设备采用ISUP协议成功注册至本平台", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备ID", "example": "abdsaie-dasd-dasd-************" }, { "name": "Url", "type": "string", "required": true, "description": "url 资源", "example": "GET /ISAPI/ContentMgmt/InputProxy/channels/status" }, { "name": "InputData", "type": "string", "required": false, "description": "输入参数", "example": "xml" } ], "required": [ "DeviceId", "Url" ] }, { "name": "ControlDevicePTZ", "description": "用于设备通道云台控制，包括转动、变倍、变焦、光圈等。", "status": "online", "parameters": [ { "name": "ChannelId", "type": "string", "required": true, "description": "通道 ID（从通道查询接口DescribeDeviceChannel中获取）", "example": "f7ca505f-be1b-4ce8-849b-************" }, { "name": "Type", "type": "string", "required": true, "description": "命令类型（上:up,下:down,左:left,右:right 上左:leftup,上右:rightup,下左:leftdown,下右:rightdown 放大:zoomin,缩小:zoomout 聚焦远:focusfar,聚焦近:focusnear 光圈放大:irisin,光圈缩小:irisout）", "example": "up" }, { "name": "Speed", "type": "integer", "required": true, "description": "命令描述（速度值范围1-8）", "example": "2" } ], "required": [ "ChannelId", "Type", "Speed" ] }, { "name": "ControlDevicePreset", "description": "用于操作设备预置位，包括设置、删除、调用。", "status": "online", "parameters": [ { "name": "ChannelId", "type": "string", "required": true, "description": "通道 ID（从通道查询接口DescribeDeviceChannel中获取）", "example": "f7ca505f-be1b-4ce8-849b-************" }, { "name": "Cmd", "type": "string", "required": true, "description": "命令（goto:预置位调用； set:预置位设置； del:预置位删除）", "example": "goto" }, { "name": "Index", "type": "integer", "required": true, "description": "预置位索引（只支持1-10的索引位置，超出报错）", "example": "1" } ], "required": [ "ChannelId", "Cmd", "Index" ] }, { "name": "ControlDeviceSnapshot", "description": "控制设备抓拍--单次，当前仅支持国标设备", "status": "online", "parameters": [ { "name": "ChannelId", "type": "string", "required": true, "description": "通道ID", "example": "a046406b-a736-496e-a310-***********" }, { "name": "SnapNum", "type": "integer", "required": true, "description": "连拍张数，可选值范围1～10", "example": "3" }, { "name": "Interval", "type": "integer", "required": true, "description": "抓拍间隔时间，可选值范围1～1800", "example": "10" }, { "name": "Expire", "type": "integer", "required": false, "description": "图片存储时间，默认 7 天，仅支持（7, 15, 30, 60, 90, 180, 365）天", "example": "7" } ], "required": [ "ChannelId", "SnapNum", "Interval" ] }, { "name": "ControlDeviceStream", "description": "用于获取设备的实时开流地址。", "status": "online", "parameters": [ { "name": "ChannelId", "type": "string", "required": true, "description": "通道 ID（从通道查询接口DescribeDeviceChannel中获取）", "example": "f7ca505f-be1b-4ce8-849b-************" }, { "name": "StreamType", "type": "string", "required": false, "description": "流类型（1:主码流； 2:子码流（不可以和 Resolution 同时下发））", "example": "1" }, { "name": "Resolution", "type": "string", "required": false, "description": "分辨率（1:QCIF； 2:CIF； 3:4CIF； 4:D1； 5:720P； 6:1080P/I； 自定义的19201080等等（需设备支持）（不可以和 StreamType 同时下发））", "example": "19201080" }, { "name": "IsInternal", "type": "boolean", "required": false, "description": "是否内网", "example": "true" } ], "required": [ "ChannelId" ] }, { "name": "ControlRecord", "description": "用于录像回放过程中的倍速、跳转、播放/暂停/停止等控制。", "status": "online", "parameters": [ { "name": "ChannelId", "type": "string", "required": true, "description": "通道ID（录像播放地址格式 https://${domain}/live/${ChannelId}@${Session}）", "example": "f7ca505f-be1b-4ce8-849b-************" }, { "name": "Session", "type": "string", "required": true, "description": "录像会话 ID （ 录像播放地址格式 https://${domain}/live/${ChannelId}@${Session}）", "example": "06cc45c5-5aed-4ef6-956c-************" }, { "name": "ControlAction", "type": "string", "required": true, "description": "录像操作类型 （play:播放；pause:暂停 ；stop:关闭）", "example": "play" }, { "name": "Position", "type": "integer", "required": false, "description": "跳转进度 （ 参数应大于等于0，跳转到录像开始时间的相对时间（单位秒），例如0就是跳转到录像开始的时间,不可以和 Scale 参数同时出现）", "example": "0" }, { "name": "Scale", "type": "float", "required": false, "description": "速度 （ 范围（0.25,0.5,1,2,4,8），不可以和 Pos 参数同时出现）", "example": "2" } ], "required": [ "ChannelId", "Session", "ControlAction" ] }, { "name": "ControlRecordTimeline", "description": "用于查询设备本地录像时间轴信息，为NVR/IPC本地存储的录像。", "status": "online", "parameters": [ { "name": "ChannelId", "type": "string", "required": true, "description": "通道 ID（从通道查询接口DescribeDeviceChannel中获取）", "example": "f7ca505f-be1b-4ce8-849b-************" }, { "name": "Start", "type": "integer", "required": true, "description": "起始时间", "example": "1702554113" }, { "name": "End", "type": "integer", "required": true, "description": "结束时间", "example": "1702555113" } ], "required": [ "ChannelId", "Start", "End" ] }, { "name": "CreateVideoDownloadTask", "description": "创建本地录像下载任务", "status": "online", "parameters": [ { "name": "ChannelId", "type": "string", "required": true, "description": "通道ID", "example": "uuid" }, { "name": "BeginTime", "type": "integer", "required": true, "description": "开始时间", "example": "1728124673" }, { "name": "EndTime", "type": "integer", "required": true, "description": "结束时间", "example": "1728124773" }, { "name": "Scale", "type": "integer", "required": false, "description": "默认1倍速，支持（1,2,4,8）倍速", "example": "1" }, { "name": "Expire", "type": "integer", "required": false, "description": "转码后的mp4文件过期时间（支持7,15,30,60,90,180,365）", "example": "7" }, { "name": "FileType", "type": "integer", "required": false, "description": "下载文件格式，当前仅支持（1：mp4）", "example": "1" }, { "name": "CompletionPolicy", "type": "integer", "required": false, "description": "完成策略（0：拉流失败但是录像不完整则认为任务失败，不生成 MP4；1：拉流失败但是录像不完整则认为任务成功，生成 mp4）", "example": "1" } ], "required": [ "ChannelId", "BeginTime", "EndTime" ] }, { "name": "DeleteAITask", "description": "删除AI任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "AI任务ID", "example": "at0251f55fd5fe4adba237**********" } ], "required": [ "TaskId" ] }, { "name": "DeleteDomain", "description": "用于删除域名。", "status": "online", "parameters": [ { "name": "Id", "type": "string", "required": true, "description": "域名 ID", "example": "2d203ed6-c0e9-4ef0-817b-************" } ], "required": [ "Id" ] }, { "name": "DeleteGateway", "description": "用于删除网关。", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关索引ID（从获取网关列表接口ListGateways中获取）", "example": "f6d2540d-1d13-4873-b10e-************" } ], "required": [ "GatewayId" ] }, { "name": "DeleteOrganization", "description": "用于删除组织。", "status": "online", "parameters": [ { "name": "OrganizationId", "type": "string", "required": true, "description": "组织ID（从查询组织接口DescribeOrganization中获取）", "example": "237" } ], "required": [ "OrganizationId" ] }, { "name": "DeleteRecordBackupPlan", "description": "用于删除录像上云模板。", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "录像上云计划ID（从查询录像上云计划列表接口ListRecordBackupPlans中获取）", "example": "f06d500f-64fb-42c0-b804-************" } ], "required": [ "PlanId" ] }, { "name": "DeleteRecordBackupTemplate", "description": "用于删除录像上云模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "模板ID（从查询录像上云模板列表接口ListRecordBackupTemplates中获取）", "example": "584fd9d0-569c-4153-aff7-************" } ], "required": [ "TemplateId" ] }, { "name": "DeleteRecordPlan", "description": "用于删除实时上云计划", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "上云计划ID", "example": "88ac5ea6c1f**********24671d0f94f" } ], "required": [ "PlanId" ] }, { "name": "DeleteRecordRetrieveTask", "description": "用于删除取回任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "取回任务ID", "example": "d00a3e6f9b**********040cebcee7a6" } ], "required": [ "TaskId" ] }, { "name": "DeleteRecordTemplate", "description": "用于删除实时上云模板", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "模板ID", "example": "48676e89a8c**********baa36220fa4" } ], "required": [ "TemplateId" ] }, { "name": "DeleteTask", "description": "用于删除执行完成的任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "任务ID", "example": "4d3535ba-3d81-4154-85ac-************" } ], "required": [ "TaskId" ] }, { "name": "DeleteUserDevice", "description": "用于删除已添加的设备。", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备ID（从获取设备列表ListDevices接口中获取）", "example": "f8656fa3-e7fa-4cad-a4cc-************" } ], "required": [ "DeviceId" ] }, { "name": "DescribeAITask", "description": "获取AI任务详情", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "AI任务ID", "example": "at0251f55fd5fe4adba237**********" } ], "required": [ "TaskId" ] }, { "name": "DescribeAITaskResult", "description": "获取AI任务识别结果", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "AI 任务 ID", "example": "at0251f55fd5fe4adba237**********" }, { "name": "ChannelId", "type": "string", "required": true, "description": "通道ID", "example": "f8656fa3-e7fa-4cad-a4cc-****" }, { "name": "Object", "type": "string", "required": false, "description": "桶内文件的路径。", "example": "要查看 bucket-id/a/b/c/dog.ts 的识别结果，此时传的值为\"a/b/c/dog.ts\"" }, { "name": "DetectType", "type": "string", "required": false, "description": "AI 任务识别类型。可选值为 Facemask(口罩识别)、Chefhat(厨师帽识别)、Smoking(抽烟检测)、Chefcloth(厨师服识别)、PhoneCall(接打电话识别)、Pet(宠物识别)、Body(人体识别)和 Car(车辆车牌识别)", "example": "Pet" }, { "name": "BeginTime", "type": "string", "required": false, "description": "开始时间时间。秒级时间戳。开始时间和结束时间跨度小于等于30天", "example": "1703124000" }, { "name": "EndTime", "type": "string", "required": false, "description": "结束时间时间。秒级时间戳。开始时间和结束时间跨度小于等于30天", "example": "1703127600" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "页码。默认为1", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页 AI 识别结果数量。可选值1～100，默认为10（按时间倒序显示识别结果）", "example": "20" } ], "required": [ "TaskId", "ChannelId" ] }, { "name": "DescribeCNAME", "description": "用于根据服务节点获取 CNAME 值。", "status": "online", "parameters": [ { "name": "ClusterId", "type": "string", "required": true, "description": "服务节点 ID（从查询域名可绑定服务节点接口DescribeDomainRegion中获取）", "example": "b2181417-03ce-4ea3-ae39-************" }, { "name": "DomainType", "type": "integer", "required": false, "description": "域名类型，0:拉流域名 1:推流域名", "example": "1" } ], "required": [ "ClusterId" ] }, { "name": "DescribeDeviceChannel", "description": "用于查询设备的通道。", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备ID（从获取设备列表接口ListDevices中获取）", "example": "f8656fa3-e7fa-4cad-a4cc-************" } ], "required": [ "DeviceId" ] }, { "name": "DescribeDevicePreset", "description": "用于查询设备通道预置位信息。", "status": "online", "parameters": [ { "name": "ChannelId", "type": "string", "required": true, "description": "通道ID（从通道查询接口DescribeDeviceChannel中获取）", "example": "f7ca505f-be1b-4ce8-849b-************" } ], "required": [ "ChannelId" ] }, { "name": "DescribeDeviceRegion", "description": "用于添加设备时，查询设备可以使用的服务节点，查询结果为已经绑定了域名的服务节点。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeDomain", "description": "用于查询添加的域名列表。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeDomainRegion", "description": "用于用户添加域名时，查询可以绑定的服务节点，结果为平台支持的所有服务节点。（注意：每个服务节点只能绑定一个域名）", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeGBDeviceAddr", "description": "用于获取国标设备的公网地址", "status": "online", "parameters": [ { "name": "DeviceIds", "type": "array", "required": true, "description": "设备ID列表", "example": "[\"ffefbe2f-****-****-****-7596a0e13900\",\"ffd25236-****-****-****-91b1aee8cbc0\"]", "item_type": "string" } ], "required": [ "DeviceIds" ] }, { "name": "DescribeGateway", "description": "用于获取网关详情。", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关索引ID（从获取网关列表接口ListGateways中获取）", "example": "f6d2540d-1d13-4873-b10e-************" } ], "required": [ "GatewayId" ] }, { "name": "DescribeGatewayMonitor", "description": "用于获取网关的数据及流量监控信息。", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关索引ID（从获取网关列表接口ListGateways中获取）", "example": "f6d2540d-1d13-4873-b10e-************" } ], "required": [ "GatewayId" ] }, { "name": "DescribeGatewayProtocol", "description": "用于查询网关接入协议。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeGatewayVersion", "description": "查询网关服务版本", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关索引ID（从获取网关列表接口ListGateways中获取）", "example": "f6d2540d-1d13-4873-b10e-************" } ], "required": [ "GatewayId" ] }, { "name": "DescribeOrganization", "description": "用于查询组织。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeRecordBackupPlan", "description": "用于查询录像上云计划详情。", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "录像上云计划ID（从查询录像上云计划列表接口ListRecordBackupPlans中获取）", "example": "f06d500f-64fb-42c0-b804-************" } ], "required": [ "PlanId" ] }, { "name": "DescribeRecordBackupTemplate", "description": "用于查询录像上云模板详情。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "模板ID（从查询录像上云模板列表接口ListRecordBackupTemplates中获取）", "example": "584fd9d0-569c-4153-aff7-************" } ], "required": [ "TemplateId" ] }, { "name": "DescribeRecordFile", "description": "用于查询设备云端录像时间轴信息（即为视频上云后设置录像计划后云存储的录像）", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "通道所属设备ID", "example": "389708b2-bcbb-********-a61f528b2a15" }, { "name": "ChannelId", "type": "string", "required": true, "description": "通道ID", "example": "32525dd7-c3fc-********-d5beb4acd1e1" }, { "name": "StartTime", "type": "integer", "required": true, "description": "检索开始时间，UTC秒数，例如：1662114146，开始和结束时间段最长为一天，且不能跨天", "example": "1687622400" }, { "name": "EndTime", "type": "integer", "required": true, "description": "检索结束时间，UTC秒数，例如：1662114246，开始和结束时间段最长为一天，且不能跨天", "example": "1687708799" }, { "name": "WithUrl", "type": "boolean", "required": false, "description": "是否携带每个时间段的播放url", "example": "false" } ], "required": [ "DeviceId", "ChannelId", "StartTime", "EndTime" ] }, { "name": "DescribeRecordPlan", "description": "用于查询实时上云计划详情", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "实时上云计划ID", "example": "88ac5ea6c1f**********24671d0f94f" } ], "required": [ "PlanId" ] }, { "name": "DescribeRecordPlaybackUrl", "description": "用于获取云端录像回放url地址", "status": "online", "parameters": [ { "name": "ChannelId", "type": "string", "required": true, "description": "设备通道ID", "example": "32525dd7-c3fc-********-d5beb4acd1e1" }, { "name": "StartTime", "type": "integer", "required": true, "description": "回放开始时间，UTC秒数，例如：1662114146，开始和结束时间段最长为一天，且不能跨天", "example": "1687677795" }, { "name": "EndTime", "type": "integer", "required": true, "description": "回放结束时间，UTC秒数，例如：1662114246，开始和结束时间段最长为一天，且不能跨天", "example": "1687688595" }, { "name": "IsInternal", "type": "boolean", "required": false, "description": "是否获取内网地址", "example": "false" }, { "name": "CorrectTimestamp", "type": "boolean", "required": false, "description": "云录像回放时，是否需要开启时间戳矫正，主要解决时间戳反转、回退等问题导致无法播放", "example": "false" } ], "required": [ "ChannelId", "StartTime", "EndTime" ] }, { "name": "DescribeRecordRetrieveTask", "description": "用于查询云录像取回任务详情", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "云录像取回任务ID", "example": "d00a3e6f9b**********040cebcee7a6" } ], "required": [ "TaskId" ] }, { "name": "DescribeRecordSlice", "description": "平台支持将数据以TS切片的形式存入客户自有COS桶，该接口用于支持客户快捷查询切片信息列表 （注意：只支持标准存储类型的查询）", "status": "online", "parameters": [ { "name": "ChannelId", "type": "string", "required": true, "description": "通道ID", "example": "32525dd7-c3fc-****-d5beb4acd1e1" }, { "name": "StartTime", "type": "integer", "required": true, "description": "检索开始时间，UTC秒数，例如：1662114146，开始和结束时间段最长为一天，且不能跨天", "example": "1687677795" }, { "name": "EndTime", "type": "integer", "required": true, "description": "检索结束时间，UTC秒数，例如：1662114246，开始和结束时间段最长为一天，且不能跨天", "example": "1687688595" } ], "required": [ "ChannelId", "StartTime", "EndTime" ] }, { "name": "DescribeRecordTemplate", "description": "用于查询实时上云模板详情", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "模板ID", "example": "48676e89a8c**********baa36220fa4" } ], "required": [ "TemplateId" ] }, { "name": "DescribeStreamAuth", "description": "用于查询推拉流鉴权配置。", "status": "online", "parameters": [], "required": [] }, { "name": "DescribeTask", "description": "用于查询任务详情", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "简单任务或复杂任务ID", "example": "4d3535ba-3d81-4154-85ac-************" } ], "required": [ "TaskId" ] }, { "name": "DescribeUserDevice", "description": "用于查询设备的详细信息。", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备ID（从获取设备列表接口ListDevices中获取）", "example": "f8656fa3-e7fa-4cad-a4cc-************" } ], "required": [ "DeviceId" ] }, { "name": "DescribeUserDeviceList", "description": "用于批量查询设备详细信息。", "status": "online", "parameters": [ { "name": "DeviceIds", "type": "array", "required": true, "description": "设备Id列表", "example": "[\"cf40269b-324b-464b-b2aa-************\",\"9e05af80-edbd-4115-a706-************\"]", "item_type": "string" } ], "required": [ "DeviceIds" ] }, { "name": "DescribeVideoBitRate", "description": "用于获取视频通道的码率信息", "status": "online", "parameters": [ { "name": "ChannelIds", "type": "array", "required": true, "description": "通道ID列表", "example": "[\"ffefbe2f-****-4659-****-7596****3900\",\"ffd2****-a057-****-a3dc-91b1****cbc0\"]", "item_type": "string" } ], "required": [ "ChannelIds" ] }, { "name": "DescribeVideoDownloadUrl", "description": "用于获取云录像下载 url", "status": "online", "parameters": [ { "name": "ChannelId", "type": "string", "required": true, "description": "通道 ID", "example": "00037e5f-2aaa-****-****-f30b13a86b02" }, { "name": "BeginTime", "type": "string", "required": true, "description": "下载的开始时间，UTC 秒数，开始和结束时间段最长为60分钟，且不能跨天。 注意：实际下载的文件时长可能会大于该时段时长，通过指定IsRespActualTime参数可以获取实际下载的开始时间和结束时间。 原因是下载是TS切片对齐的，其目的也是为了保证用户下载数据的完整性，完全包含其指定的时间段。", "example": "1706148000" }, { "name": "EndTime", "type": "string", "required": true, "description": "下载的结束时间，UTC 秒数，开始和结束时间段最长为60分钟，且不能跨天。 注意：实际下载的文件时长可能会大于该时段时长，通过指定IsRespActualTime参数可以获取实际下载的开始时间和结束时间。 原因是下载是TS切片对齐的，其目的也是为了保证用户下载数据的完整性，完全包含其指定的时间段。", "example": "1706148060" }, { "name": "FileType", "type": "string", "required": true, "description": "文件格式，\"mp4\"：mp4格式，\"ts\"：ts文件格式", "example": "mp4" }, { "name": "IsRespActualTime", "type": "boolean", "required": false, "description": "响应data中是否携带实际下载录像的开始时间与结束时间", "example": "false" }, { "name": "IsInternal", "type": "boolean", "required": false, "description": "是否返回内网下载URL，默认是false，返回公网下载URL，true则返回内网下载URL", "example": "false" }, { "name": "Expires", "type": "integer", "required": false, "description": "设置URL的有效期, 最小值是1秒, 最大值是86400秒, 不设置的话, 默认是600秒", "example": "600" }, { "name": "IsSupportG711", "type": "boolean", "required": false, "description": "下载的MP4文件是否支持G711音频编码. 注意: 如果云端录像中的音频编码为AAC, 那么下载的MP4默认是支持AAC编码的 如果云端录像中的音频编码为G711且 IsSupportG711设置为true时, 下载的MP4是支持G711音频编码 如果云端录像中的音频编码为G711且 IsSupportG711设置为false时, 下载的MP4是不支持G711音频编码 该参数只对FileType为mp4才有效, 不设置的话, 默认是false", "example": "false" } ], "required": [ "ChannelId", "BeginTime", "EndTime", "FileType" ] }, { "name": "ListAITasks", "description": "获取AI任务列表", "status": "online", "parameters": [ { "name": "IsContainChannelList", "type": "boolean", "required": false, "description": "是否包含通道列表。\"true\"代表包含通道列表，\"false\"代表不包含通道列表，默认为 false", "example": "true" }, { "name": "IsContainTemplate", "type": "boolean", "required": false, "description": "是否包含AI配置。\"true\"代表包含任务配置，\"false\"代表不包含任务配置，默认为 false。", "example": "true" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "页码。默认为1", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页数量。可选值1～200，默认为20", "example": "20" } ], "required": [] }, { "name": "ListDeviceSnapshots", "description": "获取设备抓拍结果列表", "status": "online", "parameters": [ { "name": "ChannelId", "type": "string", "required": true, "description": "通道ID", "example": "c9b87de2-****-41d7****-328****f240" }, { "name": "DeviceId", "type": "string", "required": false, "description": "设备ID（该字段暂不生效）", "example": "03b12rgw-****-41d7****-328****m240" }, { "name": "Start", "type": "integer", "required": false, "description": "查询开始时间，默认查询当天", "example": "1738375200" }, { "name": "End", "type": "integer", "required": false, "description": "查询结束时间，默认查询当天", "example": "1738411200" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "分页页码，默认1", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "分页大小，默认200，最大2000", "example": "20" } ], "required": [ "ChannelId" ] }, { "name": "ListDevices", "description": "用于获取对应组织下的设备列表。", "status": "online", "parameters": [ { "name": "OrganizationId", "type": "string", "required": true, "description": "组织ID", "example": "0" }, { "name": "IsContainSubLevel", "type": "boolean", "required": false, "description": "是否获取当前层级及子层级的设备列表，默认false", "example": "false" }, { "name": "IsContainUser", "type": "boolean", "required": false, "description": "是否包含当前用户已关联的设备，默认false", "example": "false" }, { "name": "AccessProtocol", "type": "integer", "required": false, "description": "设备接入协议。1:RTMP，2:GB，3:GW，4:IVCP(私有协议)", "example": "2" }, { "name": "Type", "type": "integer", "required": false, "description": "设备类型。1:IPC，2:NVR", "example": "2" }, { "name": "Status", "type": "integer", "required": false, "description": "设备状态。0:未注册，1:在线，2:离线，3:禁用", "example": "1" }, { "name": "ClusterId", "type": "string", "required": false, "description": "服务节点ID", "example": "b2181417-03ce-4ea3-ae39-****" }, { "name": "Keyword", "type": "string", "required": false, "description": "模糊搜索设备的关键字", "example": "设备1" }, { "name": "CurrentUin", "type": "integer", "required": false, "description": "当前用户Uin", "example": "21******35" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "页码，默认为1。", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页数量，默认为20，单页最大10000条", "example": "20" } ], "required": [ "OrganizationId" ] }, { "name": "ListGatewayDevices", "description": "用于查询网关下挂载的设备列表。", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关索引ID（从获取网关列表接口ListGateways中获取）", "example": "f6d2540d-1d13-4873-b10e-************" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "分页页数", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "分页大小", "example": "10" } ], "required": [ "GatewayId" ] }, { "name": "ListGateways", "description": "用于获取网关列表。", "status": "online", "parameters": [ { "name": "PageNumber", "type": "integer", "required": false, "description": "页码，默认为1", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页数量，默认为20", "example": "10" }, { "name": "Name", "type": "string", "required": false, "description": "网关名称", "example": "网关1" }, { "name": "ClusterId", "type": "string", "required": false, "description": "服务节点ID", "example": "b2181417-03ce-4ea3-ae39-************" }, { "name": "Status", "type": "integer", "required": false, "description": "网关状态（0：离线，1 ：在线）", "example": "1" } ], "required": [] }, { "name": "ListOrganizationChannelNumbers", "description": "用于查询组织目录下的未添加到实时上云计划中的通道数量", "status": "online", "parameters": [ { "name": "OrganizationId", "type": "array", "required": true, "description": "组织ID，json数组格式，最多一次支持10个组织", "example": "185", "item_type": "string" } ], "required": [ "OrganizationId" ] }, { "name": "ListOrganizationChannels", "description": "用于查询组织目录下的通道列表", "status": "online", "parameters": [ { "name": "OrganizationId", "type": "string", "required": true, "description": "组织ID", "example": "182" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页最大数量", "example": "10" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "第几页", "example": "1" }, { "name": "DeviceName", "type": "string", "required": false, "description": "查询条件，则按照设备名称查询 查询条件同时只有一个生效。长度不超过32字节", "example": "某店" }, { "name": "ChannelName", "type": "string", "required": false, "description": "查询条件，则按照通道名称查询 查询条件同时只有一个生效。长度不超过32字节", "example": "大门口" } ], "required": [ "OrganizationId", "PageSize", "PageNumber" ] }, { "name": "ListRecordBackupPlanDevices", "description": "用于查询录像上云计划下的设备通道列表。", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "录像计划ID（从查询录像上云计划列表接口ListRecordBackupPlans中获取）", "example": "f06d500f-64fb-42c0-b804-************" }, { "name": "DeviceName", "type": "string", "required": false, "description": "按照设备名称查询（为空时，不参考该参数）", "example": "设备1" }, { "name": "ChannelName", "type": "string", "required": false, "description": "按照通道名称查询（为空时，不参考该参数）", "example": "通道1" }, { "name": "OrganizationName", "type": "string", "required": false, "description": "按照组织名称查询（为空时，不参考该参数）", "example": "组织237" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页最大数量", "example": "10" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "分页页数", "example": "1" } ], "required": [ "PlanId" ] }, { "name": "ListRecordBackupPlans", "description": "用于查询录像上云计划列表。", "status": "online", "parameters": [], "required": [] }, { "name": "ListRecordBackupTemplates", "description": "用于查询录像上云模板列表。", "status": "online", "parameters": [], "required": [] }, { "name": "ListRecordPlanChannels", "description": "用于查询用户下所有实时上云计划中的通道列表", "status": "online", "parameters": [], "required": [] }, { "name": "ListRecordPlanDevices", "description": "用于查询实时上云计划下的设备通道列表", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "上云计划ID", "example": "88ac5ea6c1f**********24671d0f94f" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页最大数量", "example": "10" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "第几页", "example": "1" }, { "name": "DeviceName", "type": "string", "required": false, "description": "按照设备名称查询，为空时，不参考该参数 通道名称、设备名称、组织名称同时只有一个有效，如果同时多个字段有值，按照通道名称、设备名称、组织名称的优先级顺序查询，如果都为空，则全量查询。长度不超过32字节", "example": "某店" }, { "name": "ChannelName", "type": "string", "required": false, "description": "按照通道名称查询，为空时，不参考该参数 通道名称、设备名称、组织名称同时只有一个有效，如果同时多个字段有值，按照通道名称、设备名称、组织名称的优先级顺序查询，如果都为空，则全量查询。长度不超过32字节", "example": "大门口" }, { "name": "OrganizationName", "type": "string", "required": false, "description": "按照组织名称查询|，为空时，不参考该参数 通道名称、设备名称、组织名称同时只有一个有效，如果同时多个字段有值，按照通道名称、设备名称、组织名称的优先级顺序查询，如果都为空，则全量查询。长度不超过32字节", "example": "上海地区" } ], "required": [ "PlanId", "PageSize", "PageNumber" ] }, { "name": "ListRecordPlans", "description": "用于查询实时上云计划列表", "status": "online", "parameters": [], "required": [] }, { "name": "ListRecordRetrieveTasks", "description": "用于查询取回任务列表", "status": "online", "parameters": [], "required": [] }, { "name": "ListRecordTemplates", "description": "用于查询实时上云模板列表", "status": "online", "parameters": [], "required": [] }, { "name": "ListSubTasks", "description": "用于查询任务的子任务列表", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "复杂任务ID", "example": "4d3535ba-3d81-4154-85ac-************" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "页码，默认为1", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页数量，默认为10", "example": "10" }, { "name": "Status", "type": "integer", "required": false, "description": "默认不对该字段进行筛选，否则根据任务状态进行筛选。状态码：1-NEW，2-RUNNING，3-COMPLETED，4-FAILED", "example": "2" } ], "required": [ "TaskId" ] }, { "name": "ListTasks", "description": "用于查询批量任务和简单任务列表", "status": "online", "parameters": [ { "name": "PageNumber", "type": "integer", "required": false, "description": "页码，默认为1", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "每页数量，默认为20", "example": "10" }, { "name": "Operation", "type": "string", "required": false, "description": "默认不根据该字段进行筛选，否则根据设备操作类型进行筛选，目前值有：BatchDeleteUserDevice，BatchDisableDevice，BatchEnableDevice， BatchUpgradeDevice， BatchResetDevice, BatchRebootDevice, BatchRefreshDeviceChannel", "example": "BatchDisableDevice" }, { "name": "Status", "type": "integer", "required": false, "description": "默认不根据该字段进行筛选，否则根据任务状态进行筛选。状态码：1-未执行，2-执行中，3-完成，4-取消", "example": "2" }, { "name": "BeginTime", "type": "integer", "required": false, "description": "开始时间", "example": "1703645732" }, { "name": "EndTime", "type": "integer", "required": false, "description": "结束时间", "example": "1703645832" } ], "required": [] }, { "name": "ListVideoDownloadTask", "description": "查询本店里录像下载任务列表", "status": "online", "parameters": [ { "name": "DeviceName", "type": "string", "required": false, "description": "设备名称，用于模糊搜索", "example": "设备 1" }, { "name": "ChannelName", "type": "string", "required": false, "description": "通道名称，用于模糊搜索", "example": "通道 1" }, { "name": "Status", "type": "integer", "required": false, "description": "任务状态（0：准备中，1：执行中，2：已完成，3：失败）", "example": "1" }, { "name": "SortRule", "type": "string", "required": false, "description": "排序规则（仅支持 StartTime，倒序为-StartTime）", "example": "StartTime" }, { "name": "WithPreviewUrl", "type": "integer", "required": false, "description": "响应是否携带预览地址(0:不携带；1:携带)", "example": "1" }, { "name": "PageNumber", "type": "integer", "required": false, "description": "分页页数", "example": "1" }, { "name": "PageSize", "type": "integer", "required": false, "description": "分页大小", "example": "20" }, { "name": "DownloadTaskId", "type": "string", "required": false, "description": "下载任务 ID", "example": "ec72e1e1-fd18-407d-b537-************" }, { "name": "UrlExpires", "type": "integer", "required": false, "description": "下载地址过期时间，单位秒，最大为 1 天， 86400秒", "example": "3600" }, { "name": "Date", "type": "string", "required": false, "description": "任务日期，默认当天", "example": "2025-01-02" } ], "required": [] }, { "name": "PlayRecord", "description": "用于获取设备本地录像 URL 地址。", "status": "online", "parameters": [ { "name": "ChannelId", "type": "string", "required": true, "description": "通道 ID（从查询通道DescribeDeviceChannel接口中获取）", "example": "f7ca505f-be1b-4ce8-849b-************" }, { "name": "Start", "type": "integer", "required": true, "description": "起始时间", "example": "1702813300" }, { "name": "End", "type": "integer", "required": true, "description": "结束时间", "example": "1702814300" }, { "name": "StreamType", "type": "integer", "required": false, "description": "流类型（1:主码流；2:子码流（不可以和 Resolution 同时下发））", "example": "1" }, { "name": "Resolution", "type": "string", "required": false, "description": "分辨率（1:QCIF；2:CIF； 3:4CIF； 4:D1； 5:720P； 6:1080P/I； 自定义的19201080等等（需设备支持）（不可以和 StreamType 同时下发））", "example": "1280720" }, { "name": "IsInternal", "type": "boolean", "required": false, "description": "是否内网", "example": "true" } ], "required": [ "ChannelId", "Start", "End" ] }, { "name": "QueryForbidPlayChannelList", "description": "查询禁播通道列表", "status": "online", "parameters": [ { "name": "UserId", "type": "string", "required": true, "description": "子用户uin，也可以是主用户的uin", "example": "12*******36" }, { "name": "PageSize", "type": "integer", "required": true, "description": "每页最大数量，最大为200，超过按照200返回", "example": "10" }, { "name": "PageNumber", "type": "integer", "required": true, "description": "第几页", "example": "1" } ], "required": [ "UserId", "PageSize", "PageNumber" ] }, { "name": "RefreshDeviceChannel", "description": "用于同步国标设备的通道（接口调用后，触发向设备请求通道列表，新增的通道入库，设备上已删除的通道需自行删除、后台不自动删除）。", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备 ID（从获取设备列表ListDevices接口中获取）", "example": "f8656fa3-e7fa-4cad-a4cc-************" } ], "required": [ "DeviceId" ] }, { "name": "SetForbidPlayChannels", "description": "禁止主、子账号对视频通道的实况预览", "status": "online", "parameters": [ { "name": "Channels", "type": "array", "required": true, "description": "要禁播的通道参数，一次最多可以设置200个通道", "example": "无", "item_type": "object", "children": [ { "name": "ChannelId", "type": "string", "required": true, "description": "通道Id", "example": "9ee325e9984**********a805c19b4e1" }, { "name": "Enable", "type": "boolean", "required": true, "description": "是否禁止通道播流", "example": "true" } ] }, { "name": "UserId", "type": "string", "required": true, "description": "用户uin，可以是子用户的也可以是主用户的uin", "example": "12*******36" } ], "required": [ "Channels", "UserId" ] }, { "name": "UpdateAITask", "description": "更新AI任务", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "AI 任务 ID", "example": "at0251f55fd5fe****************" }, { "name": "Name", "type": "string", "required": false, "description": "AI 任务名称。仅支持中文、英文、数字、_、-，长度不超过32个字符", "example": "测试任务" }, { "name": "Desc", "type": "string", "required": false, "description": "AI 任务描述。仅支持中文、英文、数字、_、-，长度不超过128个字符", "example": "宠物识别" }, { "name": "ChannelList", "type": "array", "required": false, "description": "通道 ID 列表。不能添加存在于其他 AI 任务的通道，限制1000个通道。", "example": "f8656fa3-e7fa-4cad-a4cc-****", "item_type": "string" }, { "name": "CallbackUrl", "type": "string", "required": false, "description": "AI 结果回调地址", "example": "http(s)://xxxx" }, { "name": "IsStartTheTask", "type": "boolean", "required": false, "description": "是否立即开启 AI 任务。\"true\"代表立即开启 AI 任务，\"false\"代表暂不开启 AI 任务，默认为 false。", "example": "true" }, { "name": "Templates", "type": "array", "required": false, "description": "AI 配置列表", "example": "无", "item_type": "object", "children": [ { "name": "Tag", "type": "string", "required": true, "description": "AI 类别。可选值 AI(AI 分析)和 Snapshot(截图)，Templates 列表中只能出现一种类型。", "example": "AI" }, { "name": "AIConfig", "type": "object", "required": false, "description": "AI 分析配置。和\"SnapshotConfig\"二选一。", "example": "无", "children": [ { "name": "DetectType", "type": "string", "required": true, "description": "AI 分析类型。可选值为 Facemask(口罩识别)、Chefhat(厨师帽识别)、Smoking(抽烟检测)、Chefcloth(厨师服识别)、PhoneCall(接打电话识别)、Pet(宠物识别)、Body(人体识别)和Car(车辆车牌识别)等", "example": "Pet" }, { "name": "TimeInterval", "type": "integer", "required": true, "description": "截图频率。可选值1～20秒", "example": "10" }, { "name": "OperTimeSlot", "type": "array", "required": true, "description": "模板生效的时间段。最多包含5组时间段", "example": "无", "item_type": "object", "children": [ { "name": "Start", "type": "string", "required": true, "description": "开始时间。格式为\"hh:mm:ss\"，且 Start 必须小于 End", "example": "10:00:00" }, { "name": "End", "type": "string", "required": true, "description": "结束时间。格式为\"hh:mm:ss\"，且 Start 必须小于 End", "example": "20:00:00" } ] } ] }, { "name": "SnapshotConfig", "type": "object", "required": false, "description": "截图配置。和\"AIConfig\"二选一。", "example": "无", "children": [ { "name": "TimeInterval", "type": "integer", "required": true, "description": "截图频率。可选值1～20秒", "example": "10" }, { "name": "OperTimeSlot", "type": "array", "required": true, "description": "模板生效的时间段。最多包含5组时间段", "example": "无", "item_type": "object", "children": [ { "name": "Start", "type": "string", "required": true, "description": "开始时间。格式为\"hh:mm:ss\"，且 Start 必须小于 End", "example": "10:00:00" }, { "name": "End", "type": "string", "required": true, "description": "结束时间。格式为\"hh:mm:ss\"，且 Start 必须小于 End", "example": "20:00:00" } ] } ] } ] } ], "required": [ "TaskId" ] }, { "name": "UpdateAITaskStatus", "description": "更新 AI 任务状态", "status": "online", "parameters": [ { "name": "TaskId", "type": "string", "required": true, "description": "AI 任务 ID", "example": "at0251f55fd5fe4adba237**********" }, { "name": "Status", "type": "string", "required": true, "description": "AI 任务状态。\"on\"代表开启了 AI 分析任务，\"off\"代表停止AI分析任务", "example": "off" } ], "required": [ "TaskId", "Status" ] }, { "name": "UpdateDeviceOrganization", "description": "用于批量更改设备的组织。", "status": "online", "parameters": [ { "name": "DeviceIds", "type": "array", "required": true, "description": "设备 ID 数组（从获取设备列表接口ListDevices中获取）", "example": "f8656fa3-e7fa-4cad-a4cc-************", "item_type": "string" }, { "name": "OrganizationId", "type": "string", "required": true, "description": "组织 ID（从查询组织接口DescribeOrganization中获取）", "example": "237" } ], "required": [ "DeviceIds", "OrganizationId" ] }, { "name": "UpdateDeviceStatus", "description": "用于启用/禁用设备，禁用后拒绝设备注册。", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备 ID（从获取设备列表接口ListDevices中获取）", "example": "f8656fa3-e7fa-4cad-a4cc-************" }, { "name": "Status", "type": "integer", "required": true, "description": "禁用启用状态码（2：启用，3:禁用）", "example": "3" } ], "required": [ "DeviceId", "Status" ] }, { "name": "UpdateGateway", "description": "用于修改网关信息（支持对网关名称和描述的修改）。", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关索引ID（从获取网关列表ListGateways接口中获取）", "example": "f6d2540d-1d13-4873-b10e-************" }, { "name": "Name", "type": "string", "required": false, "description": "仅支持中文、英文、数网关名称，字、_、-，长度不超过32个字符", "example": "网关1" }, { "name": "Description", "type": "string", "required": false, "description": "网关描述，仅支持中文、英文、数字、_、-，长度不超过128个字符", "example": "这是一个网关" } ], "required": [ "GatewayId" ] }, { "name": "UpdateOrganization", "description": "用于修改组织。", "status": "online", "parameters": [ { "name": "OrganizationId", "type": "string", "required": true, "description": "组织ID（从查询组织接口DescribeOrganization中获取）", "example": "237" }, { "name": "Name", "type": "string", "required": true, "description": "组织名称，支持中文、英文、数字、空格、中英文括号、_、-, 长度不超过64位，且组织名称不能重复", "example": "组织2371" } ], "required": [ "OrganizationId", "Name" ] }, { "name": "UpdateRecordBackupPlan", "description": "用于修改录像上云计划。", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "计划ID", "example": "f06d500f-64fb-42c0-b804-************" }, { "name": "Mod", "type": "object", "required": true, "description": "修改的内容", "example": "无", "children": [ { "name": "PlanName", "type": "string", "required": false, "description": "录像上云计划名称（仅支持中文、英文、数字、_、-，长度不超过32个字符，计划名称全局唯一，不能为空，不能重复，不修改名称时，不需要该字段）", "example": "录像上云计划1" }, { "name": "TemplateId", "type": "string", "required": false, "description": "录制模板ID（从查询录像上云模板列表接口ListRecordBackupTemplates中获取，不修改模板ID时，不需要该字段）", "example": "584fd9d0-569c-4153-aff7-************" }, { "name": "Describe", "type": "string", "required": false, "description": "录像上云计划描述（仅支持中文、英文、数字、_、-，长度不超过128个字符， 不修改描述时，不需要该字段）", "example": "这是一个录像上云计划" }, { "name": "LifeCycle", "type": "object", "required": false, "description": "生命周期（录像文件生命周期设置，管理文件冷、热存储的时间，不修改生命周期时，不需要该字段）", "example": "无", "children": [ { "name": "Transition", "type": "integer", "required": true, "description": "云文件热存储时长，单位天，最小1天，最大3650天", "example": "7" }, { "name": "Expiration", "type": "integer", "required": true, "description": "云文件冷存储时长， 单位天，0表示不设置，设置时最小60天，Expiration字段加Transition字段不超过3650天", "example": "90" } ] }, { "name": "Add", "type": "array", "required": false, "description": "要新增的设备通道（Json数组，没有新增时，不需要该字段，一次添加通道总数不超过5000个，包括组织目录下的通道数量）", "example": "无", "item_type": "object", "children": [ { "name": "DeviceId", "type": "string", "required": true, "description": "通道所属的设备ID", "example": "f8656fa3-e7fa-4cad-a4cc-************" }, { "name": "ChannelId", "type": "string", "required": true, "description": "设备通道ID，一个设备通道只允许被一个上云计划添加", "example": "f7ca505f-be1b-4ce8-849b-************" } ] }, { "name": "Del", "type": "array", "required": false, "description": "要删除的设备通道（Json数组，内容为要删除的设备通道id，没有删除设备通道时，不需要该字段）", "example": "f8656fa3-e7fa-4cad-a4cc-************", "item_type": "string" }, { "name": "OrganizationId", "type": "array", "required": false, "description": "添加组织目录下所有设备通道（Json数组，可以为空，并且通道总数量不超过5000个（包括Add字段通道数量））", "example": "237", "item_type": "string" } ] } ], "required": [ "PlanId", "Mod" ] }, { "name": "UpdateRecordBackupTemplate", "description": "用于修改录像上云模板。", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "模板ID（从查询录像上云模板列表接口ListRecordBackupTemplates中获取）", "example": "584fd9d0-569c-4153-aff7-************" }, { "name": "Mod", "type": "object", "required": true, "description": "修改录像上云模板数据", "example": "无", "children": [ { "name": "TemplateName", "type": "string", "required": false, "description": "模板名称（不修改名称时，不需要带该字段）", "example": "录像上云模板1" }, { "name": "TimeSections", "type": "array", "required": false, "description": "上云时间段（按周进行设置，支持一天设置多个时间段，每个时间段不小于10分钟）", "example": "无", "item_type": "object", "children": [ { "name": "DayOfWeek", "type": "integer", "required": true, "description": "周日期，取值范围1～7（对应周一～周日", "example": "1" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，格式：HH:MM:SS，范围：[00:00:00～23:59:59]", "example": "08:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，格式：HH:MM:SS，范围：[00:00:00～23:59:59]", "example": "12:00:00" } ] }, { "name": "DevTimeSections", "type": "array", "required": false, "description": "录像时间段（按周进行设置，支持一天设置多个时间段，每个时间段不小于10分钟）", "example": "无", "item_type": "object", "children": [ { "name": "DayOfWeek", "type": "integer", "required": true, "description": "周日期，取值范围1～7（对应周一～周日", "example": "1" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，格式：HH:MM:SS，范围：[00:00:00～23:59:59]", "example": "08:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，格式：HH:MM:SS，范围：[00:00:00～23:59:59]", "example": "12:00:00" } ] }, { "name": "Scale", "type": "integer", "required": false, "description": "上云倍速（支持1，2，4倍速）", "example": " 2" } ] } ], "required": [ "TemplateId", "Mod" ] }, { "name": "UpdateRecordPlan", "description": "用于修改实时上云计划", "status": "online", "parameters": [ { "name": "PlanId", "type": "string", "required": true, "description": "计划ID", "example": "88ac5ea6c1f**********24671d0f94f" }, { "name": "Mod", "type": "object", "required": true, "description": "修改计划的内容", "example": "无", "children": [ { "name": "PlanName", "type": "string", "required": false, "description": "上云计划名称，仅支持中文、英文、数字、_、-，长度不超过32个字符，计划名称全局唯一，不能为空，不能重复，不修改名称时，不需要该字段", "example": "88ac5ea6c1**********224671d0f94f" }, { "name": "TemplateId", "type": "string", "required": false, "description": "上云模板ID，不修改模板ID时，不需要该字段", "example": "9ee325e9984b**********805c19b4e1" }, { "name": "Describe", "type": "string", "required": false, "description": "上云计划描述，仅支持中文、英文、数字、_、-，长度不超过128个字符， 不修改描述时，不需要该字段", "example": "工作日计划" }, { "name": "StreamType", "type": "string", "required": false, "description": "码流类型，default:不指定码流类型，以设备默认推送类型为主， main:主码流，sub:子码流，其他根据设备能力集自定义，长度不能超过32个字节", "example": "main" }, { "name": "LifeCycle", "type": "object", "required": false, "description": "生命周期，文件生命周期设置，管理文件冷、热存储的时间，不修改生命周期时，不需要该字段", "example": "无", "children": [ { "name": "Transition", "type": "integer", "required": true, "description": "云文件热存储时长，单位天，最小1天，最大3650天", "example": "7" }, { "name": "Expiration", "type": "integer", "required": true, "description": "云文件冷存储时长， 单位天，0表示不设置，设置时最小60天，Expiration字段加Transition字段不超过3650天", "example": "90" } ] }, { "name": "Add", "type": "array", "required": false, "description": "要新增的设备通道,Json数组，没有新增时，不需要该字段，一次添加通道总数不超过5000个，包括组织目录下的通道数量", "example": "无", "item_type": "object", "children": [ { "name": "DeviceId", "type": "string", "required": true, "description": "通道所属的设备ID", "example": "f8656fa3-e7fa-4cad-a4cc-************" }, { "name": "ChannelId", "type": "string", "required": true, "description": "设备通道ID，一个设备通道只允许被一个上云计划添加", "example": "f7ca505f-be1b-4ce8-849b-************" } ] }, { "name": "Del", "type": "array", "required": false, "description": "要删除的设备通道，Json数组，内容为要删除的设备通道id，没有删除设备通道时，不需要该字段", "example": "9ee325e9984**********a805c19b4e1", "item_type": "string" }, { "name": "OrganizationId", "type": "array", "required": false, "description": "组织目录ID，添加组织目录下所有设备通道，Json数组，可以为空，并且通道总数量不超过5000个（包括Add字段通道数量）", "example": "185", "item_type": "string" }, { "name": "RepairMode", "type": "integer", "required": false, "description": "录像补录模式（0:不启用，1:启用）", "example": "0" } ] } ], "required": [ "PlanId", "Mod" ] }, { "name": "UpdateRecordTemplate", "description": "用于修改实时上云模板", "status": "online", "parameters": [ { "name": "TemplateId", "type": "string", "required": true, "description": "模板ID", "example": "48676e89a8c**********baa36220fa4" }, { "name": "Mod", "type": "object", "required": true, "description": "修改内容", "example": "无", "children": [ { "name": "TemplateName", "type": "string", "required": false, "description": "模板名称， 不修改名称时，不需要带该字段", "example": "全天模板" }, { "name": "TimeSections", "type": "array", "required": false, "description": "上云时间段，不修改名称时，不需要带该字段", "example": "无", "item_type": "object", "children": [ { "name": "DayOfWeek", "type": "integer", "required": true, "description": "周日期，取值范围1～7（对应周一～周日", "example": "1" }, { "name": "StartTime", "type": "string", "required": true, "description": "开始时间，格式：HH:MM:SS，范围：[00:00:00～23:59:59]", "example": "08:00:00" }, { "name": "EndTime", "type": "string", "required": true, "description": "结束时间，格式：HH:MM:SS，范围：[00:00:00～23:59:59]", "example": "12:00:00" } ] } ] } ], "required": [ "TemplateId", "Mod" ] }, { "name": "UpdateUserDevice", "description": "用于修改设备的配置信息。", "status": "online", "parameters": [ { "name": "DeviceId", "type": "string", "required": true, "description": "设备ID（从获取设备列表接口ListDevices中获取）", "example": "f8656fa3-e7fa-4cad-a4cc-************" }, { "name": "Name", "type": "string", "required": false, "description": "设备名称（仅支持中文、英文、数字、空格、中英文括号、_、-, 长度不超过128位）", "example": "设备1" }, { "name": "TransportProtocol", "type": "integer", "required": false, "description": "设备流传输协议，仅国标设备有效，填0则不做更改（1:UDP,2:TCP）", "example": "2" }, { "name": "Password", "type": "string", "required": false, "description": "设备密码（仅国标，网关设备支持，长度不超过 64 位）", "example": "111111" }, { "name": "Description", "type": "string", "required": false, "description": "设备描述（长度不超过128位）", "example": "这个一个设备" }, { "name": "Ip", "type": "string", "required": false, "description": "设备接入Ip（仅网关接入支持）", "example": "192.168.x.1" }, { "name": "Port", "type": "integer", "required": false, "description": "设备Port（仅网关接入支持）", "example": "9000" }, { "name": "Username", "type": "string", "required": false, "description": "设备用户名（仅网关接入支持）", "example": "admin" }, { "name": "ProtocolType", "type": "integer", "required": false, "description": "网关设备接入协议（仅网关接入支持）", "example": "1" }, { "name": "AudioSwitch", "type": "integer", "required": false, "description": "音频关开（0：关闭；1：开启）默认开启，关闭时丢弃音频", "example": "1" }, { "name": "SubscribeSwitch", "type": "integer", "required": false, "description": "订阅开关（0：关闭；1：开启）默认开启，开启状态下会订阅设备通道变化，仅国标NVR设备有效", "example": "1" }, { "name": "SilentFrameSwitch", "type": "integer", "required": false, "description": "是否开启静音帧（0：关闭；1 开启）", "example": "1" } ], "required": [ "DeviceId" ] }, { "name": "UpgradeGateway", "description": "用于网关升级（支持对所有待更新的服务一键升级）。", "status": "online", "parameters": [ { "name": "GatewayId", "type": "string", "required": true, "description": "网关索引ID（从获取网关列表ListGateways接口中获取）", "example": "f6d2540d-1d13-4873-b10e-************" } ], "required": [ "GatewayId" ] } ] }