基本概念 账号 用户注册账号时，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户进行日常管理工作。 用户 由账号在 IAM 中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域：指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。 可用区：一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中创建资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下，您可以查看项目ID。 企业项目 企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目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 表3 响应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 更新时间 表4 TransForm 参数 参数类型 描述 type String 转换规则类型 枚举值： ORIGINAL CONSTANT VARIABLE value String 常量类型规则时，字段为常量内容定义； 变量类型规则时，为变量定义，内容必须为JsonObject字符串。 变量最多支持100个，且不支持嵌套结构定义； 变量名由字母、数字、点、下划线和中划线组成，必须字母或数字开头不能以HC.开头，长度不超过64个字符； 变量值表达式支持常量或JsonPath表达式，字符串长度不超过1024个字符。 最大长度：1024 template String 变量类型规则时，规则内容的模板定义，支持对已定义变量的引用。 最大长度：2048 表5 DeadLetterQueue 参数 参数类型 描述 type String 队列类型 枚举值： KAFKA instance_id String 实例id 最小长度：1 最大长度：128 connection_id String 目标连接id 最小长度：1 最大长度：128 topic String 主题 最小长度：1 最大长度：128 状态码： 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

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

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：16384 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 订阅描述 最大长度：255 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

URI GET /v1/{project_id}/samples 表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 name 否 String 指定查询的事件示例名称，模糊匹配 event_type_name 否 String 指定查询事件示例的事件类型名称 event_source_id 否 String 指定查询事件示例的事件源

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 最小值：0 size Integer 本页数量 最小值：0 最大值：100 items Array of EventSampleItemInfo objects 对象列表 数组长度：0 - 100 表5 EventSampleItemInfo 参数 参数类型 描述 id String 事件示例ID name String 事件示例名称 content String 事件示例内容 event_type_id String 事件示例对应的事件类型ID event_type_name String 事件示例对应的事件类型名称 event_source_id String 事件示例对应的事件源ID event_source_name String 事件示例对应的事件源名称 created_time String 创建时间 updated_time String 更新时间 deleted_time 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 表3 响应Header参数 参数 参数类型 描述 X-Request-Id String This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. 表4 响应Body参数 参数 参数类型 描述 name String 事件流名称，租户下唯一，由字母、数字、点、下划线和中划线组成，必须字母或数字开头 最小长度：1 最大长度：128 description String 事件流描述 最大长度：255 source EventStreamingSource object 事件源，一个事件流中事件源只有一个 sink EventStreamingSink object 事件目标，一个事件流中只有一个 rule_config rule_config object 事件规则，包括过滤规则和转换规则 option RunOption object 运行时配置信息 status String 事件流状态 最小长度：1 最大长度：128 枚举值： CREATED RUNNING ERROR STOPPED id String 事件流ID created_time String 创建时间 updated_time String 更新时间 表5 EventStreamingSource 参数 参数类型 描述 source_kafka SourceKafkaMQParameters object 华为云DMS版kafka类型事件源 source_mobile_rocketmq SourceMobileMQParameters object 移动云版rocketMQ类型事件源 source_community_rocketmq SourceCommunityMQParameters object 社区版rocketMQ类型事件源 source_dms_rocketmq SourceDMSMQParameters object 华为云DMS版rocketMQ事件源 name String 事件源类型名称 枚举值： HC.Kafka HC.COMMUNITY_ROCKETMQ HC.DMS_ROCKETMQ HC.MOBILE_ROCKETMQ 表6 SourceKafkaMQParameters 参数 参数类型 描述 addr String kafka连接地址 group String kafka消费组 最小长度：1 最大长度：256 instance_name String kafka实例名称 最小长度：4 最大长度：64 security_protocol String 安全协议 instance_id String kafka实例ID 最小长度：1 最大长度：256 topic String kafka topic名称 最小长度：3 最大长度：200 seek_to String 消费点位 枚举值： latest earliest enable_sasl_ssl Boolean SASL_SSL是否开启 sasl_mechanism String SASL认证机制 枚举值： SC RAM -SHA-512 PLAIN ssl_certificate_url String SASL证书地址，配置的obs地址 最小长度：1 最大长度：512 ssl_certificate_pwd String SASL证书密码 最小长度：1 最大长度：256 user_name String 用户名 最小长度：1 最大长度：256 password String 用户密码 最小长度：1 最大长度：256 表7 SourceMobileMQParameters 参数 参数类型 描述 group_id String 消费组id 最小长度：3 最大长度：128 instance_id String 实例id 最小长度：3 最大长度：128 topic String topic 最小长度：3 最大长度：128 tag String 标签 最大长度：128 authentication_required Boolean 鉴权认证 msg_trace_switch Boolean 保存消息轨迹 access_key String AccessKey 最大长度：128 secret_key String SecretKey 最大长度：128 message_model String 订阅方式 缺省值：CLUSTERING 枚举值： CLUSTERING BROADCASTING addr_type String 接入点类型 缺省值：PUBLIC 枚举值： PUBLIC PRIVATE addr String 地址 最大长度：256 sdk_url String 依赖SDK 最大长度：256 consume_timeout Integer 消费超时时间 最小值：1000 最大值：900000 缺省值：30000 message_type String 消息类型 枚举值： NORMAL suspend_time Integer 失败重试的等待时间 最小值：10 最大值：1800 缺省值：1800 max_reconsumer_times Integer 最大重试次数 最小值：1 最大值：16 缺省值：3 consumer_thread_nums Integer 消费线程数 最小值：20 最大值：64 缺省值：20 consumer_batch_max_size Integer 批量消费最大消息数 最小值：1 最大值：1024 缺省值：20 consumer_max_wait Integer 批量消费最大等待时长，单位：秒 最小值：0 最大值：450 缺省值：5 vpc_id String 虚拟私有云 subnet_id String 子网 表8 SourceCommunityMQParameters 参数 参数类型 描述 instance_name String 实例名称，仅dms的rockectMq需要该字段 最大长度：128 instance_id String 实例ID，仅dms的rockectMq需要该字段 最大长度：128 addr String rockectMq连接地址 group String 消费组 最小长度：3 最大长度：64 topic String topic名称 最小长度：3 最大长度：64 tag String 标签 最大长度：128 vpc_id String 虚拟云id 最大长度：256 subnet_id String 子网id 最大长度：256 ssl_enable Boolean 开启SSL enable_acl Boolean ACL访问控制 access_key String 用户名 最大长度：128 secret_key String 密码 message_type String 消息类型 枚举值： normal consume_timeout Integer 消费超时时间 最小值：1000 最大值：900000 缺省值：30000 consumer_thread_nums Integer 线程消费数 最小值：20 最大值：64 缺省值：20 consumer_batch_max_size Integer 批量消费最大消息数 最小值：1 最大值：32 缺省值：1 表9 SourceDMSMQParameters 参数 参数类型 描述 instance_name String 实例名称，仅dms的rockectMq需要该字段 最大长度：128 instance_id String 实例ID，仅dms的rockectMq需要该字段 最大长度：128 group String 消费组 最小长度：3 最大长度：64 topic String topic名称 最小长度：3 最大长度：64 tag String 标签 最大长度：128 ssl_enable Boolean 开启SSL enable_acl Boolean ACL访问控制 access_key String 用户名 最大长度：128 secret_key String 密码 message_type String 消费方式，针对不同生产顺序消息类型，选择消费方式会导致不同结果，请严格按照需求选择消费方式。1、生产顺序为：设置消息组，保证消息顺序发送。消费方式为：顺序消费，实际消息处理结果：按照消息组粒度，严格保证消息顺序。 同一消息组内的消息的消费顺序和发送顺序完全一致。2、生产顺序为：设置消息组，保证消息顺序发送。消费方式为：并发消费，实际消息处理结果：并发消费，尽可能按时间顺序处理。3、生产顺序为：未设置消息组，消息乱序发送。消费方式为：顺序消费，实际消息处理结果：按队列存储粒度，严格顺序。 基于 Apache RocketMQ 本身队列的属性，消费顺序和队列存储的顺序一致，但不保证和发送顺序一致。4、生产顺序为：未设置消息组，消息乱序发送。消费方式为：并发消费，实际消息处理结果：并发消费，尽可能按照时间顺序处理。 枚举值： NORMAL ORDER engine_version String mq实例版本 枚举值： 4.x 5.x consume_timeout Integer 消费超时时间 最小值：1000 最大值：900000 缺省值：30000 consumer_thread_nums Integer 线程消费数 最小值：20 最大值：64 缺省值：20 consumer_batch_max_size Integer 批量消费最大消息数 最小值：1 最大值：32 缺省值：1 表10 EventStreamingSink 参数 参数类型 描述 sink_fg SinkFGParameters object 函数目标参数 sink_kafka SinkKafkaParameters object kafka目标参数 name String 事件目标类型名称 枚举值： HC.FunctionGraph HC.Kafka 表11 SinkFGParameters 参数 参数类型 描述 invoke_type String 函数执行方式,同步/异步 枚举值： SYNC，ASYNC urn String 函数链接 最小长度：1 最大长度：512 agency String 租户委托 表12 SinkKafkaParameters 参数 参数类型 描述 topic String topic名称 keyTransform Array of TransForm objects key的转换规则 connectionId String 目标连接id 表13 TransForm 参数 参数类型 描述 type String 转换规则类型 枚举值： ORIGINAL CONSTANT VARIABLE value String 常量类型规则时，字段为常量内容定义； 变量类型规则时，为变量定义，内容必须为JsonObject字符串。 变量最多支持100个，且不支持嵌套结构定义； 变量名由字母、数字、点、下划线和中划线组成，必须字母或数字开头不能以HC.开头，长度不超过64个字符； 变量值表达式支持常量或JsonPath表达式，字符串长度不超过1024个字符。 最大长度：1024 template String 变量类型规则时，规则内容的模板定义，支持对已定义变量的引用。 最大长度：2048 表14 rule_config 参数 参数类型 描述 transform TransForm object 转换规则 filter Object 过滤规则 表15 RunOption 参数 参数类型 描述 thread_num Integer 并发数 最小值：1 最大值：1000 batch_window BatchWindow object 批量推送 表16 BatchWindow 参数 参数类型 描述 count Integer 批量推送条数 最小值：1 最大值：10000 缺省值：1 time Integer 重试次数 最小值：0 最大值：15 缺省值：3 interval Integer 批量推送间隔，单位秒 最小值：0 最大值：15 缺省值：0 状态码： 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

