华为云用户手册

响应示例 状态码： 400 { "error_code" : "EG.00014000", "error_msg" : "Bad request"} 状态码： 401 { "error_code" : "EG.00014010", "error_msg" : "Incorrect token or token resolution failed"} 状态码： 403 { "error_code" : "EG.00014030", "error_msg" : "No permissions to request this method"} 状态码： 404 { "error_code" : "EG.00014040", "error_msg" : "Not request resource found"} 状态码： 500 { "error_code" : "EG.00015000", "error_msg" : "Internal Server Error"}

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

响应示例 状态码： 400 { "error_code" : "EG.00014000", "error_msg" : "Bad request"} 状态码： 401 { "error_code" : "EG.00014010", "error_msg" : "Incorrect token or token resolution failed"} 状态码： 403 { "error_code" : "EG.00014030", "error_msg" : "No permissions to request this method"} 状态码： 404 { "error_code" : "EG.00014040", "error_msg" : "Not request resource found"} 状态码： 500 { "error_code" : "EG.00015000", "error_msg" : "Internal Server Error"}

URI GET /v1/{project_id}/connections 表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 指定查询的目标连接名称，精准匹配 fuzzy_name 否 String 指定查询的目标连接名称，模糊匹配 instance_id 否 String 指定查询的目标连接，队列的实例id

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

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

响应示例 状态码： 400 { "error_code" : "EG.00014000", "error_msg" : "Bad request"} 状态码： 401 { "error_code" : "EG.00014010", "error_msg" : "Incorrect token or token resolution failed"} 状态码： 403 { "error_code" : "EG.00014030", "error_msg" : "No permissions to request this method"} 状态码： 404 { "error_code" : "EG.00014040", "error_msg" : "Not request resource found"} 状态码： 500 { "error_code" : "EG.00015000", "error_msg" : "Internal Server Error"}

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用 IAM 服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：16384 表3 请求Body参数 参数 是否必选 参数类型 描述 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 订阅的死信参数列表 表4 Detail 参数 是否必选 参数类型 描述 url 否 String 自定义目标url agency_name 否 String 委托名称 invocation_http_parameters 否 InvocationHttpParameters object invoke_type 否 String 函数调用方式,异步/同步 枚举值： SYNC，ASYNC 表5 InvocationHttpParameters 参数 是否必选 参数类型 描述 header_parameters 否 Array of HeaderParameter objects 对象列表 数组长度：0 - 5 表6 HeaderParameter 参数 是否必选 参数类型 描述 is_value_secret 否 Boolean 是否加密 key 否 String header的key值 最小长度：1 最大长度：256 value 否 String header的value值 最小长度：1 最大长度：1024 表7 KafkaTargetDetail 参数 是否必选 参数类型 描述 topic 是 String 主题 keyTransform 否 keyTransform object 键值规则 表8 keyTransform 参数 是否必选 参数类型 描述 type 否 String 键值规则类型 枚举值： NONE VARIABLE CONSTANT 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 标题规则类型 枚举值： VARIABLE CONSTANT value 是 String 标题规则 template 否 String 标题规则模板，键值规则为VARIABLE时必填 表11 TransForm 参数 是否必选 参数类型 描述 type 是 String 转换规则类型 枚举值： ORIGINAL CONSTANT VARIABLE value 否 String 常量类型规则时，字段为常量内容定义； 变量类型规则时，为变量定义，内容必须为JsonObject字符串。 变量最多支持100个，且不支持嵌套结构定义； 变量名由字母、数字、点、下划线和中划线组成，必须字母或数字开头不能以HC.开头，长度不超过64个字符； 变量值表达式支持常量或JsonPath表达式，字符串长度不超过1024个字符。 最大长度：1024 template 否 String 变量类型规则时，规则内容的模板定义，支持对已定义变量的引用。 最大长度：2048 表12 DeadLetterQueue 参数 是否必选 参数类型 描述 type 是 String 队列类型 枚举值： KAFKA instance_id 是 String 实例id 最小长度：1 最大长度：128 connection_id 是 String 目标连接id 最小长度：1 最大长度：128 topic 是 String 主题 最小长度：1 最大长度：128

