华为云用户手册

响应参数 状态码：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参数 参数 参数类型 描述 eventStreamingID String 事件流ID

请求示例 翻新obs桶名为obs1的fg触发器，创建为EG订阅 POST https://{eg_endpoint}/v1/{project_id}/subscriptions/obsbuckets/obs1/refurbishobs { "agency_name" : "string", "id" : "string", "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\"}}" } }

响应示例 状态码：200 翻新FG后所创建订阅 { "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" }

响应参数 状态码：200 表5 响应Body参数 参数 参数类型 描述 id String 订阅ID name String 订阅名称 description String 订阅描述 type String 类型 status String 状态 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 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 更新时间 表9 KafkaTargetDetail 参数 参数类型 描述 topic String 主题 keyTransform keyTransform object 键值规则 表10 keyTransform 参数 参数类型 描述 type String 键值规则类型 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 标题规则类型 value String 标题规则 template String 标题规则模板，键值规则为VARIABLE时必填 表13 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 委托名称 表14 ApigwTargetDetail 参数 参数类型 描述 url String 目标url invocation_http_parameters InvocationHttpParameters object 调用Http的参数 表15 InvocationHttpParameters 参数 参数类型 描述 header_parameters Array of HeaderParameter objects 对象列表 表16 HeaderParameter 参数 参数类型 描述 is_value_secret Boolean 是否加密 key String header的key值 value String deader的value值 表17 TransForm 参数 参数类型 描述 type String 转换规则类型 value String 常量类型规则时，字段为常量内容定义； 变量类型规则时，为变量定义，内容必须为JsonObject字符串。 变量最多支持100个，且不支持嵌套结构定义； 变量名由字母、数字、点、下划线和中划线组成，必须字母或数字开头不能以HC.开头，长度不超过64个字符； 变量值表达式支持常量或JsonPath表达式，字符串长度不超过1024个字符。 template String 变量类型规则时，规则内容的模板定义，支持对已定义变量的引用。 表18 DeadLetterQueue 参数 参数类型 描述 type String 队列类型 instance_id String 实例id connection_id String 目标连接id topic String 主题

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 events 否 Array of CloudEvents objects CloudEvents事件格式定义，参考https://github.com/cloudevents/spec/blob/v1.0.1/spec.md 表4 CloudEvents 参数 是否必选 参数类型 描述 id 是 String 事件唯一标识串，同一个事件来源里必须唯一 source 是 String 事件来源上下文标识串，source+id可以唯一确定一个事件。采用URI-Reference格式，参考https://tools.ietf.org/html/rfc3986#section-4.1 specversion 是 String CloudEvents协议版本，格式为major.minor type 是 String 事件类型 datacontenttype 否 String 事件内容格式，采用MIME格式，遵循RFC2046，参考https://tools.ietf.org/html/rfc2046 dataschema 否 String 事件内容模型定义的URI，遵循RFC3986，参考https://tools.ietf.org/html/rfc3986#section-4.3 data 否 Object 事件的负载内容，采用datacontenttype字段指定的格式，内容字段遵循dataschema字段的描述 time 否 String 事件发生UTC日期时间，相同来源的事件格式相同，遵循RFC3339，格式需满足2018-04-05T17:31:00Z，参考https://tools.ietf.org/html/rfc3339 subject 否 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 发布失败的原因 event_id String 事件唯一标识串