请求示例 { "channel_id" : "635d6fc4-8b3e-4c3a-9604-5e4e9c98ea2e", "description" : null, "name" : "test", "type" : "RABBITMQ", "detail" : { "instance_id" : "ac14144e-9v3c-43d6-acfd-bf09b52c98uy", "user_name" : "user_name", "password" : "password", "vhost_name" : "vhost_name", "queue_name" : "queue_name" }}

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：16384 表3 请求Body参数 参数 是否必选 参数类型 描述 description 否 String 事件源描述 最大长度：255 detail 否 RocketMqDetail object json格式封装消息实例更新信息 表4 RocketMqDetail 参数 是否必选 参数类型 描述 instance_id 否 String RocketMQ实例ID group 是 String 消费组 topic 是 String Topic access_key 是 String 用户名 secret_key 是 String 密钥 vpc_id 否 String 虚拟私有云 subnet_id 否 String 子网 namesrv_address 否 String 连接地址 ssl_enable 否 Boolean SSL enable_acl 否 Boolean ACL访问控制

响应参数 状态码： 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 事件源名称 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 表7 event_types 参数 参数类型 描述 name String 事件类型名称 description String 事件类型描述 表8 ErrorInfo 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_detail String 错误详情 最小长度：1 最大长度：128 error_msg String 错误信息 最小长度：1 最大长度：128 状态码： 400 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 401 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 403 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 404 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 500 表13 响应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参数 参数 是否必选 参数类型 描述 description 否 String 事件模型描述 最大长度：255 compatibility 否 String 事件模型兼容性 枚举值： NONE