上报事件
功能介绍
事件监控为您提供上报自定义事件的接口，方便您将业务产生的异常事件或重要变更事件采集上报到云监控服务。
调试
您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。
URI
POST /V1.0/{project_id}/events
- 参数说明
表1 参数说明 名称
是否必选
说明
project_id
是
参数解释：
项目ID，用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见获取项目ID。
约束限制：
不涉及。
取值范围：
字符串长度在1 ~64 之间。
默认取值：
不涉及。
- 样例
POST https://{云监控的endpoint}/V1.0/{project_id}/events
请求消息
- 事件的time、project_id、event_source、event_name、event_type、sub_event_type、event_state、event_level、event_user、resource_id、resource_name字段相同时，则视为同一条事件。
- 事件子类参数当前只在华东-上海一、华东-上海二、华北-北京四、华南-广州区域上线，其余区域持续上线中。
- 请求参数
表2 参数说明 名称
参数类型
是否必选
说明
[数组元素]
Arrays of EventItem objects
是
参数解释：
上报自定义事件列表。请求参数。
约束限制：
数组长度为[1,100]
表3 EventItem字段数据结构说明 名称
是否必选
参数类型
说明
event_name
是
String
参数解释：
事件名称。
约束限制：
不涉及。
取值范围：
必须以字母开头，只能包含0-9/a-z/A-Z/_，长度为[1,64]个字符。
默认取值：
不涉及。
event_source
是
String
参数解释：
事件来源。
约束限制：
不涉及。
取值范围：
格式为service.item，根据实际情况自定义配置。
service和item必须是字符串，必须以字母开头，只能包含0-9/a-z/A-Z/_，service.item，长度为[3,32]个字符。。
默认取值：
不涉及。
time
是
Long
参数解释：
事件发生时间。UNIX时间戳，单位毫秒。
约束限制：
因为客户端到服务器端有延时，因此插入数据的时间戳应该在[当前时间-1小时+10秒，当前时间+10分钟-10秒]区间内，保证到达服务器时不会因为传输时延造成数据不能插入数据库。
取值范围：
插入数据的时间戳应该在[当前时间-1小时+10秒，当前时间+10分钟-10秒]区间内
默认取值：
不涉及。
detail
是
detail object
参数解释：
事件详情。
详细参数请参见表4。
约束限制：
不涉及。
表4 detail字段数据结构说明 名称
是否必选
参数类型
说明
content
否
String
参数解释：
事件内容
约束限制：
不涉及。
取值范围：
长度为[0,4096]个字符。
默认取值：
不涉及。
说明：部分场景下该字段不支持“\n”，此时“\n”会优先被转换“\\n”。
group_id
否
String
参数解释：
所属分组。
资源分组对应的ID，必须是已存在的分组ID。
分组ID查询方法：
约束限制：
不涉及。
取值范围：
长度只能为24个字符。
默认取值：
不涉及。
resource_id
否
String
参数解释：
资源ID。
资源ID的查询方法：
约束限制：
不涉及。
取值范围：
支持字母、数字支持字母、数字、下划线（_）、中划线（-）和冒号（:），最大长度128个字符。例如，6a69bf28-ee62-49f3-9785-845dacd799ec。
默认取值：
不涉及。
resource_name
否
String
参数解释：
资源名称。
约束限制：
不涉及。
取值范围：
支持字母 中文 数字_ -. ，最大长度128个字符。
默认取值：
不涉及。
event_state
否
String
参数解释：
事件状态。
约束限制：
不涉及。
取值范围：
枚举类型。
- normal：正常发生
- warning：异常
- incident：严重
默认取值：
不涉及。
event_level
否
String
参数解释：
事件级别。
约束限制：
不涉及。
取值范围：
枚举类型：Critical, Major, Minor, Info。
- 紧急-Critical
- 重要-Major
- 次要-Minor
- 提示-Info
默认取值：
不涉及。
event_user
否
String
参数解释：
事件用户。
约束限制：
不涉及。
取值范围：
支持字母 数字_ -/空格 ，字符最小长度0，最大长度64。
默认取值：
不涉及。
event_type
否
String
参数解释：
事件类型。
约束限制：
EVENT.SYS为系统事件，用户自己不能上报系，只能传EVENT.CUSTOM。
取值范围：
枚举类型，EVENT.SYS或EVENT.CUSTOM。
- EVENT.SYS：系统事件
- EVENT.CUSTOM：自定义事件
默认取值：
不涉及。
sub_event_type
否
String
参数解释：
事件子类。
约束限制：
不涉及。
取值范围：
枚举类型，当事件类型为系统事件时，参数值为SUB_EVENT.OPS或SUB_EVENT.PLAN。SUB_EVENT.OPS为运维事件，SUB_EVENT.PLAN为计划事件。
当事件类型为自定义事件时，参数值为SUB_EVENT.CUSTOM，表示自定义事件。
默认取值：
SUB_EVENT.OPS
dimensions
否
Array of objects
参数解释：
事件的维度，根据维度描述资源信息。
用于指定资源、资源分组的事件告警场景中，支持按维度配置告警规则。
详细参数说明请参见表5。
约束限制：
目前最大支持4个维度。
表5 dimensions字段数据结构说明 名称
类型
是否必选
描述
name
String
是
参数解释：
资源维度，例如弹性云服务器的维度为instance_id。各服务维度请参考支持监控的服务列表，可参考维度中key字段。
约束限制：
不涉及。
取值范围：
长度为[1,32]个字符。
默认取值：
不涉及。
value
String
是
参数解释：
资源维度值，为资源的实例ID，如：4270ff17-aba3-4138-89fa-820594c39755。
约束限制：
不涉及。
取值范围：
长度为[1,256]个字符。
默认取值：
不涉及。
- 请求样例
[{ "event_name":"systemInvaded", "event_source":"financial.System", "time":1522121194000, "detail":{ "content":"The financial system was invaded", "group_id":"rg15221211517051YWWkEnVd", "resource_id":"1234567890sjgggad", "resource_name":"ecs001", "event_state":"normal", "event_level":"Major", "event_user":"xiaokong", "event_type": "EVENT.CUSTOM", "sub_event_type": "SUB_EVENT.CUSTOM" } }, { "event_name":"systemInvaded", "event_source":"financial.System", "time":1522121194020, "detail":{ "content":"The financial system was invaded", "group_id":"rg15221211517051YWWkEnVd", "resource_id":"1234567890sjgggad", "resource_name":"ecs001", "event_state":"normal", "event_level":"Major", "event_user":"xihong", "event_type": "EVENT.CUSTOM", "sub_event_type": "SUB_EVENT.CUSTOM" } }]
响应消息
- 响应参数
表6 参数说明 名称
参数类型
说明
数组元素
Arrays of objects
参数解释：
事件列表。
详细参数请参见表7。
- 响应样例
[ { "event_id":"evdgiqwgedkkcvhdjcdu346", "event_name":"systemInvaded" }, { "event_id":"evdgiqwgedkkcvhdjcdu347", "event_name":"systemParalysis" } ]
返回值
错误码
请参考返回错误码说明。