请求示例 发布官方事件到事件通道 POST https://{endpoint}/v1/{project_id}/official/sources/{source_name}/events { "events" : [ { "id" : "id", "source" : "source", "specversion" : "specversion", "type" : "blob_created" } ] }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 events 否 Array of CloudEvents objects CloudEvents事件格式定义，参考https://github.com/cloudevents/spec/blob/v1.0.1/spec.md 表4 CloudEvents 参数 是否必选 参数类型 描述 id 是 String 事件唯一标识串，同一个事件来源里必须唯一 source 是 String 事件来源上下文标识串，source+id可以唯一确定一个事件。采用URI-Reference格式，参考https://tools.ietf.org/html/rfc3986#section-4.1 specversion 是 String CloudEvents协议版本，格式为major.minor type 是 String 事件类型 datacontenttype 否 String 事件内容格式，采用MIME格式，遵循RFC2046，参考https://tools.ietf.org/html/rfc2046 dataschema 否 String 事件内容模型定义的URI，遵循RFC3986，参考https://tools.ietf.org/html/rfc3986#section-4.3 data 否 Object 事件的负载内容，采用datacontenttype字段指定的格式，内容字段遵循dataschema字段的描述 time 否 String 事件发生UTC日期时间，相同来源的事件格式相同，遵循RFC3339，格式需满足2018-04-05T17:31:00Z，参考https://tools.ietf.org/html/rfc3339 subject 否 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 发布失败的原因 event_id String 事件唯一标识串

请求示例 发布事件到事件通道 POST https://{endpoint}/v1/{project_id}/channels/{channel_id}/events { "events" : [ { "id" : "id", "source" : "source", "specversion" : "specversion", "type" : "blob_created" } ] }

URI GET /v1/{project_id}/subscription-triggers/workflow/{workflow_id} 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户资源空间ID workflow_id 是 String 目标函数流的id 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询，偏移量不能小于0 limit 否 Integer 每页显示的条目数量，不能小于1或大于1000 sort 否 String 指定查询排序

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 size Integer 本页数量 items Array of SubscriptionInfo objects 对象列表 表5 SubscriptionInfo 参数 参数类型 描述 id String 订阅ID name String 订阅名称 description String 订阅描述 type String 类型 status String 状态 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 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 更新时间 表9 KafkaTargetDetail 参数 参数类型 描述 topic String 主题 keyTransform keyTransform object 键值规则 表10 keyTransform 参数 参数类型 描述 type String 键值规则类型 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 标题规则类型 value String 标题规则 template String 标题规则模板，键值规则为VARIABLE时必填 表13 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 委托名称 表14 ApigwTargetDetail 参数 参数类型 描述 url String 目标url invocation_http_parameters InvocationHttpParameters object 调用Http的参数 表15 InvocationHttpParameters 参数 参数类型 描述 header_parameters Array of HeaderParameter objects 对象列表 表16 HeaderParameter 参数 参数类型 描述 is_value_secret Boolean 是否加密 key String header的key值 value String deader的value值 表17 TransForm 参数 参数类型 描述 type String 转换规则类型 value String 常量类型规则时，字段为常量内容定义； 变量类型规则时，为变量定义，内容必须为JsonObject字符串。 变量最多支持100个，且不支持嵌套结构定义； 变量名由字母、数字、点、下划线和中划线组成，必须字母或数字开头不能以HC.开头，长度不超过64个字符； 变量值表达式支持常量或JsonPath表达式，字符串长度不超过1024个字符。 template String 变量类型规则时，规则内容的模板定义，支持对已定义变量的引用。 表18 DeadLetterQueue 参数 参数类型 描述 type String 队列类型 instance_id String 实例id connection_id String 目标连接id topic String 主题

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 size Integer 本页数量 items Array of SubscriptionInfo objects 对象列表 表5 SubscriptionInfo 参数 参数类型 描述 id String 订阅ID name String 订阅名称 description String 订阅描述 type String 类型 status String 状态 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 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 更新时间 表9 KafkaTargetDetail 参数 参数类型 描述 topic String 主题 keyTransform keyTransform object 键值规则 表10 keyTransform 参数 参数类型 描述 type String 键值规则类型 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 标题规则类型 value String 标题规则 template String 标题规则模板，键值规则为VARIABLE时必填 表13 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 委托名称 表14 ApigwTargetDetail 参数 参数类型 描述 url String 目标url invocation_http_parameters InvocationHttpParameters object 调用Http的参数 表15 InvocationHttpParameters 参数 参数类型 描述 header_parameters Array of HeaderParameter objects 对象列表 表16 HeaderParameter 参数 参数类型 描述 is_value_secret Boolean 是否加密 key String header的key值 value String deader的value值 表17 TransForm 参数 参数类型 描述 type String 转换规则类型 value String 常量类型规则时，字段为常量内容定义； 变量类型规则时，为变量定义，内容必须为JsonObject字符串。 变量最多支持100个，且不支持嵌套结构定义； 变量名由字母、数字、点、下划线和中划线组成，必须字母或数字开头不能以HC.开头，长度不超过64个字符； 变量值表达式支持常量或JsonPath表达式，字符串长度不超过1024个字符。 template String 变量类型规则时，规则内容的模板定义，支持对已定义变量的引用。 表18 DeadLetterQueue 参数 参数类型 描述 type String 队列类型 instance_id String 实例id connection_id String 目标连接id topic String 主题

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

