华为云用户手册

Token认证 Token的有效期为24小时，需要使用一个Token鉴权时，可以先缓存起来，避免频繁调用。 Token在计算机系统中代表令牌（临时）的意思，拥有Token就代表拥有某种权限。Token认证就是在调用API的时候将Token加到请求消息头，从而通过身份认证，获得操作API的权限。 Token可通过调用获取用户Token接口获取，调用本服务API需要project级别的Token，即调用获取用户Token接口时，请求body中auth.scope的取值需要选择project，如下所示。 { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxx" } } } } 获取Token 后，再调用其他接口时，您需要在请求消息头中添加“X-Auth-Token”，其值即为Token。例如Token值为“ABCDEFJ....”，则调用接口时将“X-Auth-Token: ABCDEFJ....”加到请求消息头即可，如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/projects Content-Type: application/json X-Auth-Token: ABCDEFJ.... 您还可以通过这个视频教程了解如何使用Token认证：https://bbs.huaweicloud.com/videos/101333。

请求方法 HTTP请求方法（也称为操作或动词），它告诉服务你正在请求什么类型的操作。 GET：请求服务器返回指定资源。 PUT：请求服务器更新指定资源。 POST：请求服务器新增资源或执行特殊操作。 DELETE：请求服务器删除指定资源，如删除对象等。 HEAD：请求服务器资源头部。 PATCH：请求服务器更新资源的部分内容。当资源不存在的时候，PATCH可能会去创建一个新的资源。 在获取用户Token的URI部分，您可以看到其请求方法为“POST”，则其请求为： POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens

请求URI 请求URI由如下部分组成。 {URI-scheme} :// {Endpoint} / {resource-path} ? {query-string} 尽管请求URI包含在请求消息头中，但大多数语言或框架都要求您从请求消息中单独传递它，所以在此单独强调。 URI-scheme： 表示用于传输请求的协议，当前所有API均采用HTTPS协议。 Endpoint： 指定承载REST服务端点的服务器 域名 或IP，不同服务不同区域的Endpoint不同，您可以地区和终端节点获取。 例如 IAM 服务在“华北-北京一”区域的Endpoint为“iam.cn-north-1.myhuaweicloud.com”。 resource-path： 资源路径，也即API访问路径。从具体API的URI模块获取，例如“获取用户Token”API的resource-path为“/v3/auth/tokens”。 query-string： 查询参数，是可选部分，并不是每个API都有查询参数。查询参数前面需要带一个“？”，形式为“参数名=参数取值”，例如“limit=10”，表示查询不超过10条数据。 例如您需要获取IAM在“华北-北京一”区域的Token，则需使用“华北-北京一”区域的Endpoint（iam.cn-north-1.myhuaweicloud.com），并在获取用户Token的URI部分找到resource-path（/v3/auth/tokens），拼接起来如下所示。 https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens 图1 URI示意图 为查看方便，在每个具体API的URI部分，只给出resource-path部分，并将请求方法写在一起。这是因为URI-scheme都是HTTPS，同一个服务的Endpoint在同一个区域也相同，所以简洁起见将这两部分省略。

请求消息头 附加请求头字段，如指定的URI和HTTP方法所要求的字段。例如定义消息体类型的请求头“Content-Type”，请求鉴权信息等。 如下公共消息头需要添加到请求中。 Content-Type：消息体的类型（格式），必选，默认取值为“application/json”，有其他取值时会在具体接口中专门说明。 X-Auth-Token：用户Token，可选，当使用Token方式认证时，必须填充该字段。用户Token也就是调用获取用户Token接口的响应值，该接口是唯一不需要认证的接口。 API同时支持使用AK/SK认证，AK/SK认证是使用SDK对请求进行签名，签名过程会自动往请求中添加Authorization（签名认证信息）和X-Sdk-Date（请求发送的时间）请求头。 AK/SK认证的详细说明请参见AK/SK认证。 对于获取用户Token接口，由于不需要认证，所以只添加“Content-Type”即可，添加消息头后的请求如下所示。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json

请求消息体 请求消息体通常以结构化格式发出，与请求消息头中Content-type对应，传递除请求消息头之外的内容。若请求消息体中参数支持中文，则中文字符必须为UTF-8编码。 每个接口的请求消息体内容不同，也并不是每个接口都需要有请求消息体（或者说消息体为空），GET、DELETE操作类型的接口就不需要消息体，消息体具体内容需要根据具体接口而定。 对于获取用户Token接口，您可以从接口的请求部分看到所需的请求参数及参数说明。将消息体加入后的请求如下所示，加粗的斜体字段需要根据实际值填写，其中username为用户名，domainname为用户所属的账号名称，********为用户登录密码，xxxxxxxxxxxxxxxxxx为project的名称，如“cn-north-1”，您可以从地区和终端节点获取。 scope参数定义了Token的作用域，上面示例中获取的Token仅能访问project下的资源。您还可以设置Token作用域为某个账号下所有资源或账号的某个project下的资源，详细定义请参见获取用户Token。 POST https://iam.cn-north-1.myhuaweicloud.com/v3/auth/tokens Content-Type: application/json { "auth": { "identity": { "methods": [ "password" ], "password": { "user": { "name": "username", "password": "********", "domain": { "name": "domainname" } } } }, "scope": { "project": { "name": "xxxxxxxxxxxxxxxxxx" } } } } 到这里为止这个请求需要的内容就具备齐全了，您可以使用curl、Postman或直接编写代码等方式发送请求调用API。对于获取用户Token接口，返回的响应消息头中“x-subject-token”就是需要获取的用户Token。有了Token之后，您就可以使用Token认证调用其他API。

API概览 事件网格接口的分类与说明如表1所示。 表1 API概览 API 说明 事件订阅管理 包括创建事件订阅、查询事件订阅列表、更新事件订阅、查询事件订阅详情、删除事件订阅、更新事件订阅源、创建事件订阅目标、更新事件订阅目标、查询事件订阅目标详情、删除事件订阅目标、操作事件订阅。 事件通道管理 包括创建自定义事件通道、查询事件通道列表、更新自定义事件通道、查询事件通道详情、删除自定义事件通道。 事件管理 包括发布事件到事件通道、预校验指定事件源发布事件成功。 事件源管理 包括创建自定义事件源、查询事件源列表、更新自定义事件源、查询事件源详情、删除自定义事件源。 事件目标分类管理 包括查询事件目标分类。 事件模型管理 包括创建自定义事件模型、查询事件模型列表、更新自定义事件模型、查询事件模型详情、删除事件模型、创建自定义事件模型版本、查询事件模型版本列表、查询事件模型版本详情、删除事件模型版本、事件模型自动发现。 目标连接管理 包括创建目标连接、查询目标连接列表、更新目标连接、查询目标连接详情、删除目标连接。 服务委托管理 包括查询服务委托、创建服务委托。 配额管理 包括查询配额。 API版本管理 包括获取API版本列表。 触发器管理 包括查询单个函数的EG触发器、查询单个函数流的EG触发器。 访问端点管理 包括更新访问端点、删除访问端点、创建访问端点、查询访问端点。 obs桶管理 包括获取obs桶列表。 监控指标管理 包括查询事件通道监控指标数据、查询事件订阅监控指标数据。 事件流管理 包括创建事件流、查询事件流列表、更新事件流、查询事件流详情、删除事件流、操作事件流。 事件示例管理 包括查询事件示例列表。 专业版事件流作业管理 包括创建专业版事件流作业、查询专业版事件流作业列表、删除专业版事件流作业、查询专业版事件流作业详情、更新专业版事件流作业、操作专业版事件流作业、校验专业版事件流作业、查看专业版事件流作业同步情况。 专业版事件流集群管理 包括查询专业版事件流集群可用区、创建专业版事件流集群、查询专业版事件流集群列表、删除专业版事件流集群、查询专业版事件流集群详情、更新专业版事件流集群。

基本概念 账号 用户注册账号时，账号对其所拥有的资源及云服务具有完全的访问权限，可以重置用户密码、分配用户权限等。由于账号是付费主体，为了确保账号安全，建议您不要直接使用账号进行日常管理工作，而是创建用户进行日常管理工作。 用户 由账号在IAM中创建的用户，是云服务的使用人员，具有身份凭证（密码和访问密钥）。 在我的凭证下，您可以查看账号ID和用户ID。通常在调用API的鉴权过程中，您需要用到账号、用户和密码等信息。 区域：指云资源所在的物理位置，同一区域内可用区间内网互通，不同区域间内网不互通。通过在不同地区创建云资源，可以将应用程序设计的更接近特定客户的要求，或满足不同地区的法律或其他要求。 可用区：一个可用区是一个或多个物理数据中心的集合，有独立的风火水电，AZ内逻辑上再将计算、网络、存储等资源划分成多个集群。一个Region中的多个AZ间通过高速光纤相连，以满足用户跨AZ构建高可用性系统的需求。 项目 区域默认对应一个项目，这个项目由系统预置，用来隔离物理区域间的资源（计算资源、存储资源和网络资源），以默认项目为单位进行授权，用户可以访问您账号中该区域的所有资源。如果您希望进行更加精细的权限控制，可以在区域默认的项目中创建子项目，并在子项目中创建资源，然后以子项目为单位进行授权，使得用户仅能访问特定子项目中资源，使得资源的权限控制更加精确。 图1 项目隔离模型 同样在我的凭证下，您可以查看项目ID。 企业项目 企业项目是项目的升级版，针对企业不同项目间资源的分组和管理，是逻辑隔离。企业项目中可以包含多个区域的资源，且项目中的资源可以迁入迁出。 关于企业项目ID的获取及企业项目特性的详细信息，请参见企业管理服务用户指南。

响应参数 状态码：200 表10 响应Header参数 参数 参数类型 描述 X-Request-Id String 请求ID 表11 响应Body参数 参数 参数类型 描述 results Array of ValidateResult objects 作业校验结果列表 表12 ValidateResult 参数 参数类型 描述 check_item_name String 检查项标识 name String 检查项的名称 content String 检查项的内容 status String 检查项的状态 error_code String 检查失败对应的错误码 reason String 检查失败的原因 solution String 检查失败的解决方案

响应示例 状态码：200 请求成功 { "results" : [ { "check_item_name" : "SOURCE_NETWORK", "name" : "源端连通性", "content" : "检查数据传输服务器是否能够连通源端服务", "status" : "SUC CES S", "error_code" : null, "reason" : null, "solution" : null } ] }

请求示例 校验jobid=123的专业版事件流作业 POST https://{eg_endpoint}/v1/{project_id}/eventrouter/jobs/validation?validate_type=SOURCE_NETWORK&job_id=123 { "cluster_id" : "fac59513-6c18-4266-bc81-5d412dfc1926", "source_config" : { "source_dcs" : { "config_type" : "CLOUD", "region" : "roma-dev-1", "project_id" : "cb13a5c409fe40599271f44bbea5a2ad", "instance_id" : "228cdb80-fabb-4490-83bd-0a91e8bef9b4", "password" : null } } }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表4 请求Body参数 参数 是否必选 参数类型 描述 cluster_id 是 String 集群ID source_config 否 EventRouterJobSource object 专业版事件流作业源端配置 sink_config 否 EventRouterJobSink object 专业版事件流作业目标端配置 表5 EventRouterJobSource 参数 是否必选 参数类型 描述 source_kafka 否 KafkaParameters object kafka配置 source_rocketmq 否 RocketmqParameters object rocketmq配置 source_dcs 否 DcsParameters object dcs配置 表6 EventRouterJobSink 参数 是否必选 参数类型 描述 sink_kafka 否 KafkaParameters object kafka配置 sink_rocketmq 否 RocketmqParameters object rocketmq配置 sink_dcs 否 DcsParameters object dcs配置 表7 KafkaParameters 参数 是否必选 参数类型 描述 config_type 是 String 实例类型 CLOUD：云服务DMS kafka实例 region 是 String 区域ID project_id 是 String 资源空间ID instance_id 否 String kafka实例ID，配置类型选择CLOUD时必填 cluster_alias 是 String kafka集群别名 address 否 String kafka地址 authenticate_mode 否 String kafka认证方式 sasl_mechanism 否 String SASL认证机制 user_name 否 String 用户名，开启SASL_SSL时必填 password 否 String 用户密码，开启SASL_SSL时必填 表8 RocketmqParameters 参数 是否必选 参数类型 描述 config_type 是 String 实例类型。 CLOUD：云服务DMS Rocketmq实例 region 是 String 区域id project_id 是 String 资源空间ID instance_id 否 String rocketmq实例ID，配置类型选择CLOUD时必填 cluster_alias 是 String rocketmq集群别名 address 否 String rocketmq地址 ssl_open 否 String rocketmq SSL开关 true: 开启 false: 关闭 acl_open 否 Boolean rocketmq ACL开关 true: 开启 false: 关闭 user_name 否 String 用户名，开启ACL时必填 password 否 String 用户密码，开启ACL时必填 表9 DcsParameters 参数 是否必选 参数类型 描述 config_type 是 String 实例类型 CLOUD：云服务D CS 实例 region 是 String 区域id project_id 是 String 资源空间ID instance_id 否 String dcs实例ID，配置类型选择CLOUD时必填 address 否 String dcs地址 password 否 String 用户密码

响应示例 状态码：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" }, "retry_times" : 16, "created_time" : "2021-12-09 09:00:00", "updated_time" : "2021-12-09 09:00:00" }

请求示例 更新事件订阅目标定义 PUT https://{endpoint}/v1/{project_id}/subscriptions/{subscription_id}/targets/{target_id} { "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 主题

URI PUT /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

请求参数 表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 主题

响应示例 状态码：200 Information { "id" : "3a0eeff2-78a4-4122-dfge-7ty5e37f64er", "name" : "HC.OBS", "provider_type" : "OFFICIAL", "detail" : { "name" : "name" }, "filter" : { "data" : { "count" : [ { "op" : "NumberIn", "values" : [ 1, 2 ] } ] } }, "created_time" : "2021-12-09 09:00:00", "updated_time" : "2021-12-09 09:00:00" }

请求参数 表3 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表4 请求Body参数 参数 是否必选 参数类型 描述 id 否 String 订阅源ID，需保证全局唯一。指定ID的订阅源存在时则进行更新，否则进行创建；未指定时由系统自动生成。由小写字母、数字、中划线组成，必须字母或数字开头。 name 是 String 订阅的事件源名称 provider_type 是 String 订阅的事件源的提供方类型 detail 否 Object 订阅的事件源参数列表, 该字段序列化后总长度不超过1024字节 filter 是 Object 订阅事件源的匹配过滤规则, 该字段序列化后总长度不超过2048字节

响应参数 状态码：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 订阅的事件源名称 provider_type String 订阅的事件源的提供方类型 detail Object 订阅的事件源参数列表 filter Object 订阅事件源的匹配过滤规则 created_time String 创建时间 updated_time String 更新时间

请求示例 更新事件订阅源 PUT https://{endpoint}/v1/{project_id}/subscriptions/{subscription_id}/sources/{source_id} { "id" : "3a0eeff2-78a4-4122-dfge-7ty5e37f64er", "name" : "HC.OBS", "provider_type" : "OFFICIAL", "detail" : { "name" : "name" }, "filter" : { "data" : { "count" : [ { "op" : "NumberIn", "values" : [ 1, 2 ] } ] } } }

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

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

请求示例 更新事件订阅 PUT https://{endpoint}/v1/{project_id}/subscriptions/{subscription_id} { "description" : "开发用", "sources" : [ { "detail" : { }, "filter" : { "source" : [ { "op" : "StringIn", "values" : [ "ghm" ] } ] }, "id" : "4fca4f29-917b-44d3-bb30-4310f89d08cb", "name" : "ghm", "provider_type" : "CUSTOM" } ], "targets" : [ { "id" : "4261f07e-975c-457f-aa91-0bd33d64baba", "name" : "HC.SMN", "provider_type" : "OFFICIAL", "retry_times" : 16, "smn_detail" : { "agency_name" : "EG_TARGET_AGENCY", "urn" : "urn:smn:cn-north-7:bac852160cc743158936edaab6dda813:CES_notification_group_xMXxPQ1ry" }, "transform" : { "type" : "ORIGINAL", "value" : "" } } ] }

响应参数 状态码：200 表17 响应Header参数 参数 参数类型 描述 X-Request-Id String This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. 表18 响应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 更新时间 表19 SubscriptionUsedInfo 参数 参数类型 描述 resource_id String 关联资源ID owner String 管理租户账号 description String 描述 表20 SubscriptionSourceInfo 参数 参数类型 描述 id String 订阅源ID name String 订阅的事件源名称 provider_type String 订阅的事件源的提供方类型 detail Object 订阅的事件源参数列表 filter Object 订阅事件源的匹配过滤规则 created_time String 创建时间 updated_time String 更新时间 表21 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 更新时间 表22 KafkaTargetDetail 参数 参数类型 描述 topic String 主题 keyTransform keyTransform object 键值规则 表23 keyTransform 参数 参数类型 描述 type String 键值规则类型 value String 键值规则，键值规则为VARIABLE，CONSTANT时必填 template String 键值规则模板，键值规则为VARIABLE时必填 表24 SmnTargetDetail 参数 参数类型 描述 urn String 主题urn agency_name String 委托名称 subject_transform subject_transform object 标题规则 表25 subject_transform 参数 参数类型 描述 type String 标题规则类型 value String 标题规则 template String 标题规则模板，键值规则为VARIABLE时必填 表26 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 委托名称 表27 ApigwTargetDetail 参数 参数类型 描述 url String 目标url invocation_http_parameters InvocationHttpParameters object 调用Http的参数 表28 InvocationHttpParameters 参数 参数类型 描述 header_parameters Array of HeaderParameter objects 对象列表 表29 HeaderParameter 参数 参数类型 描述 is_value_secret Boolean 是否加密 key String header的key值 value String deader的value值 表30 TransForm 参数 参数类型 描述 type String 转换规则类型 value String 常量类型规则时，字段为常量内容定义； 变量类型规则时，为变量定义，内容必须为JsonObject字符串。 变量最多支持100个，且不支持嵌套结构定义； 变量名由字母、数字、点、下划线和中划线组成，必须字母或数字开头不能以HC.开头，长度不超过64个字符； 变量值表达式支持常量或JsonPath表达式，字符串长度不超过1024个字符。 template String 变量类型规则时，规则内容的模板定义，支持对已定义变量的引用。 表31 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参数 参数 是否必选 参数类型 描述 description 否 String 订阅描述 sources 否 Array of SubscriptionSource objects 订阅事件源列表，字段存在则代表全量更新订阅源 targets 否 Array of SubscriptionTarget objects 订阅事件目标列表，字段存在则代表全量更新订阅目标 表5 SubscriptionSource 参数 是否必选 参数类型 描述 id 否 String 订阅源ID，需保证全局唯一。指定ID的订阅源存在时则进行更新，否则进行创建；未指定时由系统自动生成。由小写字母、数字、中划线组成，必须字母或数字开头。 name 是 String 订阅的事件源名称 provider_type 是 String 订阅的事件源的提供方类型 detail 否 Object 订阅的事件源参数列表, 该字段序列化后总长度不超过1024字节 filter 是 Object 订阅事件源的匹配过滤规则, 该字段序列化后总长度不超过2048字节 表6 SubscriptionTarget 参数 是否必选 参数类型 描述 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 订阅的死信参数列表 表7 KafkaTargetDetail 参数 是否必选 参数类型 描述 topic 是 String 主题 keyTransform 否 keyTransform object 键值规则 表8 keyTransform 参数 是否必选 参数类型 描述 type 否 String 键值规则类型 value 否 String 键值规则，键值规则为VARIABLE，CONSTANT时必填 template 否 String 键值规则模板，键值规则为VARIABLE时必填 表9 SmnTargetDetail 参数 是否必选 参数类型 描述 urn 是 String 主题urn agency_name 是 String 委托名称 subject_transform 否 subject_transform object 标题规则 表10 subject_transform 参数 是否必选 参数类型 描述 type 是 String 标题规则类型 value 是 String 标题规则 template 否 String 标题规则模板，键值规则为VARIABLE时必填 表11 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 委托名称 表12 ApigwTargetDetail 参数 是否必选 参数类型 描述 url 是 String 目标url invocation_http_parameters 否 InvocationHttpParameters object 调用Http的参数 表13 InvocationHttpParameters 参数 是否必选 参数类型 描述 header_parameters 否 Array of HeaderParameter objects 对象列表 表14 HeaderParameter 参数 是否必选 参数类型 描述 is_value_secret 否 Boolean 是否加密 key 否 String header的key值 value 否 String deader的value值 表15 TransForm 参数 是否必选 参数类型 描述 type 是 String 转换规则类型 value 否 String 常量类型规则时，字段为常量内容定义； 变量类型规则时，为变量定义，内容必须为JsonObject字符串。 变量最多支持100个，且不支持嵌套结构定义； 变量名由字母、数字、点、下划线和中划线组成，必须字母或数字开头不能以HC.开头，长度不超过64个字符； 变量值表达式支持常量或JsonPath表达式，字符串长度不超过1024个字符。 template 否 String 变量类型规则时，规则内容的模板定义，支持对已定义变量的引用。 表16 DeadLetterQueue 参数 是否必选 参数类型 描述 type 是 String 队列类型 instance_id 是 String 实例id connection_id 是 String 目标连接id topic 是 String 主题

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

响应参数 状态码：200 表17 响应Header参数 参数 参数类型 描述 X-Request-Id String This field is the request ID number for task tracking. Format is request_uuid-timestamp-hostname. 表18 响应Body参数 参数 参数类型 描述 eventStreamingID String 事件流ID

请求示例 更新eventstreaming_id事件流 PUT https://{eg_endpoint}/v1/{project_id}/eventstreamings/{eventstreaming_id} { "name" : "test-eventstreaming", "description" : "this is a test eventstreaming", "source" : { "source_kafka" : { "addr" : "10.10.10.10:8100", "group" : "group-test", "instance_name" : "instance-name-test", "security_protocol" : "PLAINTEXT", "instance_id" : "instance-id-test", "topic" : "topic-test", "seek_to" : "earliest", "enable_sasl_ssl" : true, "sasl_mechanism" : "PLAIN", "ssl_certificate_url" : "https://domain/kafka-certs.zip", "ssl_certificate_pwd" : null, "user_name" : "", "password" : "" }, "source_mobile_rocketmq" : { "group_id" : "string", "instance_id" : "string", "topic" : "string", "tag" : "string", "authentication_required" : true, "msg_trace_switch" : true, "access_key" : "string", "secret_key" : "string", "message_model" : "CLUSTERING", "addr_type" : "PUBLIC", "addr" : "string", "sdk_url" : "string", "consume_timeout" : 30000, "message_type" : "string", "suspend_time" : 1800, "max_reconsumer_times" : 3, "consumer_thread_nums" : 20, "consumer_batch_max_size" : 20, "consumer_max_wait" : 5, "vpc_id" : "string", "subnet_id" : "string" }, "source_community_rocketmq" : { "instance_name" : "instance-name-test", "instance_id" : "instance-id-test", "addr" : "10.10.10.10:8100", "group" : "group-test", "topic" : "topic-test", "tag" : "string", "vpc_id" : "string", "subnet_id" : "string", "ssl_enable" : true, "enable_acl" : true, "access_key" : "string", "secret_key" : "string", "message_type" : "string", "consume_timeout" : 30000, "consumer_thread_nums" : 20, "consumer_batch_max_size" : 1, "max_reconsume_times" : -1, "suspend_current_queue_time_millis" : 1000 }, "source_dms_rocketmq" : { "instance_name" : "instance-name-test", "instance_id" : "instance-id-test", "group" : "group-test", "topic" : "topic-test", "tag" : "string", "ssl_enable" : true, "enable_acl" : true, "access_key" : "string", "secret_key" : "string", "message_type" : "string", "engine_version" : "string", "consume_timeout" : 30000, "consumer_thread_nums" : 20, "consumer_batch_max_size" : 1, "max_reconsume_times" : -1, "suspend_current_queue_time_millis" : 1000 }, "name" : "string" }, "sink" : { "sink_fg" : { "invoke_type" : "SYNC/ASYNC", "urn" : "String", "agency" : "string" }, "sink_kafka" : { "topic" : "string", "keyTransform" : [ { "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\"}}" } ], "connectionId" : "string" }, "sink_obs" : { "access_key" : "string", "secret_key" : "string", "obs_bucket" : "string", "obs_path" : "string", "time_format" : "string" }, "name" : "string" }, "rule_config" : { "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\"}}" }, "filter" : { } }, "option" : { "thread_num" : "3", "batch_window" : { "count" : 500, "time" : 10, "interval" : 0 } } }

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 表3 请求Body参数 参数 是否必选 参数类型 描述 name 是 String 事件流名称，租户下唯一，由字母、数字、点、下划线和中划线组成，必须字母或数字开头 description 否 String 事件流描述 source 是 EventStreamingSource object 事件源，一个事件流中事件源只有一个 sink 是 EventStreamingSink object 事件目标，一个事件流中只有一个事件目标，sink_fg、sink_kafka只能选择其中一个参数 rule_config 否 rule_config object 事件规则，包括过滤规则和转换规则 option 否 RunOption object 运行配置 表4 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 事件源类型名称 表5 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 用户密码 表6 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 子网 表7 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 表8 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 表9 EventStreamingSink 参数 是否必选 参数类型 描述 sink_fg 否 SinkFGParameters object 函数事件目标的参数 sink_kafka 否 SinkKafkaParameters object kafka事件目标的参数 sink_obs 否 SinkObsParameters object OBS事件目标的参数 name 否 String 事件目标类型名称 表10 SinkFGParameters 参数 是否必选 参数类型 描述 invoke_type 否 String 函数执行方式,同步/异步 urn 否 String 函数链接 agency 否 String 租户委托 表11 SinkKafkaParameters 参数 是否必选 参数类型 描述 topic 是 String topic名称 keyTransform 否 Array of TransForm objects key的转换规则 connectionId 是 String 目标连接id 表12 TransForm 参数 是否必选 参数类型 描述 type 是 String 转换规则类型 value 否 String 常量类型规则时，字段为常量内容定义； 变量类型规则时，为变量定义，内容必须为JsonObject字符串。 变量最多支持100个，且不支持嵌套结构定义； 变量名由字母、数字、点、下划线和中划线组成，必须字母或数字开头不能以HC.开头，长度不超过64个字符； 变量值表达式支持常量或JsonPath表达式，字符串长度不超过1024个字符。 template 否 String 变量类型规则时，规则内容的模板定义，支持对已定义变量的引用。 表13 SinkObsParameters 参数 是否必选 参数类型 描述 access_key 是 String AK secret_key 是 String SK obs_bucket 是 String 桶 obs_path 否 String 转储目录 time_format 是 String 时间目录格式 表14 rule_config 参数 是否必选 参数类型 描述 transform 否 TransForm object 订阅的事件目标转换规则 filter 否 Object 过滤规则 表15 RunOption 参数 是否必选 参数类型 描述 thread_num 否 Integer 并发数 batch_window 否 BatchWindow object 批量推送 表16 BatchWindow 参数 是否必选 参数类型 描述 count 否 Integer 批量推送条数[1,10000] time 否 Integer 重试次数 interval 否 Integer 批量推送间隔[0,15]，单位秒

响应参数 状态码：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：伙伴事件源 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 错误信息 表7 event_types 参数 参数类型 描述 name String 事件类型名称 description String 事件类型描述 表8 ErrorInfo 参数 参数类型 描述 error_code String 错误码 error_detail String 错误详情 error_msg String 错误信息