华为云用户手册

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

URI GET /v1/{project_id}/eventstreamings 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户资源空间ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询，偏移量不能小于0 limit 否 Integer 每页显示的条目数量，不能小于1或大于1000

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 size Integer 本页数量 items Array of CustomizeSourceInfo objects 对象列表 表5 CustomizeSourceInfo 参数 参数类型 描述 id String 事件源ID name String 事件源名称 label String 事件源名称展示 description String 事件源描述 provider_type String 事件源提供方类型，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 自定义事件源状态 error_info ErrorInfo object 错误信息 表6 event_types 参数 参数类型 描述 name String 事件类型名称 description String 事件类型描述 表7 ErrorInfo 参数 参数类型 描述 error_code String 错误码 error_detail String 错误详情 error_msg String 错误信息

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

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 size Integer 本页数量 items Array of CustomizeSchemaVersionItemInfo objects 对象列表 表5 CustomizeSchemaVersionItemInfo 参数 参数类型 描述 id String 事件模型版本ID version Integer 事件模型版本号 created_time String 创建时间 updated_time String 更新时间

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

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 size Integer 本页数量 items Array of CustomizeSchemaItemInfo objects 对象列表 表5 CustomizeSchemaItemInfo 参数 参数类型 描述 id String 事件模型ID name String 事件模型名称，租户下唯一 description String 事件模型描述 compatibility String 事件模型兼容性 provider_type String 提供方类型，OFFICIAL：官方事件源；CUSTOM：自定义事件源 format String 事件模型格式 number_of_versions Integer 事件模型版本数 event_type_id String 事件类型ID event_type_name String 事件类型名称 event_source_id String 事件源ID event_source_name String 事件源名称 event_source_label String 事件源标签 created_time String 创建时间 updated_time String 更新时间

URI GET /v1/{project_id}/schemas 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户资源空间ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询，偏移量不能小于0 limit 否 Integer 每页显示的条目数量，不能小于1或大于1000 sort 否 String 指定查询排序 provider_type 否 String 指定查询提供方的类型 name 否 String 指定查询的事件模型名称，精准匹配 fuzzy_name 否 String 指定查询的事件模型名称，模糊匹配

响应示例 状态码：200 请求成功 { "size" : 1, "total" : 1, "items" : [ { "cluster_id" : "fac59513-6c18-4266-bc81-5d412dfc1925", "name" : "cluster-ifpcv5u4", "description" : null, "source_type" : "KAFKA", "sink_type" : "KAFKA", "status" : "RUNNING", "job_count" : 1, "err_code" : null, "err_message" : null, "created_time" : "2024-05-16T11:46:07Z", "updated_time" : "2024-05-16T11:46:07Z", "vpc_id" : "199f632d-34e7-4915-b4d8-1bc4e2824867", "subnet_id" : "0d1799e1-116e-4551-92dc-02dd8a860072", "zone_names" : "az0" } ] }

响应参数 状态码：200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求ID 表5 响应Body参数 参数 参数类型 描述 total Integer 总数 size Integer 本页数量 items Array of EventRouterClusterInfo objects 对象列表 表6 EventRouterClusterInfo 参数 参数类型 描述 cluster_id String 专业版事件流集群ID name String 集群名称。约束：集群名称由大小英文字母、数字、点、中划线和下划线组成，必须以大小英文字母或数字开头，最多128个字符。 description String 集群描述，约束：集群描述不能超过256位。 source_type String 源端类型 sink_type String 目标端类型 subnet_id String 子网ID vpc_id String 虚拟私有云ID zone_names String 可用区名称 status String 作业状态 job_count Number 当前集群下作业数量 flavor String 规格 charging_mode String 计费模式 err_code String 错误码 err_message String 错误原因 created_time String 创建UTC时间 updated_time String 更新UTC时间

响应参数 状态码：200 表4 响应Header参数 参数 参数类型 描述 X-Request-Id String This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. 表5 响应Body参数 参数 参数类型 描述 total Integer 总数 size Integer 本页数量 items Array of EndpointInfo objects 对象列表 表6 EndpointInfo 参数 参数类型 描述 id String 访问端点ID name String 用户指定的访问端点名称 vpc_id String 访问端点所在的VPC的ID subnet_id String 访问端点所在的子网的ID domain String 访问 域名 description String 描述 status String 访问端点状态 error_info ErrorInfo object 错误信息 type String 访问端点类型 scalable Boolean 是否可更新 created_time String 创建UTC时间 updated_time String 更新UTC时间 endpoints Array of EndpointConnection objects 访问端点终端节点列表 表7 ErrorInfo 参数 参数类型 描述 error_code String 错误码 error_detail String 错误详情 error_msg String 错误信息 表8 EndpointConnection 参数 参数类型 描述 endpoint_service_id String 访问端点的服务ID endpoint_service_name String 访问端点的服务名称 marker_id String 访问端点的终端节点的报文ID id String 访问端点的终端节点ID ip String 访问端点的终端节点IP created_time String 访问端点的终端节点创建时间