URI GET /v1/{project_id}/traced-events 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户资源空间ID 表2 Query参数 参数 是否必选 参数类型 描述 start_time 是 Long 查询数据起始时间 end_time 是 Long 查询数据结束时间 event_id 否 String 指定查询事件的Id source_name 否 String 事件源名称 event_type 否 String 指定查询的事件类型，精准匹配 subscription_name 否 String 事件订阅名称 limit 否 String 每页显示的条目数量，不能小于0 offset 否 Integer 偏移量，表示从此偏移量开始查询，偏移量不能小于0 channel_id 是 String 通道ID

响应参数 状态码：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 本页数量 result Array of result objects 事件追踪列表 表6 result 参数 参数类型 描述 subscription_name String 事件订阅名称 source_name String 事件源名称 source_provider String 事件源供应方 event_type String 事件类型 event_id String 事件Id event_received_time Integer 事件接收时间

响应示例 状态码：200 Information { "total" : 1, "size" : 1, "result" : [ { "subscription_name" : "subscription-xxxx", "source_name" : "HC.SMN", "source_provider" : "OFFICIAL", "event_type" : "SMN:CloudTrace:ConsoleAction", "event_id" : "ace774cb-d3f1-49c1-9d8b-9efd086ac9e00533366", "event_received_time" : 1677651126823 } ] }

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 size Integer 本页数量 items Array of SubscriptionInfo objects 对象列表 表5 SubscriptionInfo 参数 参数类型 描述 id String 订阅ID name String 订阅名称 description String 订阅描述 type String 类型 status String 状态 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 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 更新时间 表9 KafkaTargetDetail 参数 参数类型 描述 topic String 主题 keyTransform keyTransform object 键值规则 表10 keyTransform 参数 参数类型 描述 type String 键值规则类型 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 标题规则类型 value String 标题规则 template String 标题规则模板，键值规则为VARIABLE时必填 表13 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 委托名称 表14 ApigwTargetDetail 参数 参数类型 描述 url String 目标url invocation_http_parameters InvocationHttpParameters object 调用Http的参数 表15 InvocationHttpParameters 参数 参数类型 描述 header_parameters Array of HeaderParameter objects 对象列表 表16 HeaderParameter 参数 参数类型 描述 is_value_secret Boolean 是否加密 key String header的key值 value String deader的value值 表17 TransForm 参数 参数类型 描述 type String 转换规则类型 value String 常量类型规则时，字段为常量内容定义； 变量类型规则时，为变量定义，内容必须为JsonObject字符串。 变量最多支持100个，且不支持嵌套结构定义； 变量名由字母、数字、点、下划线和中划线组成，必须字母或数字开头不能以HC.开头，长度不超过64个字符； 变量值表达式支持常量或JsonPath表达式，字符串长度不超过1024个字符。 template String 变量类型规则时，规则内容的模板定义，支持对已定义变量的引用。 表18 DeadLetterQueue 参数 参数类型 描述 type String 队列类型 instance_id String 实例id connection_id String 目标连接id topic String 主题

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

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 result Array of EventSubMetricsItem objects 指标数据列表 表5 EventSubMetricsItem 参数 参数类型 描述 fail_num Long 失败数 retry_success_num Long 重试成功数 retry_fail_num Long 重试失败数 retry_times Integer 重试数 timestamp Long 时间戳 num Long 调用数 success_num Long 调用成功数 process_time Long 处理时间 invoke_time Long 调用时间

