通道管理-华为云

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" : "", "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" }

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

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

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 size Integer 本次返回的列表长度 total Long 满足条件的记录数 members Array of VpcMemberInfo objects 本次查询到的云服务器列表表5 VpcMemberInfo 参数参数类型描述 host String 后端服务器地址后端实例类型为ip时必填 weight Integer 权重值。允许您对后端服务进行评级，权重值越大，转发到该云服务的请求数量越多。 is_backup Boolean 是否备用节点。开启后对应后端服务为备用节点，仅当非备用节点全部故障时工作。实例需要升级到对应版本才支持此功能，如果不支持请联系技术支持。 member_group_name String 后端服务器组名称。为后端服务地址选择服务器组，便于统一修改对应服务器组的后端地址。 status Integer 后端服务器状态 1：可用 2：不可用 port Integer 后端服务器端口 ecs_id String 后端云服务器的编号。后端实例类型为ecs时必填，支持英文，数字，“-”,“_”，1 ~ 64字符。 ecs_name String 后端云服务器的名称。后端实例类型为ecs时必填，支持汉字，英文，数字，“-”,“_”,“.”，1 ~ 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 错误描述

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 limit 否 Integer 每页显示的条目数量，条目数量小于等于0时，自动转换为20，条目数量大于500时，自动转换为500 name 否 String 云服务器的名称 member_group_name 否 String 后端服务器组名称。 member_group_id 否 String 后端服务器组编号 precise_search 否 String 指定需要精确匹配查找的参数名称，多个参数需要支持精确匹配时参数之间使用“,”隔开。目前支持name，member_group_name。

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

API网关 APIG-批量修改后端服务器状态可用:响应参数

响应参数状态码： 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 错误描述

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

API网关 APIG-批量修改后端服务器状态可用:响应示例

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

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

API网关 APIG-批量修改后端服务器状态可用:URI

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通道的编号

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

路网数字化服务 DRIS-修改业务通道:请求示例

请求示例 PUT https://{endpoint}/v1/{project_id}/v2x-edges/{v2x_edge_id}/data-channel Content-Type:application/json X-Auth-Token:******** Instance-Id:******** { "platform_type" : "DRIS", "platform_para" : { "address" : "127.0.0.1:8080", "username" : "username", "passwd" : "password1" } }

路网数字化服务 DRIS 业务通道管理

路网数字化服务 DRIS-修改业务通道:响应参数

响应参数状态码： 200 表5 响应Body参数参数参数类型描述 platform_type String 参数说明：平台类型。取值范围： DRIS：华为路网数字化平台 LITONG：利通 ZHONGQIYAN：中汽研 platform_para PlatformPara object 参数说明：platform_type为非DRIS时有效，表示第三方平台的对接参数 channel_status String 参数说明：华为路网数字化平台或第三方业务平台连接状态。取值范围： ONLINE：在线 OFFLINE：离线 INITIAL：初始化表6 PlatformPara 参数参数类型描述 address String 参数说明：第三方业务平台的ip地址和端口。 username String 参数说明：鉴权用户名。取值范围：长度不超过255，只允许字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。 passwd String 参数说明：鉴权密码，ITS800或者ATLAS500的密码取值范围：长度不超过255，只允许字母、数字、下划线（_）、问号（?）、反引号（'）、井号（#）、左小括号（(）、右小括号（)）、点（.）、逗号（,）、与（&）、百分号（%）、At（@）、感叹号（!）、连接符（-）的组合。

路网数字化服务 DRIS 业务通道管理

数据接入服务 DIS-查询通道列表:响应示例

响应示例状态码： 200 正常返回 { "total_number" : 1, "stream_names" : [ "newstream" ], "stream_info_list" : [ { "stream_id" : "8QM3Nt9YTLOwtUVYJhO", "stream_name" : "newstream", "create_time" : 1593569685875, "retention_period" : 24, "status" : "RUNNING", "stream_type" : "COMMON", "data_type" : "BLOB", "partition_count" : 1, "tags" : [ ], "auto_scale_enabled" : false, "auto_scale_min_partition_count" : 0, "auto_scale_max_partition_count" : 0 } ], "has_more_streams" : false }

