华为云用户手册

响应参数 状态码： 200 表13 响应Header参数 参数 参数类型 描述 X-Request-Id String This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. 表14 响应Body参数 参数 参数类型 描述 id String 订阅目标ID name String 订阅的事件目标名称 provider_type String 订阅的事件目标的提供方类型 connection_id String 订阅的事件目标使用的目标链接ID 最大长度：64 detail Object 订阅的事件目标参数列表 transform TransForm object 订阅的事件目标转换规则 dead_letter_queue DeadLetterQueue object 订阅的死信参数列表 created_time String 创建时间 updated_time String 更新时间 表15 TransForm 参数 参数类型 描述 type String 转换规则类型 枚举值： ORIGINAL CONSTANT VARIABLE value String 常量类型规则时，字段为常量内容定义； 变量类型规则时，为变量定义，内容必须为JsonObject字符串。 变量最多支持100个，且不支持嵌套结构定义； 变量名由字母、数字、点、下划线和中划线组成，必须字母或数字开头不能以HC.开头，长度不超过64个字符； 变量值表达式支持常量或JsonPath表达式，字符串长度不超过1024个字符。 最大长度：1024 template String 变量类型规则时，规则内容的模板定义，支持对已定义变量的引用。 最大长度：2048 表16 DeadLetterQueue 参数 参数类型 描述 type String 队列类型 枚举值： KAFKA instance_id String 实例id 最小长度：1 最大长度：128 connection_id String 目标连接id 最小长度：1 最大长度：128 topic String 主题 最小长度：1 最大长度：128 状态码： 400 表17 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 401 表18 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 403 表19 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 404 表20 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 500 表21 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128

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

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 事件源ID name String 目标连接名称，租户下唯一，由小写字母、数字、点、下划线和中划线组成，必须以字母或数字开头，不能为default description String 目标连接描述 status String 目标连接状态 枚举值： CREATING CREATED CREATE_FAILED error_info ErrorInfo object vpc_id String 待连接的VPC ID subnet_id String 待连接的子网ID agency String 私网目标连接使用的用户委托名称 flavor flavor object 规格 type String 目标连接类型。目前支持webhook：http连接；kafka：华为云官方kafka实例 枚举值： WEBHOOK KAFKA kafka_detail KafkaConnectionDetail object created_time String 创建UTC时间 updated_time String 更新UTC时间 表4 ErrorInfo 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_detail String 错误详情 最小长度：1 最大长度：128 error_msg String 错误信息 最小长度：1 最大长度：128 表5 flavor 参数 参数类型 描述 name String 规格名称 concurrency_type String 并发规格类型 枚举值： shared exclusive concurrency Integer 并发数 bandwidth_type String 带宽类型 枚举值： shared exclusive 表6 KafkaConnectionDetail 参数 参数类型 描述 instance_id String kafka实例id。 addr String kafka连接地址。 security_protocol String 安全协议。 enable_sasl_ssl Boolean kafka实例是否开启了SASL_SSL。 缺省值：false user_name String kafka实例用户名。实例开启了SASL_SSL时必填 password String kafka实例密码。实例开启了SASL_SSL时必填 acks String 收到Server端确认信号个数，表示producer需要收到多少个这样的确认信号，算消息发送成功。acks参数代表了数据备份的可用性。支持选项： acks=0：表示producer不需要等待任何确认收到的信息，副本将立即加到socket buffer并认为已经发送。没有任何保障可以保证此种情况下server已经成功接收数据，同时重试配置不会发生作用（因为客户端不知道是否失败）回馈的offset会总是设置为-1。 acks=1：这意味着至少要等待leader已经成功将数据写入本地log，但是并没有等待所有follower是否成功写入。如果follower没有成功备份数据，而此时leader又无法提供服务，则消息会丢失。 acks=all：这意味着leader需要等待ISR中所有备份都成功写入日志，只有任何一个备份存活，数据都不会丢失。min.insync.replicas指定必须确认写入才能被认为成功的副本的最小数量。 缺省值：1 枚举值： 0 1 all 状态码： 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

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

响应参数 状态码： 200 表3 响应Body参数 参数 参数类型 描述 id String 事件模型版本ID schema_id String 事件模型ID version Integer 事件模型版本号 format String 事件模型格式 created_time String 创建时间 updated_time String 更新时间 definition String 事件模型内容定义 状态码： 400 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 401 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 403 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 404 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 500 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128

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

