请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 stream_name 是 String 需要变更分区数量的通道名称。 target_partition_count 是 Integer 变更的目标分区数量。 取值为大于0的整数。 设置的值大于当前分区数量表示扩容，小于当前分区数量表示缩容。 注意： 每个通道在一小时内扩容和缩容总次数最多5次，且一小时内扩容或缩容操作有一次成功则最近一小时内不允许再次进行扩容或缩容操作。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 stream_name 是 String 通道名称。 通道名称由字母、数字、下划线和中划线组成，长度为1～64字符。 partition_count 是 Integer 分区数量。 分区是DIS数据通道的基本吞吐量单位。 stream_type 否 String 通道类型。 COMMON：普通通道，表示1MB带宽。 ADVANCED：高级通道，表示5MB带宽。 data_type 否 String 源数据类型。 BLOB：存储在数据库管理系统中的一组二进制数据。 JSON：一种开放的文件格式，以易读的文字为基础，用来传输由属性值或者序列性的值组成的数据对象。 CS V：纯文本形式存储的表格数据，分隔符默认采用逗号。 缺省值：BLOB。 data_duration 否 Integer 数据保留时长。 取值范围：24~72。 单位：小时。 空表示使用缺省值。 auto_scale_enabled 否 Boolean 是否开启自动扩缩容。 true：开启自动扩缩容。 false：关闭自动扩缩容。 默认不开启。 auto_scale_min_partition_count 否 Long 当自动扩缩容启用时，自动缩容的最小分片数。 auto_scale_max_partition_count 否 Integer 当自动扩缩容启用时，自动扩容的最大分片数。 data_schema 否 String 用于描述用户JSON、CSV格式的源数据结构，采用Avro Schema的语法描述。 csv_properties 否 CSVProperties object CSV 格式数据的相关属性，比如分隔符 delimiter compression_format 否 String 数据的压缩类型，目前支持： snappy gzip zip 默认不压缩。 tags 否 Array of Tag objects 通道标签列表。 sys_tags 否 Array of SysTag objects 通道企业项目列表。 表4 CSVProperties 参数 是否必选 参数类型 描述 delimiter 否 String 数据分隔符。 表5 Tag 参数 是否必选 参数类型 描述 key 否 String 键。 不能为空。 对于同一资源键值唯一。 字符集：A-Z，a-z ， 0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。 value 否 String 值。 长度不超过43个字符。 字符集：A-Z，a-z ， 0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。 只能包含数字、字母、中划线“-”、下划线“_”。 表6 SysTag 参数 是否必选 参数类型 描述 key 否 String 键。 不能为空。 值必须为_sys_enterprise_project_id。 value 否 String 值。 对应的是企业项目ID，需要在企业管理页面获取。 36位UUID。

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。 通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 stream_id 是 String 通道唯一标识符。 principal_id 是 String 授权用户。 如果授权给指定租户，格式为：domainId；如果授权给租户下的指定子用户，则格式为：子用户的domainId； 支持多账号添加，用","隔开，比如：domainId1,domainId2； action_type 是 String 授权操作类型。 putRecords：上传数据。 getRecords：下载数据。 getStreamInfo：通道详情。 effect 是 String 授权影响类型。 accept：允许该授权操作。

请求示例 给租户添加权限策略 POST https://{Endpoint}/v3/{project_id}/streams/{streamName}/policies { "stream_id" : "CiFdELMr0401K9GGZlp", "principal_id" : "domainid1", "action_type" : "putRecords", "effect" : "accept" } 给子用户添加权限策略 POST https://{Endpoint}/v3/{project_id}/streams/{streamName}/policies { "stream_id" : "CiFdELMr0401K9GGZlp", "principal_id" : "domainid1", "action_type" : "putRecords", "effect" : "accept" }

响应示例 状态码： 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 更新时间

响应示例 状态码：400 Bad Request { "error_code" : "APIG.2012", "error_msg" : "Invalid parameter value,parameterName:id. 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" }

URI POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id}/members/batch-enable 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 项目ID，获取方式请参见获取项目ID。 instance_id 是 String 实例ID，在API网关控制台的“实例信息”中获取。 vpc_channel_id 是 String VPC通道的编号

响应参数 状态码：204 No Content 状态码：400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述 状态码：500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 error_msg String 错误描述

响应示例 状态码：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" : "", "health_status" : "unhealthy" }, { "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" : "", "health_status" : "unhealthy" } ] } 状态码：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" }

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。

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 members Array of VpcMemberInfo objects 本次查询到的云服务器列表 表5 VpcMemberInfo 参数 参数类型 描述 host String 后端服务器地址 后端实例类型为ip时必填 最大长度：255 weight Integer 权重值。 允许您对后端服务进行评级，权重值越大，转发到该云服务的请求数量越多。 最小值：0 最大值：10000 is_backup Boolean 是否备用节点。 开启后对应后端服务为备用节点，仅当非备用节点全部故障时工作。 实例需要升级到对应版本才支持此功能，如果不支持请联系技术支持。 缺省值：false member_group_name String 后端服务器组名称。为后端服务地址选择服务器组，便于统一修改对应服务器组的后端地址。 status Integer 后端服务器状态 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 后端服务器组编号 health_status String 负载通道后端实例健康状态，unknown、healthy、unhealthy分别标识未做健康检查、健康、不健康。 状态码：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 错误描述

请求示例 创建自定义事件通道 POST https://{endpoint}/v1/{project_id}/channels { "name" : "channel", "description" : "first channel", "enterprise_project_id" : "string", "cross_account" : true, "policy" : { "additionalProp1" : { "Sid" : "allow_account_to_put_events", "Effect" : "Allow", "Principal" : { "additionalProp1" : { "IAM" : [ "domainID" ] }, "additionalProp2" : { "IAM" : [ "domainID" ] }, "additionalProp3" : { "IAM" : [ "domainID" ] } }, "Action" : "eg:channels:putEvents", "Resource" : "urn:eg:cn-east-2:07d52e5245000fef0f08c008b20dc5c0:channel:testChannel" }, "additionalProp2" : { "Sid" : "allow_account_to_put_events", "Effect" : "Allow", "Principal" : { "additionalProp1" : { "IAM" : [ "domainID" ] }, "additionalProp2" : { "IAM" : [ "domainID" ] }, "additionalProp3" : { "IAM" : [ "domainID" ] } }, "Action" : "eg:channels:putEvents", "Resource" : "urn:eg:cn-east-2:07d52e5245000fef0f08c008b20dc5c0:channel:testChannel" }, "additionalProp3" : { "Sid" : "allow_account_to_put_events", "Effect" : "Allow", "Principal" : { "additionalProp1" : { "IAM" : [ "domainID" ] }, "additionalProp2" : { "IAM" : [ "domainID" ] }, "additionalProp3" : { "IAM" : [ "domainID" ] } }, "Action" : "eg:channels:putEvents", "Resource" : "urn:eg:cn-east-2:07d52e5245000fef0f08c008b20dc5c0:channel:testChannel" } } }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表4 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 通道名称，租户下唯一，由字母，数字，点，下划线和中划线组成，必须字母或数字开头，不能是default description 否 String 通道描述 enterprise_project_id 否 String 企业项目id cross_account 否 Boolean 跨账号开关 policy 否 Object 策略