通道管理-华为云

行业视频管理服务 IVM-查询通道详情:响应参数

响应参数状态码： 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 分辨率

行业视频管理服务 IVM 通道管理

行业视频管理服务 IVM-查询通道详情:响应示例

响应示例状态码： 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" }

行业视频管理服务 IVM 通道管理

行业视频管理服务 IVM-查询通道详情:请求参数

请求参数表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中获取

行业视频管理服务 IVM 通道管理

行业视频管理服务 IVM-查询通道详情:URI

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章节

行业视频管理服务 IVM 通道管理

行业视频管理服务 IVM-修改通道名称:请求参数

请求参数表2 请求Header参数参数是否必选参数类型描述 Access-Token 是 String 用户认证AccessToken：从获取用户北向接口认证AccessToken中获取表3 请求Body参数参数是否必选参数类型描述 channel_name 是 String 通道名称：支持英文、中文（一个汉字算两个字符）、数字、特殊字符（_-.空格换行符），长度范围[1,128]

行业视频管理服务 IVM 通道管理

行业视频管理服务 IVM-修改通道名称:URI

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章节

行业视频管理服务 IVM 通道管理

行业视频管理服务 IVM-查询通道列表:响应示例

响应示例状态码： 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 } ] }

行业视频管理服务 IVM 通道管理

行业视频管理服务 IVM-查询通道列表:URI

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 更新时间

行业视频管理服务 IVM 通道管理

行业视频管理服务 IVM-查询通道列表:响应参数

响应参数状态码： 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 分辨率

行业视频管理服务 IVM 通道管理

事件网格 EG-创建自定义事件通道:响应参数

响应参数状态码： 200 表5 响应Header参数参数参数类型描述 X-Request-Id String This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. 表6 响应Body参数参数参数类型描述 id String 通道ID name String 通道名称 description String 通道描述 provider_type String 通道提供方类型，OFFICIAL：官方事件通道；CUSTOM：自定义事件通道；PARTNER：伙伴事件通道枚举值： OFFICIAL CUSTOM PARTNER created_time String 创建UTC时间 updated_time String 更新UTC时间 eps_id String 企业项目id 状态码： 400 表7 响应Body参数参数参数类型描述 error_code String 错误码最小长度：1 最大长度：128 error_msg String 错误消息最小长度：1 最大长度：512 error_details String 具体错误消息最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 401 表8 响应Body参数参数参数类型描述 error_code String 错误码最小长度：1 最大长度：128 error_msg String 错误消息最小长度：1 最大长度：512 error_details String 具体错误消息最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 403 表9 响应Body参数参数参数类型描述 error_code String 错误码最小长度：1 最大长度：128 error_msg String 错误消息最小长度：1 最大长度：512 error_details String 具体错误消息最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 404 表10 响应Body参数参数参数类型描述 error_code String 错误码最小长度：1 最大长度：128 error_msg String 错误消息最小长度：1 最大长度：512 error_details String 具体错误消息最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 500 表11 响应Body参数参数参数类型描述 error_code String 错误码最小长度：1 最大长度：128 error_msg String 错误消息最小长度：1 最大长度：512 error_details String 具体错误消息最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128

事件网格 EG 事件通道管理

事件网格 EG-创建自定义事件通道:响应示例

响应示例状态码： 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" }

事件网格 EG 事件通道管理

事件网格 EG-创建自定义事件通道:请求参数

请求参数表3 请求Header参数参数是否必选参数类型描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。最小长度：1 最大长度：16384 表4 请求Body参数参数是否必选参数类型描述 name 是 String 通道名称，租户下唯一，由字母，数字，点，下划线和中划线组成，必须字母或数字开头，不能是default 最小长度：1 最大长度：128 description 否 String 通道描述最大长度：255 eps_id 否 String 企业项目id cross_account 否 Boolean 跨账号 policy 否 Object 策略，JSON格式示例 {"Sid":"allow_account_to_put_events","Effect":"Allow","Principal":{"IAM":["domain_id_a", "domain_id_b"]},"Action":"eg:channels:putEvents","Resource":"urn:eg:$region_id:$project_id:channel:$channel_name"} 其中IAM处填写白名单账号的domainId，Resource字段根据实际环境切换变量，其他字段为固定值，请保持一致