支持的授权项 策略包含系统策略和自定义策略，如果系统策略不满足授权要求，管理员可以创建自定义策略，并通过给用户组授予自定义策略来进行精细的访问控制。策略支持的操作与API相对应，授权项列表说明如下： 权限：允许或拒绝某项操作。 对应API接口：自定义策略实际调用的API接口。 授权项：自定义策略中支持的Action，在自定义策略中的Action中写入授权项，可以实现授权项对应的权限功能。 IAM项目（Project）/企业项目（Enterprise Project）：自定义策略的授权范围，包括IAM项目与企业项目。授权范围如果同时支持IAM项目和企业项目，表示此授权项对应的自定义策略，可以在IAM和企业管理两个服务中给用户组授权并生效。如果仅支持IAM项目，不支持企业项目，表示仅能在IAM中给用户组授权并生效，如果在企业管理中授权，则该自定义策略不生效。关于IAM项目与企业项目的区别，详情请参见：IAM与企业管理的区别。 事件网格支持的自定义策略授权项如下表所示。用户调用如下API时，需要获取对应的权限。权限获取请参考 统一身份认证 服务（IAM）的帮助指导。 表1 事件网格授权项明细 权限 对应API接口 授权项 IAM项目(Project) 企业项目(Enterprise Project) 创建事件通道 POST /v1/{project_id}/channels eg:channels:create √ x 查看事件通道列表 GET /v1/{project_id}/channels eg:channels:list √ x 更新事件通道 PUT /v1/{project_id}/channels/{channel_id} eg:channels:update √ x 删除事件通道 DELETE /v1/{project_id}/channels/{channel_id} eg:channels:delete √ x 查看事件通道详情 GET /v1/{project_id}/channels/{channel_id} eg:channels:get √ x 发布事件到事件通道 POST /v1/{project_id}/channels/{channel_id}/events eg:channels:putEvents √ x 创建事件源 POST /v1/{project_id}/sources eg:sources:create √ x 查看事件源列表 GET /v1/{project_id}/sources eg:sources:list √ x 更新事件源 PUT /v1/{project_id}/sources/{source_id} eg:sources:update √ x 删除事件源 DELETE /v1/{project_id}/sources/{source_id} eg:sources:delete √ x 查看事件源详情 GET /v1/{project_id}/sources/{source_id} eg:sources:get √ x 查看事件目标分类列表 GET /v1/{project_id}/target-catalogs eg:targetCatalogs:list √ x 创建事件订阅 POST /v1/{project_id}/subscriptions eg:subscriptions:create √ x 查看事件订阅列表 GET /v1/{project_id}/subscriptions eg:subscriptions:list √ x 更新事件订阅 PUT /v1/{project_id}/subscriptions/{subscription_id} eg:subscriptions:update √ x 删除事件订阅 DELETE /v1/{project_id}/subscriptions/{subscription_id} eg:subscriptions:delete √ x 查看事件订阅详情 GET /v1/{project_id}/subscriptions/{subscription_id} eg:subscriptions:get √ x 操作事件订阅 POST /v1/{project_id}/subscriptions/operation eg:subscriptions:update √ x 创建事件模型 POST /v1/{project_id}/schemas eg:schemas:create √ x 查看事件模型列表 GET /v1/{project_id}/schemas eg:schemas:list √ x 更新事件模型 PUT /v1/{project_id}/schemas/{schema_id} eg:schemas:update √ x 删除事件模型 DELETE /v1/{project_id}/schemas/{schema_id} eg:schemas:delete √ x 查看事件模型详情 GET /v1/{project_id}/schemas/{schema_id} eg:schemas:get √ x 查看事件模型版本列表 GET /v1/{project_id}/schemas/{schema_id}/versions eg:schemas:listVersions √ x 查看事件模型版本详情 GET /v1/{project_id}/schemas/{schema_id}/versions/{version} eg:schemas:getVersion √ x 删除事件模型版本 DELETE /v1/{project_id}/schemas/{schema_id}/versions/{version} eg:schemas:deleteVersion √ x 发现事件模型 POST /v1/{project_id}/schema-discover eg:schemas:getDiscovered √ x 查询配额 GET /v1/{project_id}/quotas eg:quotas:list √ x

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