响应参数 状态码： 200 表5 响应Body参数 参数 参数类型 描述 id String 订阅ID name String 订阅名称 description String 订阅描述 type String 类型 枚举值： EVENT SCHEDULED status String 状态 枚举值： CREATED ENABLED DISABLED FROZEN ERROR channel_id String 通道ID channel_name String 通道名称 used Array of SubscriptionUsedInfo objects 标签信息 sources Array of SubscriptionSourceInfo objects 订阅源列表 targets Array of SubscriptionTargetInfo objects 订阅目标列表 created_time String 创建时间 updated_time String 更新时间 表6 SubscriptionUsedInfo 参数 参数类型 描述 resource_id String 关联资源ID owner String 管理租户账号 description String 描述 表7 SubscriptionSourceInfo 参数 参数类型 描述 id String 订阅源ID name String 订阅的事件源名称 provider_type String 订阅的事件源的提供方类型 detail Object 订阅的事件源参数列表 filter Object 订阅事件源的匹配过滤规则 created_time String 创建时间 updated_time String 更新时间 表8 SubscriptionTargetInfo 参数 参数类型 描述 id String 订阅目标ID name String 订阅的事件目标名称 provider_type String 订阅的事件目标的提供方类型 connection_id String 订阅的事件目标使用的目标链接ID 最大长度：64 detail Object 订阅的事件目标参数列表 transform TransForm object 订阅的事件目标转换规则 dead_letter_queue DeadLetterQueue object 订阅的死信参数列表 created_time String 创建时间 updated_time String 更新时间 表9 TransForm 参数 参数类型 描述 type String 转换规则类型 枚举值： ORIGINAL CONSTANT VARIABLE value String 常量类型规则时，字段为常量内容定义； 变量类型规则时，为变量定义，内容必须为JsonObject字符串。 变量最多支持100个，且不支持嵌套结构定义； 变量名由字母、数字、点、下划线和中划线组成，必须字母或数字开头不能以HC.开头，长度不超过64个字符； 变量值表达式支持常量或JsonPath表达式，字符串长度不超过1024个字符。 最大长度：1024 template String 变量类型规则时，规则内容的模板定义，支持对已定义变量的引用。 最大长度：2048 表10 DeadLetterQueue 参数 参数类型 描述 type String 队列类型 枚举值： KAFKA instance_id String 实例id 最小长度：1 最大长度：128 connection_id String 目标连接id 最小长度：1 最大长度：128 topic String 主题 最小长度：1 最大长度：128 状态码： 400 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 401 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 403 表13 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 404 表14 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 500 表15 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：16384 表3 请求Body参数 参数 是否必选 参数类型 描述 agency_name 是 String 委托名称 id 是 String 需要翻新的触发器id transform 是 TransForm object 规则配置 表4 TransForm 参数 是否必选 参数类型 描述 type 是 String 转换规则类型 枚举值： ORIGINAL CONSTANT VARIABLE value 否 String 常量类型规则时，字段为常量内容定义； 变量类型规则时，为变量定义，内容必须为JsonObject字符串。 变量最多支持100个，且不支持嵌套结构定义； 变量名由字母、数字、点、下划线和中划线组成，必须字母或数字开头不能以HC.开头，长度不超过64个字符； 变量值表达式支持常量或JsonPath表达式，字符串长度不超过1024个字符。 最大长度：1024 template 否 String 变量类型规则时，规则内容的模板定义，支持对已定义变量的引用。 最大长度：2048

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128

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

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