URI GET /v1/{project_id}/endpoints 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户资源空间ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询，偏移量不能小于0 limit 否 Integer 每页显示的条目数量，不能小于1或大于1000 sort 否 String 指定查询排序 type 否 String 指定查询访问端点的类型 name 否 String 指定查询访问端点的名称 vpc_id 否 String 指定查询访问端点的vpcId fuzzy_name 否 String 指定查询访问端点的名称,模糊查询 subnet_id 否 String 指定查询访问端点的SubnetId

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

URI GET /v1/{project_id}/connections 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户资源空间ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询，偏移量不能小于0 limit 否 Integer 每页显示的条目数量，不能小于1或大于1000 sort 否 String 指定查询排序 name 否 String 指定查询的目标连接名称，精准匹配 fuzzy_name 否 String 指定查询的目标连接名称，模糊匹配 instance_id 否 String 指定查询的目标连接，队列的实例id

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 size Integer 本页数量 items Array of ChannelInfo objects 对象列表 表5 ChannelInfo 参数 参数类型 描述 id String 通道ID name String 通道名称 description String 通道描述 provider_type String 通道提供方类型，OFFICIAL：官方事件通道；CUSTOM：自定义事件通道；PARTNER：伙伴事件通道 created_time String 创建UTC时间 updated_time String 更新UTC时间 enterprise_project_id String 企业项目id

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

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表4 请求Body参数 参数 是否必选 参数类型 描述 subscription_ids 否 Array of strings 订阅对象ID列表，单次批量操作最多支持10个订阅 operation 否 String 操作类型

响应参数 状态码：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参数 参数 参数类型 描述 failed_count Integer 操作失败的订阅个数 events Array of events objects 事件列表 表7 events 参数 参数类型 描述 error_code String 失败的错误码 error_msg String 失败的原因 subscription_id String 订阅ID

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 operation 是 String 操作类型 config 否 OperateConfig object 操作的额外参数 表4 OperateConfig 参数 是否必选 参数类型 描述 switch_now 否 Boolean 是否立即切换，默认false sink_address 否 String 期望切换后的目标IP地址，多个IP地址用","分隔；如果匹配当前作业的源端地址，则发生倒换；如果匹配当前作业的目标端地址，则不发生倒换；否则报错

错误码 当您调用API时，如果遇到“APIGW”开头的错误码，请参见API网关错误码进行处理。 状态码 错误码 错误信息 描述 处理措施 400 EG.00513000 Parameter error 参数错误 检查请求body体中参数 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 Must be in ZIP format. 压缩包格式错误，非ZIP格式。 请检查压缩包格式是否正确 400 EGS.00516011 Invalid download URL. 证书下载地址错误。 请检查证书下载地址 400 EGS.00516012 Download OBS file failed. 下载OBS文件失败。 请联系管理员 400 EGS.00516013 Upload file to OBS failed. 文件上传OBS失败。 请联系管理员 400 EGS.00516015 Create OBS bucket failed. OBS桶创建失败。 请联系管理员 400 EGS.00516016 The certificate does not exist in the compressed package. 压缩包中找不到证书文件。 请检查压缩包内容，确保证书文件存在 400 EGS.00516017 Too many files. 文件个数超过最大限制。 请检查压缩包内文件个数 400 EGS.00516018 File too large. 文件大小超过最大限制。 请检查压缩包内文件大小 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 服务不可用 请联系管理员 父主题： 附录

响应参数 状态码：200 表3 响应Body参数 参数 参数类型 描述 total Integer 总数 size Integer 本页数量 items Array of CustomizeSchemaItemInfo objects 对象列表 表4 CustomizeSchemaItemInfo 参数 参数类型 描述 id String 事件模型ID name String 事件模型名称，租户下唯一 description String 事件模型描述 compatibility String 事件模型兼容性 provider_type String 提供方类型，OFFICIAL：官方事件源；CUSTOM：自定义事件源 format String 事件模型格式 number_of_versions Integer 事件模型版本数 event_type_id String 事件类型ID event_type_name String 事件类型名称 event_source_id String 事件源ID event_source_name String 事件源名称 event_source_label String 事件源标签 created_time String 创建时间 updated_time String 更新时间