响应消息体（可选） 响应消息体通常以结构化格式返回，与响应消息头中Content-type对应，传递除响应消息头之外的内容。 对于获取用户Token接口，返回如下消息体。为篇幅起见，这里只展示部分内容。 { "token": { "expires_at": "2019-02-13T06:52:13.855000Z", "methods": [ "password" ], "catalog": [ { "endpoints": [ { "region_id": "XXXXXX",...... 当接口调用出错时，会返回错误码及错误信息说明，错误响应的Body体格式如下所示。 { "error_msg": "The format of message is error", "error_code": "AS.0001"} 其中，error_code表示错误码，error_msg表示错误描述信息。

请求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/tokensContent-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/tokensContent-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。

响应示例 状态码： 400 { "error_code" : "EG.00014000", "error_msg" : "Bad request"} 状态码： 401 { "error_code" : "EG.00014010", "error_msg" : "Incorrect token or token resolution failed"} 状态码： 403 { "error_code" : "EG.00014030", "error_msg" : "No permissions to request this method"} 状态码： 404 { "error_code" : "EG.00014040", "error_msg" : "Not request resource found"} 状态码： 500 { "error_code" : "EG.00015000", "error_msg" : "Internal Server Error"}

响应参数 状态码： 200 表4 响应Body参数 参数 参数类型 描述 total Integer 总数 最小值：0 最大值：100 size Integer 本页数量 最小值：0 最大值：100 items Array of CustomizeSchemaItemInfo objects 对象列表 数组长度：0 - 100 表5 CustomizeSchemaItemInfo 参数 参数类型 描述 id String 事件模型ID name String 事件模型名称，租户下唯一 description String 事件模型描述 compatibility String 事件模型兼容性 枚举值： NONE provider_type String 提供方类型，OFFICIAL：官方事件源；CUSTOM：自定义事件源 枚举值： 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 更新时间 状态码： 400 表6 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 401 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 403 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 404 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 500 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128

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

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

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

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

请求参数 表2 请求Header参数 参数 是否必选 参数类型 描述 X-Auth-Token 是 String 用户Token。通过调用IAM服务获取用户Token接口获取（响应消息头中X-Subject-Token的值）。 最小长度：1 最大长度：16384 表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 事件唯一标识串 状态码： 400 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 401 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 403 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 404 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 500 表12 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128

响应示例 状态码： 400 { "error_code" : "EG.00014000", "error_msg" : "Bad request"} 状态码： 401 { "error_code" : "EG.00014010", "error_msg" : "Incorrect token or token resolution failed"} 状态码： 403 { "error_code" : "EG.00014030", "error_msg" : "No permissions to request this method"} 状态码： 404 { "error_code" : "EG.00014040", "error_msg" : "Not request resource found"} 状态码： 500 { "error_code" : "EG.00015000", "error_msg" : "Internal Server Error"}

响应示例 状态码： 400 { "error_code" : "EG.00014000", "error_msg" : "Bad request"} 状态码： 401 { "error_code" : "EG.00014010", "error_msg" : "Incorrect token or token resolution failed"} 状态码： 403 { "error_code" : "EG.00014030", "error_msg" : "No permissions to request this method"} 状态码： 404 { "error_code" : "EG.00014040", "error_msg" : "Not request resource found"} 状态码： 500 { "error_code" : "EG.00015000", "error_msg" : "Internal Server Error"}

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

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

响应参数 状态码： 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 event_received_time Integer 状态码： 400 表7 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 401 表8 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 403 表9 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 404 表10 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128 状态码： 500 表11 响应Body参数 参数 参数类型 描述 error_code String 错误码 最小长度：1 最大长度：128 error_msg String 错误消息 最小长度：1 最大长度：512 error_details String 具体错误消息 最小长度：1 最大长度：1024 request_id String 请求处理ID 最小长度：1 最大长度：128

响应示例 状态码： 400 { "error_code" : "EG.00014000", "error_msg" : "Bad request"} 状态码： 401 { "error_code" : "EG.00014010", "error_msg" : "Incorrect token or token resolution failed"} 状态码： 403 { "error_code" : "EG.00014030", "error_msg" : "No permissions to request this method"} 状态码： 404 { "error_code" : "EG.00014040", "error_msg" : "Not request resource found"} 状态码： 500 { "error_code" : "EG.00015000", "error_msg" : "Internal Server Error"}

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

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