响应参数 状态码： 200 表15 响应Header参数 参数 参数类型 描述 X-Request-Id String This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. 表16 响应Body参数 参数 参数类型 描述 id String 订阅ID name String 订阅名称 description String 订阅描述 type String 类型 枚举值： EVENT SCHEDULED status String 状态 枚举值： CREATED ENABLED DISABLED FROZEN ERROR channel_id String 通道ID channel_name String 通道名称 used Array of SubscriptionUsedInfo objects 标签信息 sources Array of SubscriptionSourceInfo objects 订阅源列表 targets Array of SubscriptionTargetInfo objects 订阅目标列表 created_time String 创建时间 updated_time String 更新时间 表17 SubscriptionUsedInfo 参数 参数类型 描述 resource_id String 关联资源ID owner String 管理租户账号 description String 描述 表18 SubscriptionSourceInfo 参数 参数类型 描述 id String 订阅源ID name String 订阅的事件源名称 provider_type String 订阅的事件源的提供方类型 detail Object 订阅的事件源参数列表 filter Object 订阅事件源的匹配过滤规则 created_time String 创建时间 updated_time String 更新时间 表19 SubscriptionTargetInfo 参数 参数类型 描述 id String 订阅目标ID name String 订阅的事件目标名称 provider_type String 订阅的事件目标的提供方类型 connection_id String 订阅的事件目标使用的目标链接ID 最大长度：64 detail Object 订阅的事件目标参数列表 transform TransForm object 订阅的事件目标转换规则 dead_letter_queue DeadLetterQueue object 订阅的死信参数列表 created_time String 创建时间 updated_time String 更新时间 表20 TransForm 参数 参数类型 描述 type String 转换规则类型 枚举值： ORIGINAL CONSTANT VARIABLE value String 常量类型规则时，字段为常量内容定义； 变量类型规则时，为变量定义，内容必须为JsonObject字符串。 变量最多支持100个，且不支持嵌套结构定义； 变量名由字母、数字、点、下划线和中划线组成，必须字母或数字开头不能以HC.开头，长度不超过64个字符； 变量值表达式支持常量或JsonPath表达式，字符串长度不超过1024个字符。 最大长度：1024 template String 变量类型规则时，规则内容的模板定义，支持对已定义变量的引用。 最大长度：2048 表21 DeadLetterQueue 参数 参数类型 描述 type String 队列类型 枚举值： KAFKA instance_id String 实例id 最小长度：1 最大长度：128 connection_id String 目标连接id 最小长度：1 最大长度：128 topic String 主题 最小长度：1 最大长度：128 状态码： 400 表22 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 401 表23 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 403 表24 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 404 表25 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 500 表26 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：16384 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 订阅名称，租户下唯一，由字母、数字、点、下划线和中划线组成，必须字母或数字开头 最小长度：1 最大长度：128 description 否 String 订阅描述 最大长度：255 channel_id 是 String 所属事件通道ID sources 是 Array of SubscriptionSource objects 订阅的事件源列表， 当前仅支持订阅一个事件源 数组长度：1 - 1 targets 是 Array of SubscriptionTarget objects 事件目标列表，至少订阅一个事件目标 表4 SubscriptionSource 参数 是否必选 参数类型 描述 id 否 String 订阅源ID，需保证全局唯一。指定ID的订阅源存在时则进行更新，否则进行创建；未指定时由系统自动生成。由小写字母、数字、中划线组成，必须字母或数字开头。 最小长度：32 最大长度：64 name 是 String 订阅的事件源名称 最大长度：128 provider_type 是 String 订阅的事件源的提供方类型 枚举值： CUSTOM OFFICIAL PARTNER detail 否 Object 订阅的事件源参数列表, 该字段序列化后总长度不超过1024字节 filter 是 Object 订阅事件源的匹配过滤规则, 该字段序列化后总长度不超过2048字节 表5 SubscriptionTarget 参数 是否必选 参数类型 描述 id 否 String 订阅目标ID，需保证全局唯一，由小写字母、数字、中划线组成，必须字母或数字开头。 更新订阅场景时，指定ID的订阅目标存在时则进行更新，否则进行创建； 创建订阅目标场景时，指定ID作为待创建的订阅目标对象ID，未指定时由系统自动生成。 更新订阅目标时，此字段忽略； 最小长度：32 最大长度：64 name 是 String 订阅的事件目标名称 最大长度：128 provider_type 是 String 订阅的事件目标的提供方类型 枚举值： CUSTOM OFFICIAL connection_id 否 String 订阅的事件目标使用的目标链接ID 最大长度：64 detail 否 Detail object 订阅的事件目标参数列表，该字段序列化后总长度不超过1024字节，函数、函数流、webhook订阅目标必填，其中函数、函数流委托名称必填 kafka_detail 否 KafkaTargetDetail object 订阅的事件kafka目标参数列表，该字段序列化后总长度不超过1024字节，kafka订阅目标必填 smn_detail 否 SmnTargetDetail object 订阅的事件smn目标参数列表，该字段序列化后总长度不超过1024字节，smn订阅目标必填 transform 是 TransForm object 订阅的事件目标转换规则 dead_letter_queue 否 DeadLetterQueue object 订阅的死信参数列表 表6 Detail 参数 是否必选 参数类型 描述 url 否 String 自定义目标url agency_name 否 String 委托名称 invocation_http_parameters 否 InvocationHttpParameters object invoke_type 否 String 函数调用方式,异步/同步 枚举值： SYNC，ASYNC 表7 InvocationHttpParameters 参数 是否必选 参数类型 描述 header_parameters 否 Array of HeaderParameter objects 对象列表 数组长度：0 - 5 表8 HeaderParameter 参数 是否必选 参数类型 描述 is_value_secret 否 Boolean 是否加密 key 否 String header的key值 最小长度：1 最大长度：256 value 否 String header的value值 最小长度：1 最大长度：1024 表9 KafkaTargetDetail 参数 是否必选 参数类型 描述 topic 是 String 主题 keyTransform 否 keyTransform object 键值规则 表10 keyTransform 参数 是否必选 参数类型 描述 type 否 String 键值规则类型 枚举值： NONE VARIABLE CONSTANT value 否 String 键值规则，键值规则为VARIABLE，CONSTANT时必填 template 否 String 键值规则模板，键值规则为VARIABLE时必填 表11 SmnTargetDetail 参数 是否必选 参数类型 描述 urn 是 String 主题urn agency_name 是 String 委托名称 subject_transform 否 subject_transform object 标题规则 表12 subject_transform 参数 是否必选 参数类型 描述 type 是 String 标题规则类型 枚举值： VARIABLE CONSTANT value 是 String 标题规则 template 否 String 标题规则模板，键值规则为VARIABLE时必填 表13 TransForm 参数 是否必选 参数类型 描述 type 是 String 转换规则类型 枚举值： ORIGINAL CONSTANT VARIABLE value 否 String 常量类型规则时，字段为常量内容定义； 变量类型规则时，为变量定义，内容必须为JsonObject字符串。 变量最多支持100个，且不支持嵌套结构定义； 变量名由字母、数字、点、下划线和中划线组成，必须字母或数字开头不能以HC.开头，长度不超过64个字符； 变量值表达式支持常量或JsonPath表达式，字符串长度不超过1024个字符。 最大长度：1024 template 否 String 变量类型规则时，规则内容的模板定义，支持对已定义变量的引用。 最大长度：2048 表14 DeadLetterQueue 参数 是否必选 参数类型 描述 type 是 String 队列类型 枚举值： KAFKA instance_id 是 String 实例id 最小长度：1 最大长度：128 connection_id 是 String 目标连接id 最小长度：1 最大长度：128 topic 是 String 主题 最小长度：1 最大长度：128

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128

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