事件网格 EG 事件通道管理

API网关 APIG-查看后端实例列表:响应示例

响应示例状态码： 200 OK { "total" : 2, "size" : 2, "members" : [ { "host" : "192.168.0.5", "weight" : 1, "is_backup" : false, "member_group_name" : "", "status" : 1, "port" : 22, "ecs_id" : "192.168.0.5", "ecs_name" : "192.168.0.5", "id" : "be63c6260a1043888187f84af39c9f0e", "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59", "create_time" : "2020-07-23T07:11:57Z", "member_group_id" : "" }, { "host" : "192.168.1.124", "weight" : 2, "is_backup" : false, "member_group_name" : "", "status" : 1, "port" : 22, "ecs_id" : "192.168.1.124", "ecs_name" : "192.168.1.124", "id" : "a57b13f1b89b417ca8acd76909e6df67", "vpc_channel_id" : "56a7d7358e1b42459c9d730d65b14e59", "create_time" : "2020-07-23T07:11:57Z", "member_group_id" : "" } ] } 状态码： 400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:name. Please refer to the support documentation" } 状态码： 401 Unauthorized { "error_code" : "APIG.1002", "error_msg" : "Incorrect token or token resolution failed" } 状态码： 403 Forbidden { "error_code" : "APIG.1005", "error_msg" : "No permissions to request this method" } 状态码： 404 Not Found { "error_code" : "APIG.3023", "error_msg" : "The VPC channel does not exist,id:56a7d7358e1b42459c9d730d65b14e59" } 状态码： 500 Internal Server Error { "error_code" : "APIG.9999", "error_msg" : "System error" }

API网关 APIG 专享版-VPC通道管理

API网关 APIG-查看后端实例列表:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 members Array of VpcMemberInfo objects 本次查询到的云服务器列表表5 VpcMemberInfo 参数参数类型描述 host String 后端服务器地址后端实例类型为ip时必填最大长度：64 weight Integer 权重值。允许您对后端服务进行评级，权重值越大，转发到该云服务的请求数量越多。最小值：0 最大值：10000 is_backup Boolean 是否备用节点。开启后对应后端服务为备用节点，仅当非备用节点全部故障时工作。实例需要升级到对应版本才支持此功能，若不支持请联系技术支持。缺省值：false member_group_name String 后端服务器组名称。为后端服务地址选择服务器组，便于统一修改对应服务器组的后端地址。 status Integer 后端服务器状态 1：可用 2：不可用枚举值： 1 2 port Integer 后端服务器端口最小值：0 最大值：65535 ecs_id String 后端云服务器的编号。后端实例类型为ecs时必填，支持英文，数字，“-”,“_”，1 ~ 64字符。最大长度：255 ecs_name String 后端云服务器的名称。后端实例类型为ecs时必填，支持汉字，英文，数字，“-”,“_”,“.”，1 ~ 64字符。最大长度：64 id String 后端实例对象的编号 vpc_channel_id String VPC通道的编号 create_time String 后端实例增加到VPC通道的时间 member_group_id String 后端服务器组编号状态码： 400 表6 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 401 表7 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 403 表8 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 404 表9 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述状态码： 500 表10 响应Body参数参数参数类型描述 error_code String 错误码 error_msg String 错误描述

API网关 APIG 专享版-VPC通道管理

API网关 APIG-查看后端实例列表:URI

URI GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/members 表1 路径参数参数是否必选参数类型描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 vpc_channel_id 是 String VPC通道的编号表2 Query参数参数是否必选参数类型描述 offset 否 Long 偏移量，表示从此偏移量开始查询，偏移量小于0时，自动转换为0 缺省值：0 limit 否 Integer 每页显示的条目数量，条目数量小于等于0时，自动转换为20，条目数量大于500时，自动转换为500 最小值：1 最大值：500 缺省值：20 name 否 String 云服务器的名称 member_group_name 否 String 后端服务器组名称。 member_group_id 否 String 后端服务器组编号 precise_search 否 String 指定需要精确匹配查找的参数名称，多个参数需要支持精确匹配时参数之间使用“,”隔开。目前支持name，member_group_name。

API网关 APIG 专享版-VPC通道管理

云服务器内容精选

通道管理

7*24

备案

专业服务

退订

建议反馈

售前咨询热线