云服务器内容精选

  • URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/record-plan 表1 路径参数 参数 是否必选 参数类型 描述 channel_id 是 String 通道ID: 好望设备:取值范围[0,999] 国标设备:由数字组成,长度为20个字符,由客户自行在设备侧设置,可以在web界面获取 device_id 是 String 设备ID: 好望设备:大小写字母、数字组成,长度范围[8,32],可在设备外壳或者设备web页面上获取 国标设备:由数字组成,长度为20个字符长度,由客户自行设置,其中第11-13位,必须是以下之一132(IPC)、111(DVR)、118(NVR),用来区分设备类型 user_id 是 String 用户ID:由数字组成,长度范围[15,25],获取方式参考获取user ID与下载AK/SK章节
  • 响应示例 状态码: 200 OK { "device_id" : "952352DJNR***", "channel_id" : "0", "all_day" : false, "is_upload_record": true, "time_sections" : [ { "day_of_week" : 1, "start_time" : "00:02:00", "end_time" : "00:05:00" }, { "day_of_week" : 1, "start_time" : "00:06:00", "end_time" : "00:08:00" }, { "day_of_week" : 2, "start_time" : "00:02:00", "end_time" : "00:05:00" } ]}
  • 响应参数 状态码: 200 表3 响应Body参数 参数 参数类型 描述 device_id String 设备ID: 好望设备:大小写字母、数字组成,长度范围[8,32],可在设备外壳或者设备web页面上获取 国标设备:由数字组成,长度为20个字符长度,由客户自行设置,其中第11-13位,必须是以下之一132(IPC)、111(DVR)、118(NVR),用来区分设备类型 channel_id String 通道ID: 好望设备:取值范围[0,999] 国标设备:由数字组成,长度为20个字符,由客户自行在设备侧设置,可以在web界面获取 all_day Boolean 是否全程录像:枚举类型, 如果为true,time_sections省略 枚举值: true 是 false 否 is_upload_record Boolean 是否开启录像缓存补录:枚举类型。可以在web界面远程配置--企业统一配置--断网补录中更改此配置。 枚举值: true 开启 false 关闭 time_sections Array of TimeSection objects 通道录像计划时间段 表4 TimeSection 参数 参数类型 描述 day_of_week Integer 日期:取值范围[1,7](对应周一~周日) start_time String 录像开始时间:格式为HH:mm:ss,范围为[00:00:00~23:59:59] end_time String 录像结束时间:格式为HH:mm:ss,范围为[00:00:00~23:59:59] 状态码: 400 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码:失败对应具体错误码,成功无 error_msg String 请求失败时为:错误信息,成功无 状态码: 401 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码:失败对应具体错误码,成功无 error_msg String 请求失败时为:错误信息,成功无 状态码: 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码:失败对应具体错误码,成功无 error_msg String 请求失败时为:错误信息,成功无
  • URI GET /v1/{user_id}/target-groups 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID:由数字组成,长度范围[15,25],获取方式参考获取user ID与下载AK/SK 表2 Query参数 参数 是否必选 参数类型 描述 device_id 是 String 设备ID: 好望设备:大小写字母、数字组成,长度范围[8,32],可在设备外壳或者设备web页面上获取
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 groups Array of TargetGroup objects 目标库分组列表 device_id String 设备ID,设备唯一标识符 group_max_count String 最大目标库分组数量限制:-1表示不限制 表5 TargetGroup 参数 参数类型 描述 group_id Integer 目标库分组ID:目标库标识符 name String 目标库名称 enable String 目标库分组是否生效:枚举类型 IVS1800设备该字段不返回,IVS1800目标库均生效 枚举值: OPEN 生效 CLOSE 失效 is_fixed Boolean 是否可修改:true表示该目标库分组详情不可修改,false表示该目标库分组详情可以修改 is_hidden Boolean 是否隐藏:仅NVR有用,白名单返回的true,其他类型的目标库返回的是false
  • 响应示例 状态码: 200 OK { "groups": [ { "name": "ssre2d", "enable": "CLOSE", "group_id": 2, "is_fixed": true, "is_hidden": false } ], "device_id": "952352LWXT***", "group_max_count": 128}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken:从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 group_name 是 String 目标库分组名称:最大为63位 device_id 是 String 设备ID: 好望设备:大小写字母、数字组成,长度范围[8,32],可在设备外壳或者设备web页面上获取 group_type 否 String 目标库分组类型:枚举类型,不同设备支持的枚举类型不一样 NVR800设备下的目标库分组类型:不填默认为白名单 枚举值: WHITE 白名单 STRANGE 陌生人 BLACK 黑名单 SDC设备下的目标库分组类型:不填默认为其他名单 枚举值: OTHER 其他名单 DEFAULT 默认名单 WHITE 白名单 IVS1800设备下的目标库分组类型:不填默认为白名单 枚举值: WHITE 白名单 STRANGE 陌生人 RED 红名单
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken:从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 group_id 是 Integer 目标库分组ID:非负值,从获取目标库分组接口获取 device_id 是 String 设备ID: 好望设备:大小写字母、数字组成,长度范围[8,32],可在设备外壳或者设备web页面上获取
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken:从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 group_id 是 Integer 目标库分组ID:非负值,从获取目标库分组接口获取 device_id 是 String 设备ID: 好望设备:大小写字母、数字组成,长度范围[8,32],可在设备外壳或者设备web页面上获取
  • 响应示例 状态码: 200 OK { "targets" : [ { "name" : "mark", "gender" : "male", "age" : 24, "country" : "中国", "nation" : "汉", "native" : "杭州", "occupation" : "工人", "work_no" : "124****77", "phone" : "15********61", "email" : "1*********@qq.com", "domicile" : "杭州", "remark" : "无", "jpegBase64" : "/9j/4AAQSkZJRgABAQAAAQABAAD..." } ], "target_id" : "2", "external_target_id" : "1234567890123456"}
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken:从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 device_id 是 String 设备ID: 好望设备:大小写字母、数字组成,长度范围[8,32],可在设备外壳或者设备web页面上获取 target_ids 是 Array of strings 目标ID列表:数组长度范围[1,100] 目标ID:支持数字和-,长度范围[1,20],SDC的目标ID需要带上目标库ID(目标库ID_目标ID的形式), 可以从按索引范围获取目标ID列表、获取目标信息、按索引范围获取目标ID信息中获取
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 targets Array of TargetVo objects 目标列表(SDC仅返回图片信息和用户传入的目标ID) 表5 TargetVo 参数 参数类型 描述 target_id String 目标ID:目标标识符 name String 姓名 gender String 性别 age Integer 年龄 country String 国家 nation String 民族 native String 籍贯 occupation String 职业 organization String 组织名称 work_no String 工号或身份证号 phone String 电话 email String email domicile String 居住地 remark String 备注 eigen_value String 图片特征值 jpg String 图片内容:经过base64编码 start_time String 开始时间 end_time String 结束时间 external_target_id String 用户传入的目标ID:用户自定义的,在添加目标的时候由客户填入
  • URI GET /v1/{user_id}/devices/snap 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID:由数字组成,长度范围[15,25],获取方式参考获取user ID与下载AK/SK章节 表2 Query参数 参数 是否必选 参数类型 描述 channel_id 是 String 通道ID: 好望设备:取值范围[0,999] 国标设备:由数字组成,长度为20个字符,由客户自行在设备侧设置,可以在web界面获取 device_id 是 String 设备ID: 好望设备:大小写字母、数字组成,长度范围[8,32],可在设备外壳或者设备web页面上获取 国标设备:由数字组成,长度为20个字符长度,由客户自行设置,其中第11-13位,必须是以下之一132(IPC)、111(DVR)、118(NVR),用来区分设备类型 storage 是 String 是否 云存储 标识。 枚举值: true 当需要云存储时,接口返回图片的下载URL; false 无需存储时,返回图片base64编码数据。
  • 响应示例 状态码: 200 OK 示例 1 { "pic_url" : "// 当 storage 字段为 false 时,此字段为空串", "pic_data" : "AAAAgAAAAAAAAAAAAAAAgAAAAd+/G0N4rYLasJ08oixRKANqyPxtwopjAcfLZ4vrF3LjwAAAAAAAAAAAAAAsIovJNbDeBeddTigN037AAiOm67Mrvka1Ht8LGT2S8FDAySkfqvCnq+ CS 5BmInek3OfrSDIQDy+TUImvmwYXjpj3FkYIU+L0GkGD7C6r73YxoZ2ocChqpARrXIzlp/zKi4DpzQ47Ese4IX2zkrLgehpMhE98"} 示例 2 { "pic_url" : "http://api-ivm.myhuaweicloud.com/v1/holo/219123456CYP***_0_210/static", "pic_data" : "// 当 storage 字段为 true 时,此字段为空串"}示例2中获取到的pic_url的请求示例如下请求http://api-ivm.myhuaweicloud.com/v1/holo/219123456CYP***_0_210/staticAccess-Token: xxx响应格式1:{ "pic_data": "ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234ABCD1234" // base64编码的图片}响应格式2:二进制编码的图片内容
  • URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/record-config 表1 路径参数 参数 是否必选 参数类型 描述 channel_id 是 String 通道ID: 好望设备:取值范围[0,999] 国标设备:由数字组成,长度为20个字符,由客户自行在设备侧设置,可以在web界面获取 device_id 是 String 设备ID: 好望设备:大小写字母、数字组成,长度范围[8,32],可在设备外壳或者设备web页面上获取 国标设备:由数字组成,长度为20个字符长度,由客户自行设置,其中第11-13位,必须是以下之一132(IPC)、111(DVR)、118(NVR),用来区分设备类型 user_id 是 String 用户ID:由数字组成,长度范围[15,25],获取方式参考获取user ID与下载AK/SK章节