URI GET /v1/{project_id}/metrics/sub 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户资源空间ID 表2 Query参数 参数 是否必选 参数类型 描述 filter 否 String 指标数据统计方式 period 否 Integer 指标数据统计周期，单位minute。 start_time 是 Long 获取指标数据起始时间 end_time 否 Long 获取指标数据结束时间 subscription_id 是 String 事件订阅id provider_type 否 String 事件目标类型/事件通道类型 target_id 否 String 事件目标id

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 quotas QuotaResourceResp object 配额描述 表5 QuotaResourceResp 参数 参数类型 描述 resources Array of QuotaItemInfo objects 错误描述 表6 QuotaItemInfo 参数 参数类型 描述 name String 名称 type String 配额类型 max Integer 配额最大值 min Integer 配额最小值 quota Integer 当前租户的配额 used Integer 当前租户已使用的配额

URI GET /v1/{project_id}/metrics/pub 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户资源空间ID 表2 Query参数 参数 是否必选 参数类型 描述 filter 否 String 指标数据统计方式 period 否 Integer 指标数据统计周期，单位minute。 start_time 是 Long 获取指标数据起始时间 end_time 否 Long 获取指标数据结束时间 channel_id 是 String 事件通道id provider_type 否 String 事件目标类型/事件通道类型 source_name 否 String 事件源名称

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 result Array of EventPubMetricsItem objects 指标列表 表5 EventPubMetricsItem 参数 参数类型 描述 event_size Long 事件大小 timestamp Long 时间戳 num Long 调用数 success_num Long 调用成功数 process_time Long 处理时间 invoke_time Long 调用时间

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

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 size Integer 本页数量 items Array of ObsBucketInfo objects 对象列表 表5 ObsBucketInfo 参数 参数类型 描述 responseHeaders Object 响应头 originalHeaders Object 请求头 statusCode Integer 状态 bucketName String 桶名称 owner owner object 桶拥有者信息 creationDate String 桶的创建时间 location String 桶的位置信息 storageClass Object 对象的存储类型 metadata Object 桶元数据 acl Object 桶ACL bucketStorageClass Object 桶的存储类型 bucketType String 桶类型 requestId String 请求id 表6 owner 参数 参数类型 描述 displayName String 显示名称 id String 用户的DomainID，即账号ID

URI GET /v1/{project_id}/target-catalogs 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 租户资源空间ID 表2 Query参数 参数 是否必选 参数类型 描述 offset 否 Integer 偏移量，表示从此偏移量开始查询，偏移量不能小于0 limit 否 Integer 每页显示的条目数量，不能小于1或大于1000 sort 否 String 指定查询排序 fuzzy_label 否 String 指定查询的事件目标标签，模糊匹配 support_types 否 Array of strings 事件目标支持方式：事件订阅：SUBSCRIPTION、事件流：FLOW

响应参数 状态码：200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 size Integer 本页数量 items Array of CatalogTargetInfo objects 对象列表 表5 CatalogTargetInfo 参数 参数类型 描述 id String 事件目标分类ID name String 事件目标分类名称 label String 事件目标分类名称展示说明 description String 事件目标分类描述 provider_type String 提供方类型，OFFICIAL：官方云服务事件目标；CUSTOM：第三方事件目标 parameters Array of CatalogTargetParameters objects 事件目标分类参数 created_time String 创建UTC时间 updated_time String 更新UTC时间 表6 CatalogTargetParameters 参数 参数类型 描述 name String 目标参数名称 label String 目标参数名称展示说明 metadata Object 参数展示元数据，比如是否必选，输入框类型等等

响应参数 状态码：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]，单位秒