云服务器内容精选

  • URI GET /v2/{project_id}/push-channels 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID。获取方法请参见 获取项目ID。 最小长度:1 最大长度:64 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 查询的起始位置,取值范围为非负整数,默认为0 最小值:0 最大值:1000000 缺省值:0 limit 否 Integer 每页记录数,取值范围为非负整数,默认值为10 最小值:1 最大值:1000 缺省值:10
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 count Long 总记录数 最小值:0 最大值:1000000 page_info PageInfoDTO object 分页信息 channels Array of ChannelDTO objects 通道信息 数组长度:0 - 100 表5 PageInfoDTO 参数 参数类型 描述 offset Integer 页码 最小值:0 最大值:1000000 limit Integer 每页记录数 最小值:1 最大值:1000 表6 ChannelDTO 参数 参数类型 描述 channel_id String 规则ID name String 规则名称 channel String 通道 endpoint String 推送地址信息 description String 规则描述 create_time String 创建时间 update_time String 更新时间
  • 响应示例 状态码: 200 通道列表 { "total" : "2", "channels" : [ { "device_id" : "952352DJNR***", "device_name": "TESTNVR", "channel_id" : "0", "channel_name" : "龙岗通道1", "channel_state" : "ONLINE", "create_time" : "2020-06-26 20:42:16.0", "update_time" : "2020-06-26 20:42:16.0", "model" : "L", "access_protocol" : "HOLO", "channel_system_state" : "NORMAL", "channel_resource_state" : [ "MANAGEMENT_GRANT", "EVENT_RECORD_CLOSED", "FULL_RECORD_CLOSED" ], "channel_ability": [ "ptz" ], "channel_firmware": null, "config_state": null, "device_org_name": "组织名称123123123123", "channel_type": "IPC", "resolution": null }, { "device_id" : "952352DJNR***", "device_name": "TESTNVR", "channel_id" : "1", "channel_name" : "龙岗通道2", "channel_state" : "ONLINE", "create_time" : "2020-06-26 20:42:16.0", "update_time" : "2020-06-26 20:42:16.0", "model" : "L", "access_protocol" : "HOLO", "channel_system_state" : "NORMAL", "channel_resource_state" : [ "MANAGEMENT_GRANT", "EVENT_RECORD_CLOSED", "FULL_RECORD_CLOSED" ], "channel_ability": [ "ptz" ], "channel_firmware": null, "config_state": null, "device_org_name": "组织名称123123123123", "channel_type": "IPC", "resolution": null } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 channels Channel object 通道列表 表5 Channel 参数 参数类型 描述 device_id String 设备ID,设备唯一标识 device_name String 设备名称 channel_id String 通道ID channel_name String 通道名称 channel_state String 通道状态 枚举值: OFFLINE 离线 ONLINE 在线 UNALLOCATED 未注册 model String 通道的设备型号 access_protocol String 接入协议 枚举值: HOLO 好望协议 GB28181 国标协议 create_time String 通道创建时间 update_time String 通道更新时间 channel_system_state String 通道系统状态 枚举值: NORMAL 正常 UNAVAILABLE_FROZEN 冻结 channel_resource_state Array of strings 通道资源 枚举值: MANAGEMENT_GRANT 管理套餐开通 MANAGEMENT_ARREAR 管理套餐欠费 MANAGEMENT_CLOSED 管理套餐未开通 EVENT_RECORD_GRANT 动检套餐开通 EVENT_RECORD_ARREAR 动检套餐欠费 EVENT_RECORD_CLOSED 动检套餐关闭 FULL_RECORD_GRANT 全量套餐开通 FULL_RECORD_ARREAR 全量套餐欠费 FULL_RECORD_CLOSED 全量套餐关闭 INDUSTRY_DATA_GRANT 行业数据流套餐开通 INDUSTRY_DATA_ARREAR 行业数据流套餐欠费 INDUSTRY_DATA_CLOSED 行业数据流套餐关闭 CUSTOMER_GROUP_GRANT 客流客群服务开通 CUSTOMER_GROUP_ARREAR 客流客群服务欠费 CUSTOMER_GROUP_CLOSED 客流客群服务未开通 channel_ability Array of strings 通道能力集:枚举类型,参考附录设备能力集,多个能力集用逗号分隔 channel_firmware String 通道的设备固件版本号,如:SDC 10.0.0 config_state String 批量远程配置状态,枚举类型 枚举值: TRUE 可配置 FALSE 不可配置 device_org_name String 设备组织名称 channel_type String 通道类型 枚举值: IPC 通用相机 IPC-BULLET 枪机 IPC-BOX 筒机 IPC-CONCH 半球/海螺 IPDOME 球机 resolution String 分辨率
  • URI GET /v1/{user_id}/channels 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID:由数字组成,长度范围[15,25],获取方式参考获取user ID与下载AK/SK章节 表2 Query参数 参数 是否必选 参数类型 描述 access_protocol 否 String 接入协议:枚举类型,多个查询使用逗号分隔 枚举值: HOLO 好望协议 GB28181 国标协议 channel_name 否 String 通道名称:支持英文、中文(一个汉字算两个字符)、数字、特殊字符(_-空格),长度范围[1,128] channel_resource_state 否 String 通道资源状态:枚举类型,多个查询使用逗号分隔 枚举值: MANAGEMENT_GRANT 管理套餐开通 MANAGEMENT_ARREAR 管理套餐欠费 MANAGEMENT_CLOSED 管理套餐未开通 EVENT_RECORD_GRANT 动检套餐开通 EVENT_RECORD_ARREAR 动检套餐欠费 EVENT_RECORD_CLOSED 动检套餐关闭 FULL_RECORD_GRANT 全量套餐开通 FULL_RECORD_ARREAR 全量套餐欠费 FULL_RECORD_CLOSED 全量套餐关闭 INDUSTRY_DATA_GRANT 行业数据流套餐开通 INDUSTRY_DATA_ARREAR 行业数据流套餐欠费 INDUSTRY_DATA_CLOSED 行业数据流套餐关闭 CUSTOMER_GROUP_GRANT 客流客群服务开通 CUSTOMER_GROUP_ARREAR 客流客群服务欠费 CUSTOMER_GROUP_CLOSED 客流客群服务未开通 channel_state 否 String 通道状态:枚举类型,仅支持单个通道状态查询 枚举值: OFFLINE 离线 ONLINE 在线 UNALLOCATED 未注册 channel_system_state 否 String 系统状态:枚举类型,仅支持单个系统状态查询 枚举值: NORMAL 正常 UNAVAILABLE_FROZEN 冻结 device_id 否 String 设备ID: 好望设备:大小写字母、数字组成,长度范围[8,32],可在设备外壳或者设备web页面上获取 国标设备:由数字组成,长度为20个字符长度,由客户自行设置,其中第11-13位,必须是以下之一132(IPC)、111(DVR)、118(NVR),用来区分设备类型 direction 否 String 排序方向:枚举类型,默认升序,不区分大小写 枚举值: ASC 升序 DESC 降序 limit 否 Integer 限制条数:取值范围[1,1000],不填写时默认值为10 offset 否 Integer 偏移量:0表示从第1个匹配的数据开始查询,取值范围[0,2147483646],不填写时默认为0 sort_by 否 String 排序字段:枚举类型,默认按创建时间create_time排序 枚举值: create_time 创建时间 update_time 更新时间
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 device_id String 设备ID,设备唯一标识 channel_id String 通道ID channel_name String 通道名称 channel_state String 通道状态 枚举值: OFFLINE 离线 ONLINE 在线 UNREGISTERED 未注册 access_protocol String 接入协议 枚举值: HOLO 好望协议 GB28181 国标协议 channel_system_state String 设备系统状态 枚举值: NORMAL 正常 UNAVAILABLE_FROZEN 冻结 channel_resource_state Array of strings 通道资源 枚举值: MANAGEMENT_GRANT 管理套餐开通 MANAGEMENT_ARREAR 管理套餐欠费 MANAGEMENT_CLOSED 管理套餐未开通 EVENT_RECORD_GRANT 动检套餐开通 EVENT_RECORD_ARREAR 动检套餐欠费 EVENT_RECORD_CLOSED 动检套餐关闭 FULL_RECORD_GRANT 全量套餐开通 FULL_RECORD_ARREAR 全量套餐欠费 FULL_RECORD_CLOSED 全量套餐关闭 INDUSTRY_DATA_GRANT 行业数据流套餐开通 INDUSTRY_DATA_ARREAR 行业数据流套餐欠费 INDUSTRY_DATA_CLOSED 行业数据流套餐关闭 channel_ability String 通道能力集:枚举类型,参考附录设备能力集,多个能力集用逗号分隔 device_cloud_ability Object 云端能力集规格 model String 通道的设备型号,如:D3250 channel_intelligent String 智能算法能力集 firmware String 通道的设备固件版本号,如:SDC 10.0.0 create_time String 通道创建时间 update_time String 通道更新时间 sn String SN号 channel_firmware_id String 通道的设备固件版本号 channel_type String 通道类型 resolution String 分辨率
  • 响应示例 状态码: 200 OK { "device_id" : "952352DJNR***", "channel_id" : "0", "channel_name" : "龙岗通道1", "channel_state" : "ONLINE", "access_protocol" : "HOLO", "channel_system_state" : "NORMAL", "channel_resource_state" : [ "MANAGEMENT_GRANT", "EVENT_RECORD_CLOSED", "FULL_RECORD_CLOSED" ], "channel_ability" : "ptz,talk", "device_cloud_ability": { "alarm_voice": { "support": "true" }}, "model" : "L", "channel_intelligent" : "[{\"name\":\"perimeter\",\"enable\":true}]", "firmware" : "V22", "channel_firmware_id": "", "create_time" : "2020-06-26 20:42:16.0", "update_time": "2023-12-05 10:09:46.0", "sn": "", "channel_type": "IPC", "resolution": "5/6/4" }
  • URI GET /v1/{user_id}/devices/{device_id}/channels/{channel_id} 表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章节
  • 请求参数 表2 Query参数 参数 是否必选 参数类型 描述 ability 否 Array of strings 查询的能力集列表:不传默认查询所有能力集,数组长度范围[0,10] need_cloud_ability 否 Boolean 是否需要返回云上管理的能力集:false,不返回云上能力集信息;true,返回云上能力集信息。不填默认false need_specification 否 Boolean 是否需要能力规格:false,不返回能力规格;true,返回能力规格。不填默认false 表3 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken:从获取用户北向接口认证AccessToken中获取
  • URI PUT /v1/{user_id}/devices/{device_id}/channels/{channel_id} 表1 路径参数 参数 是否必选 参数类型 描述 channel_id 是 String 通道ID: 好望设备:取值范围[0,999] device_id 是 String 设备ID: 好望设备:大小写字母、数字组成,长度范围[8,32],可在设备外壳或者设备web页面上获取 、 user_id 是 String 用户ID:由数字组成,长度范围[15,25],获取方式参考获取user ID与下载AK/SK章节
  • 请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 Access-Token 是 String 用户认证AccessToken:从获取用户北向接口认证AccessToken中获取 表3 请求Body参数 参数 是否必选 参数类型 描述 channel_name 是 String 通道名称:支持英文、中文(一个汉字算两个字符)、数字、特殊字符(_-.空格换行符),长度范围[1,128]
  • 响应示例 状态码: 200 通道列表 { "total" : "2", "channels" : [ { "device_id" : "952352DJNR***", "device_name": "TESTNVR", "channel_id" : "0", "channel_name" : "龙岗通道1", "channel_state" : "ONLINE", "create_time" : "2020-06-26 20:42:16.0", "update_time" : "2020-06-26 20:42:16.0", "model" : "L", "access_protocol" : "HOLO", "channel_system_state" : "NORMAL", "channel_resource_state" : [ "MANAGEMENT_GRANT", "EVENT_RECORD_CLOSED", "FULL_RECORD_CLOSED" ], "channel_ability": [ "ptz" ], "channel_firmware": null, "config_state": null, "device_org_name": "组织名称123123123123", "channel_type": "IPC", "resolution": null }, { "device_id" : "952352DJNR***", "device_name": "TESTNVR", "channel_id" : "1", "channel_name" : "龙岗通道2", "channel_state" : "ONLINE", "create_time" : "2020-06-26 20:42:16.0", "update_time" : "2020-06-26 20:42:16.0", "model" : "L", "access_protocol" : "HOLO", "channel_system_state" : "NORMAL", "channel_resource_state" : [ "MANAGEMENT_GRANT", "EVENT_RECORD_CLOSED", "FULL_RECORD_CLOSED" ], "channel_ability": [ "ptz" ], "channel_firmware": null, "config_state": null, "device_org_name": "组织名称123123123123", "channel_type": "IPC", "resolution": null } ] }
  • 响应参数 状态码: 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 channels Channel object 通道列表 表5 Channel 参数 参数类型 描述 device_id String 设备ID,设备唯一标识 device_name String 设备名称 channel_id String 通道ID channel_name String 通道名称 channel_state String 通道状态 枚举值: OFFLINE 离线 ONLINE 在线 UNALLOCATED 未注册 model String 通道的设备型号 access_protocol String 接入协议 枚举值: HOLO 好望协议 GB28181 国标协议 create_time String 通道创建时间 update_time String 通道更新时间 channel_system_state String 通道系统状态 枚举值: NORMAL 正常 UNAVAILABLE_FROZEN 冻结 channel_resource_state Array of strings 通道资源 枚举值: MANAGEMENT_GRANT 管理套餐开通 MANAGEMENT_ARREAR 管理套餐欠费 MANAGEMENT_CLOSED 管理套餐未开通 EVENT_RECORD_GRANT 动检套餐开通 EVENT_RECORD_ARREAR 动检套餐欠费 EVENT_RECORD_CLOSED 动检套餐关闭 FULL_RECORD_GRANT 全量套餐开通 FULL_RECORD_ARREAR 全量套餐欠费 FULL_RECORD_CLOSED 全量套餐关闭 INDUSTRY_DATA_GRANT 行业数据流套餐开通 INDUSTRY_DATA_ARREAR 行业数据流套餐欠费 INDUSTRY_DATA_CLOSED 行业数据流套餐关闭 CUSTOMER_GROUP_GRANT 客流客群服务开通 CUSTOMER_GROUP_ARREAR 客流客群服务欠费 CUSTOMER_GROUP_GRANT 客流客群服务未开通 channel_ability Array of strings 通道能力集:枚举类型,参考附录设备能力集,多个能力集用逗号分隔 channel_firmware String 通道的设备固件版本号,如:SDC 10.0.0 config_state String 批量远程配置状态,枚举类型 枚举值: TRUE 可配置 FALSE 不可配置 device_org_name String 设备组织名称 channel_type String 通道类型 枚举值: IPC 通用相机 IPC-BULLET 枪机 IPC-BOX 筒机 IPC-CONCH 半球/海螺 IPDOME 球机 resolution String 分辨率
  • URI GET /v1/{user_id}/channels 表1 路径参数 参数 是否必选 参数类型 描述 user_id 是 String 用户ID:由数字组成,长度范围[15,25],获取方式参考获取user ID与下载AK/SK章节 表2 Query参数 参数 是否必选 参数类型 描述 access_protocol 否 String 接入协议:枚举类型,多个查询使用逗号分隔 枚举值: HOLO 好望协议 GB28181 国标协议 channel_name 否 String 通道名称:支持英文、中文(一个汉字算两个字符)、数字、特殊字符(_-空格),长度范围[1,128] channel_resource_state 否 String 通道资源状态:枚举类型,多个查询使用逗号分隔 枚举值: MANAGEMENT_GRANT 管理套餐开通 MANAGEMENT_ARREAR 管理套餐欠费 MANAGEMENT_CLOSED 管理套餐未开通 EVENT_RECORD_GRANT 动检套餐开通 EVENT_RECORD_ARREAR 动检套餐欠费 EVENT_RECORD_CLOSED 动检套餐关闭 FULL_RECORD_GRANT 全量套餐开通 FULL_RECORD_ARREAR 全量套餐欠费 FULL_RECORD_CLOSED 全量套餐关闭 INDUSTRY_DATA_GRANT 行业数据流套餐开通 INDUSTRY_DATA_ARREAR 行业数据流套餐欠费 INDUSTRY_DATA_CLOSED 行业数据流套餐关闭 CUSTOMER_GROUP_GRANT 客流客群服务开通 CUSTOMER_GROUP_ARREAR 客流客群服务欠费 CUSTOMER_GROUP_CLOSED 客流客群服务未开通 channel_state 否 String 通道状态:枚举类型,仅支持单个通道状态查询 枚举值: OFFLINE 离线 ONLINE 在线 UNALLOCATED 未注册 channel_system_state 否 String 系统状态:枚举类型,仅支持单个系统状态查询 枚举值: NORMAL 正常 UNAVAILABLE_FROZEN 冻结 device_id 否 String 设备ID: 好望设备:大小写字母、数字组成,长度范围[8,32],可在设备外壳或者设备web页面上获取 国标设备:由数字组成,长度为20个字符长度,由客户自行设置,其中第11-13位,必须是以下之一132(IPC)、111(DVR)、118(NVR),用来区分设备类型 direction 否 String 排序方向:枚举类型,默认升序,不区分大小写 枚举值: ASC 升序 DESC 降序 limit 否 Integer 限制条数:取值范围[1,1000],不填写时默认值为10 offset 否 Integer 偏移量:0表示从第1个匹配的数据开始查询,取值范围[0,2147483646],不填写时默认为0 sort_by 否 String 排序字段:枚举类型,默认按创建时间create_time排序 枚举值: create_time 创建时间 update_time 更新时间
  • 响应示例 状态码: 400 { "error_code" : "EG.00014000", "error_msg" : "Bad request" } 状态码: 401 { "error_code" : "EG.00014010", "error_msg" : "Incorrect token or token resolution failed" } 状态码: 403 { "error_code" : "EG.00014030", "error_msg" : "No permissions to request this method" } 状态码: 404 { "error_code" : "EG.00014040", "error_msg" : "Not request resource found" } 状态码: 500 { "error_code" : "EG.00015000", "error_msg" : "Internal Server Error" }