URI DELETE /v1/{project_id}/subscriptions/{subscription_id}/targets/{target_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户资源空间ID subscription_id 是 String 事件订阅ID target_id 是 String 事件订阅目标ID 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 创建订阅时所使用的企业项目id

URI DELETE /v1/{project_id}/subscriptions/{subscription_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户资源空间ID subscription_id 是 String 事件订阅ID 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 创建订阅时所使用的企业项目id

响应示例 状态码：200 Information { "id" : "3a0eeff2-78a4-4122-dfge-7ty5e37f64er", "name" : "WEBHOOK", "provider_type" : "CUSTOM", "connection_id" : "456eekj3-778u-4tyu-dfrt-er55e37f667t", "detail" : { "url" : "http://10.213.96.90:8080/t/nodeapp/trigger-hello-nodejs" }, "kafka_detail" : { }, "smn_detail" : { }, "eg_detail" : { }, "apigw_detail" : { }, "retry_times" : 16, "transform" : { }, "dead_letter_queue" : { }, "created_time" : "2021-12-09 09:00:00", "updated_time" : "2021-12-09 09:00:00" }

请求示例 创建单个事件订阅目标 POST https://{endpoint}/v1/{project_id}/subscriptions/{subscription_id}/targets { "connection_id" : "456eekj3-778u-4tyu-dfrt-er55e37f667t", "detail" : { "agency_name" : "EG_TARGET_AGENCY", "invoke_type" : "ASYNC", "url" : "http://10.213.96.90:8080/t/nodeapp/trigger-hello-nodejs", "urn" : "urn:fss:cn-north-7:bac852160cc743158936edaab6dda813:function:default:gxtestjava:latest", "workflow_id" : "86afc904-0019-46c8-baed-0225967c1b98" }, "id" : "3a0eeff2-78a4-4122-dfge-7ty5e37f64er", "name" : "WEBHOOK", "provider_type" : "CUSTOM", "retry_times" : 16, "transform" : { "type" : "VARIABLE" } }

响应参数 状态码：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 订阅的事件目标名称 provider_type String 订阅的事件目标的提供方类型 connection_id String 订阅的事件目标使用的目标链接ID detail Object 订阅的事件目标参数列表 kafka_detail KafkaTargetDetail object 订阅的kafka事件目标参数列表，该字段序列化后总长度不超过1024字节 smn_detail SmnTargetDetail object 订阅的 SMN 事件目标参数列表，该字段序列化后总长度不超过1024字节 eg_detail EgTargetDetail object 订阅的事件eg通道目标参数列表，该字段序列化后总长度不超过1024字节，eg通道目标必填 apigw_detail ApigwTargetDetail object 订阅的事件APIGWurl目标参数列表，该字段序列化后总长度不超过1024字节，APIGW目标必填 retry_times Integer 重试次数 transform TransForm object 订阅的事件目标转换规则 dead_letter_queue DeadLetterQueue object 订阅的死信参数列表 created_time String 创建时间 updated_time String 更新时间 表17 KafkaTargetDetail 参数 参数类型 描述 topic String 主题 keyTransform keyTransform object 键值规则 表18 keyTransform 参数 参数类型 描述 type String 键值规则类型 value String 键值规则，键值规则为VARIABLE，CONSTANT时必填 template String 键值规则模板，键值规则为VARIABLE时必填 表19 SmnTargetDetail 参数 参数类型 描述 urn String 主题urn agency_name String 委托名称 subject_transform subject_transform object 标题规则 表20 subject_transform 参数 参数类型 描述 type String 标题规则类型 value String 标题规则 template String 标题规则模板，键值规则为VARIABLE时必填 表21 EgTargetDetail 参数 参数类型 描述 target_project_id String 目标项目id target_channel_id String 目标通道id target_region String 目标region cross_region Boolean 跨region开关 cross_account Boolean 跨账号开关 agency_name String 委托名称 表22 ApigwTargetDetail 参数 参数类型 描述 url String 目标url invocation_http_parameters InvocationHttpParameters object 调用Http的参数 表23 InvocationHttpParameters 参数 参数类型 描述 header_parameters Array of HeaderParameter objects 对象列表 表24 HeaderParameter 参数 参数类型 描述 is_value_secret Boolean 是否加密 key String header的key值 value String deader的value值 表25 TransForm 参数 参数类型 描述 type String 转换规则类型 value String 常量类型规则时，字段为常量内容定义； 变量类型规则时，为变量定义，内容必须为JsonObject字符串。 变量最多支持100个，且不支持嵌套结构定义； 变量名由字母、数字、点、下划线和中划线组成，必须字母或数字开头不能以HC.开头，长度不超过64个字符； 变量值表达式支持常量或JsonPath表达式，字符串长度不超过1024个字符。 template String 变量类型规则时，规则内容的模板定义，支持对已定义变量的引用。 表26 DeadLetterQueue 参数 参数类型 描述 type String 队列类型 instance_id String 实例id connection_id String 目标连接id topic String 主题

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表4 请求Body参数 参数 是否必选 参数类型 描述 id 否 String 订阅目标ID，需保证全局唯一，由小写字母、数字、中划线组成，必须字母或数字开头。 更新订阅场景时，指定ID的订阅目标存在时则进行更新，否则进行创建； 创建订阅目标场景时，指定ID作为待创建的订阅目标对象ID，未指定时由系统自动生成。 更新订阅目标时，此字段忽略； name 是 String 订阅的事件目标名称 provider_type 是 String 订阅的事件目标的提供方类型 connection_id 否 String 订阅的事件目标使用的目标链接ID detail 否 Object 订阅的事件目标参数列表，该字段序列化后总长度不超过1024字节，函数(urn、invoke_type、agency_name)、函数流（workflow_id、agency_name）、webhook（url）订阅目标必填，其中函数、函数流委托名称必填 kafka_detail 否 KafkaTargetDetail object 订阅的kafka事件目标参数列表，该字段序列化后总长度不超过1024字节 smn_detail 否 SmnTargetDetail object 订阅的SMN事件目标参数列表，该字段序列化后总长度不超过1024字节 eg_detail 否 EgTargetDetail object 订阅的事件eg通道目标参数列表，该字段序列化后总长度不超过1024字节，eg通道目标必填 apigw_detail 否 ApigwTargetDetail object 订阅的事件APIGWurl目标参数列表，该字段序列化后总长度不超过1024字节，APIGW目标必填 retry_times 否 Integer 重试次数 transform 是 TransForm object 订阅的事件目标转换规则 dead_letter_queue 否 DeadLetterQueue object 订阅的死信参数列表 表5 KafkaTargetDetail 参数 是否必选 参数类型 描述 topic 是 String 主题 keyTransform 否 keyTransform object 键值规则 表6 keyTransform 参数 是否必选 参数类型 描述 type 否 String 键值规则类型 value 否 String 键值规则，键值规则为VARIABLE，CONSTANT时必填 template 否 String 键值规则模板，键值规则为VARIABLE时必填 表7 SmnTargetDetail 参数 是否必选 参数类型 描述 urn 是 String 主题urn agency_name 是 String 委托名称 subject_transform 否 subject_transform object 标题规则 表8 subject_transform 参数 是否必选 参数类型 描述 type 是 String 标题规则类型 value 是 String 标题规则 template 否 String 标题规则模板，键值规则为VARIABLE时必填 表9 EgTargetDetail 参数 是否必选 参数类型 描述 target_project_id 是 String 目标项目id target_channel_id 是 String 目标通道id target_region 是 String 目标region cross_region 否 Boolean 跨region开关 cross_account 否 Boolean 跨账号开关 agency_name 是 String 委托名称 表10 ApigwTargetDetail 参数 是否必选 参数类型 描述 url 是 String 目标url invocation_http_parameters 否 InvocationHttpParameters object 调用Http的参数 表11 InvocationHttpParameters 参数 是否必选 参数类型 描述 header_parameters 否 Array of HeaderParameter objects 对象列表 表12 HeaderParameter 参数 是否必选 参数类型 描述 is_value_secret 否 Boolean 是否加密 key 否 String header的key值 value 否 String deader的value值 表13 TransForm 参数 是否必选 参数类型 描述 type 是 String 转换规则类型 value 否 String 常量类型规则时，字段为常量内容定义； 变量类型规则时，为变量定义，内容必须为JsonObject字符串。 变量最多支持100个，且不支持嵌套结构定义； 变量名由字母、数字、点、下划线和中划线组成，必须字母或数字开头不能以HC.开头，长度不超过64个字符； 变量值表达式支持常量或JsonPath表达式，字符串长度不超过1024个字符。 template 否 String 变量类型规则时，规则内容的模板定义，支持对已定义变量的引用。 表14 DeadLetterQueue 参数 是否必选 参数类型 描述 type 是 String 队列类型 instance_id 是 String 实例id connection_id 是 String 目标连接id topic 是 String 主题

URI POST /v1/{project_id}/subscriptions/{subscription_id}/targets 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户资源空间ID subscription_id 是 String 事件订阅ID 表2 Query参数 参数 是否必选 参数类型 描述 enterprise_project_id 否 String 创建订阅时所使用的企业项目id

请求示例 创建名为test-subscription的事件订阅 POST https://{endpoint}/v1/{project_id}/subscriptions { "name" : "test-subscription", "description" : "this is a test subscription", "channel_id" : "05649f9a-b324-4920-9c49-156d4cd2e546", "sources" : [ { "id" : "3a0eeff2-78a4-4122-dfge-7ty5e37f64er", "name" : "HC.OBS", "provider_type" : "OFFICIAL", "detail" : { "name" : "name" }, "filter" : { "data" : { "count" : [ { "op" : "NumberIn", "values" : [ 1, 2 ] } ] } } } ], "targets" : [ { "id" : "3a0eeff2-78a4-4122-dfge-7ty5e37f64er", "name" : "WEBHOOK", "provider_type" : "CUSTOM", "connection_id" : "456eekj3-778u-4tyu-dfrt-er55e37f667t", "detail" : { "url" : "http://10.213.96.90:8080/t/nodeapp/trigger-hello-nodejs", "agency_name" : "EG_TARGET_AGENCY", "urn" : "urn:fss:cn-north-7:bac852160cc743158936edaab6dda813:function:default:gxtestjava:latest", "invoke_type" : "ASYNC", "workflow_id" : "86afc904-0019-46c8-baed-0225967c1b98" }, "kafka_detail" : { "topic" : "8516d278-268a-4a8b-8766-9bf9b3302f43", "keyTransform" : { "type" : "NONE", "value" : "string", "template" : "string" } }, "smn_detail" : { "urn" : "urn:smn:cn-north-7:bac852160cc743158936edaab6dda813:122", "agency_name" : "EG_SMN_PUBLISHER_AGENCY", "subject_transform" : { "type" : "VARIABLE", "value" : "string", "template" : "string" } }, "eg_detail" : { "target_project_id" : "c5be311886934b7c8afb4f8970376130", "target_channel_id" : "10a79a30-bd4a-4955-a3ec-d62dc799347b", "target_region" : "cn-north-test", "cross_region" : false, "cross_account" : false, "agency_name" : "EG_TARGET_AGENCY" }, "apigw_detail" : { "url" : "https://dms.cn-north-4.myhuaweicloud.com/testaaa", "invocation_http_parameters" : { "header_parameters" : [ { "is_value_secret" : false, "key" : "test-key", "value" : "test-value" } ] } }, "retry_times" : 16, "transform" : { "type" : "VARIABLE", "value" : "{\"contant_boolean\": true,\"contant_string\": \"constant\",\"varaible_string\": \"$.data.string\",\"varaible_json_object\": \"$.data.object\"}", "template" : "{\"contant_boolean\": ${contant_boolean},\"contant_string\": \"${contant_string!\\\"default\\\"}\",\"varaible_string\": \"${contant_boolean}\",\"varaible_json_object\": ${varaible_json_object!\"null\"}}" }, "dead_letter_queue" : { "type" : "KAFKA", "instance_id" : "ff0e3f10-fcab-4c3a-84bb-cf5a8b6f7722", "connection_id" : "8516d278-268a-4a8b-8766-9bf9b3302f43", "topic" : "topic" } } ] }

响应示例 状态码：200 Demo Information { "id" : "23709d68-54d5-423b-a6be-03302e893152", "name" : "test-subscription", "description" : "this is a test subscription", "type" : "EVENT", "status" : "CREATED", "channel_id" : "05649f9a-b324-4920-9c49-156d4cd2e546", "channel_name" : "channel006", "used" : [ { } ], "sources" : [ { } ], "targets" : [ { } ], "created_time" : "2021-12-09 09:00:00", "updated_time" : "2021-12-09 09:00:00" }