数据接入服务 DIS 通道管理

数据接入服务 DIS-查询通道列表:响应参数

响应参数状态码： 200 表4 响应Body参数参数参数类型描述 total_number Long 当前租户所有通道数量。 stream_names Array of strings 满足当前请求条件的通道名称的列表。 has_more_streams Boolean 是否还有更多满足条件的通道。 true：是 false：否缺省值：false stream_info_list Array of StreamInfo objects 通道列表详情。表5 StreamInfo 参数参数类型描述 stream_name String 通道名称。 create_time Long 通道创建的时间，13位时间戳。 retention_period Integer 数据保留时长，单位是小时。 status String 通道的当前状态。 CREATING：创建中 RUNNING：运行中 TERMINATING：删除中 TERMINATED：已删除枚举值： CREATING RUNNING TERMINATING FROZEN stream_type String 通道类型。 COMMON：普通通道，表示1MB带宽。 ADVANCED：高级通道，表示5MB带宽。枚举值： COMMON ADVANCED data_type String 源数据类型。 BLOB：存储在数据库管理系统中的一组二进制数据。 JSON：一种开放的文件格式，以易读的文字为基础，用来传输由属性值或者序列性的值组成的数据对象。 CS V：纯文本形式存储的表格数据，分隔符默认采用逗号。缺省值：BLOB。枚举值： BLOB JSON CSV partition_count Integer 分区数量。分区是DIS数据通道的基本吞吐量单位。 auto_scale_enabled Boolean 是否开启自动扩缩容。 true：开启自动扩缩容。 false：关闭自动扩缩容。默认不开启。缺省值：false auto_scale_min_partition_count Integer 当自动扩缩容启用时，自动缩容的最小分片数。最小值：1 auto_scale_max_partition_count Integer 当自动扩缩容启用时，自动扩容的最大分片数。 tags Array of Tag objects 通道标签列表。 sys_tags Array of SysTag objects 通道企业项目列表。表6 Tag 参数参数类型描述 key String 键。不能为空。对于同一资源键值唯一。字符集：A-Z，a-z ， 0-9，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。最小长度：1 最大长度：36 value String 值。长度不超过43个字符。字符集：A-Z，a-z ， 0-9，‘.’，‘-’，‘_’，UNICODE字符（\u4E00-\u9FFF）。只能包含数字、字母、中划线“-”、下划线“_”。最小长度：0 最大长度：43 表7 SysTag 参数参数类型描述 key String 键。不能为空。值必须为_sys_enterprise_project_id。 status String 枚举值： _sys_enterprise_project_id value String 值。对应的是企业项目ID，需要在企业管理页面获取。 36位UUID。

数据接入服务 DIS 通道管理

数据接入服务 DIS-查询通道列表:URI

URI GET /v2/{project_id}/streams 表1 路径参数参数是否必选参数类型描述 project_id 是 String 项目ID。表2 Query参数参数是否必选参数类型描述 limit 否 Integer 单次请求返回通道列表的最大数量。最小值：1 最大值：100 缺省值：10 start_stream_name 否 String 从该通道开始返回通道列表，返回的通道列表不包括此通道名称。如果需要分页查询，第一页查询时不传该字段。返回结果has_more_streams为true时，进行下一页查询，start_stream_name传入第一页查询结果的最后一条通道名称。

数据接入服务 DIS 通道管理

行业视频管理服务 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 通道管理

IOT边缘 IOTEDGE-查询推送通道列表:URI

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

IOT边缘 IOTEDGE 推送通道管理

IOT边缘 IOTEDGE-查询推送通道列表:响应参数

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

IOT边缘 IOTEDGE 推送通道管理

云服务器内容精选

通道管理

7*24

备案

专业服务

退订

建议反馈

售前咨询热线