响应参数 状态码： 400 表3 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 401 表4 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 403 表5 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 404 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 500 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128

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

响应参数 状态码： 200 表1 响应Body参数 参数 参数类型 描述 versions Array of versions objects 版本定义 表2 versions 参数 参数类型 描述 id String 版本号，如v1 links Array of links objects url地址 version String 若该版本API支持微版本，则为支持的最大微版本号，如果不支持微版本，则为空 min_version String 若该版本API支持微版本，则为支持的最小微版本号，如果不支持微版本，则为空 status String 版本状态，支持CURRENT：推荐版本；SUPPORTED：老版本，仍支持使用；DEPRECATED：废弃版本，后续会删除 枚举值： CURRENT SUPPORTED DEPRECATED updated String 版本发布UTC时间 表3 links 参数 参数类型 描述 href String href属性 rel String rel属性

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 最小值：0 最大值：100 size Integer 本页数量 最小值：0 最大值：100 items Array of ChannelInfo objects 对象列表 数组长度：0 - 100 表5 ChannelInfo 参数 参数类型 描述 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 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128

URI GET /v1/{project_id}/channels 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询，偏移量不能小于0 最小值：0 最大值：100 缺省值：0 limit 否 Integer 每页显示的条目数量，不能小于1或大于1000 最小值：1 最大值：1000 缺省值：15 sort 否 String 指定查询排序 缺省值：created_time:DESC provider_type 否 String 指定查询提供方的类型 枚举值： OFFICIAL CUSTOM PARTNER name 否 String 指定查询的事件通道名称，精准匹配 fuzzy_name 否 String 指定查询的事件通道名称，模糊匹配 eps_id 否 String 指定查询的企业项目id，精确匹配

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 最小值：0 最大值：100 size Integer 本页数量 最小值：0 最大值：100 items Array of CustomizeSourceInfo objects 对象列表 数组长度：0 - 100 表5 CustomizeSourceInfo 参数 参数类型 描述 id String 事件源ID name String 事件源名称 label String 事件源名称展示 description String 事件源描述 provider_type String 事件源提供方类型，OFFICIAL：官方云服务事件源；CUSTOM：用户创建的自定义事件源；PARTNER：伙伴事件源 枚举值： OFFICIAL CUSTOM PARTNER event_types Array of event_types objects 事件源提供的事件类型列表，只有官方云服务事件源提供事件类型 created_time String 创建UTC时间 updated_time String 更新UTC时间 channel_id String 事件源归属的事件通道ID channel_name String 事件源归属的事件通道名称 type String 事件源类型 detail Object json格式封装消息实例链接信息：如RabbitMQ实例的instance_id字段、 虚拟主机 vhost字段、队列queue字段、用户名、密码等 status String 自定义事件源状态 枚举值： CREATE_FAILED RUNNING ERROR error_info ErrorInfo object 表6 event_types 参数 参数类型 描述 name String 事件类型名称 description String 事件类型描述 表7 ErrorInfo 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_detail String 错误详情 最小长度：1 最大长度：128 error_msg String 错误信息 最小长度：1 最大长度：128 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128

