文档首页/ 事件网格 EG/ API参考/ API/ 事件管理/ 发布官方事件到事件通道
更新时间：2023-12-12 GMT+08:00
查看PDF
分享

发布官方事件到事件通道

功能介绍

发布官方事件到事件通道。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/official/sources/{source_name}/events

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

租户项目ID

source_name

是

String

事件源名称

请求参数

表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"
}

状态码

状态码

描述

200

Information

400

非法请求

401

未授权

403

禁止访问

404

未找到资源

500

内部服务错误

错误码

请参见错误码。

父主题： 事件管理

相关文档