URI GET /v1/{project_id}/sources 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID 表2 Query参数 参数 是否必选 参数类型 描述 channel_id 否 String 指定查询的事件通道ID offset 否 Integer 偏移量，表示从此偏移量开始查询，偏移量不能小于0 最小值：0 最大值：100 缺省值：0 limit 否 Integer 每页显示的条目数量，不能小于1或大于1000 最小值：1 最大值：1000 缺省值：15 sort 否 String 指定查询排序 缺省值：created_time:DESC provider_type 否 String 指定查询提供方的类型 枚举值： OFFICIAL CUSTOM PARTNER name 否 String 指定查询的事件源名称，精准匹配 fuzzy_name 否 String 指定查询的事件源名称，模糊匹配 fuzzy_label 否 String 指定查询的事件源标签，模糊匹配

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 EG.00513000 invalid parameters 参数错误 请检查参数是否正确 400 EG.00513001 name duplicated 命名重复 请重新输入新名称 400 EG.00513002 invalid subscription status 启动中的订阅不能编辑 请稍后重试 400 EG.00513003 invalid target address 自定义事件目标url参数错误 请检查事件目标url参数 400 EG.00513004 invalid filter parameters 事件源过滤规则配置参数错误 请检查事件源过滤规则配置参数是否正确 400 EG.00513005 invalid channel 事件通道不可用 请重新选择事件通道 400 EG.00513006 vpc CONFLICT 该VPC已创建内网访问端点 请无需重复创建 400 EGS.00516010 压缩包格式错误，非ZIP格式。 压缩包格式错误，非ZIP格式。 请检查压缩包格式是否正确 400 EGS.00516011 证书下载地址错误。 证书下载地址错误。 请检查证书下载地址 400 EGS.00516012 下载OBS文件失败。 下载OBS文件失败。 请联系管理员 400 EGS.00516013 文件上传OBS失败。 文件上传OBS失败。 请联系管理员 400 EGS.00516015 OBS桶创建失败。 OBS桶创建失败。 请联系管理员 400 EGS.00516016 压缩包中找不到证书文件。 压缩包中找不到证书文件。 请检查压缩包内容，确保证书文件存在 400 EGS.00516017 文件个数超过最大限制。 文件个数超过最大限制。 请检查压缩包内文件个数 400 EGS.00516018 文件大小超过最大限制。 文件大小超过最大限制。 请检查压缩包内文件大小 403 EG.00512000 no permission to operate 无操作权限 请联系管理员 403 EG.00512001 the account is frozen，operation is not permitted 账户冻结，操作受限 请充值或联系管理员解除冻结 403 EG.00512002 agency permission required 当前账号没有创建委托的权限 请联系您的管理员为您开通创建委托的权限 403 EG.00512003 agency required 所需的委托不存在 请先创建委托 403 EG.00514003 resource quota unavailable 资源配额不足 请扩大资源配额 403 EG.00514004 resource not modified 资源不允许修改 由其他服务创建的资源，不允许修改 404 EG.00514001 resource not found 资源不存在 请联系管理员 409 EG.00514002 resource conflict 资源已与其他资源绑定，删除时存在冲突 请先删除该资源绑定的其他资源 409 EG.00514005 resource can not be deleted 目标连接正在创建中，不支持删除 请稍后重试 500 EG.00511000 internal server error 内部服务错误 请联系管理员 500 EG.00515001 resource not found 事件发布时资源不存在 请联系管理员 503 EG.00511001 service unavailable 服务不可用 请联系管理员 父主题： 附录

URI GET /v1/{project_id}/schemas/{schema_id}/versions 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户项目ID schema_id 是 String 指定查询的事件模型ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询，偏移量不能小于0 最小值：0 最大值：100 缺省值：0 limit 否 Integer 每页显示的条目数量，不能小于1或大于1000 最小值：1 最大值：1000 缺省值：15 sort 否 String 指定查询排序 缺省值：created_time:DESC version 否 String 指定查询的事件模型版本号

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

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 最小值：0 最大值：100 size Integer 本页数量 最小值：0 最大值：100 items Array of CustomizeSchemaVersionItemInfo objects 对象列表 数组长度：0 - 100 表5 CustomizeSchemaVersionItemInfo 参数 参数类型 描述 id String 事件模型版本ID version Integer 事件模型版本号 created_time String 创建时间 updated_time String 更新时间 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128