查询某一事件监控详情
功能介绍
根据事件监控名称,查询该事件发生的详细信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /V1.0/{project_id}/event/{event_name}
- 参数说明
表1 参数说明 名称
类型
是否必选
说明
project_id
String
是
项目ID。
获取方式请参见获取项目ID。
event_name
String
是
事件名称。
event_type
String
是
事件类型,值为EVENT.SYS或EVENT.CUSTOM。EVENT.SYS表示系统事件,EVENT.CUSTOM表示自定义事件。
event_source
String
否
事件名称,值为系统产生的事件名称,或用户自定义上报的事件名称。
event_level
String
否
事件的级别,值为Critical、Major、Minor、Info。Critical为紧急,Major为重要,Minor为次要,Info为提示。
event_user
String
否
上报事件监控数据时用户的名称,也可为projectID。
event_state
String
否
事件的状态,值为normal、warning、incident。normal为正常,warning为警告,incident为故障。
from
Integer
否
查询数据起始时间,UNIX时间戳,单位毫秒。例如:1605952700911。
to
Integer
否
查询数据截止时间,UNIX时间戳,单位毫秒。其中from必须小于to。
start
Integer
否
分页起始值,类型为integer,默认值为0。
limit
Integer
否
单次查询的条数限制,取值范围(0,100],默认值为100,用于限制结果数据条数。
- 样例
GET https://{云监控的endpoint}/V1.0/{project_id}/event/{event_name}
请求消息
无
响应消息
- 响应参数
名称 |
类型 |
是否必选 |
描述 |
---|---|---|---|
event_name |
String |
否 |
事件名称,值为系统产生的事件名称,或用户自定义上报的事件名称。 |
event_type |
String |
否 |
事件类型,值为EVENT.SYS或EVENT.CUSTOM。EVENT.SYS表示系统事件,EVENT.CUSTOM表示自定义事件。 |
event_users |
Array of strings |
否 |
上报事件时用户的名称,也可能为projectID。 |
event_sources |
Array of strings |
否 |
事件来源。如果是系统事件则值为各服务的命名空间,可查看支持监控的服务列表。如果是自定义事件,则为用户自定义上报定义。 |
event_info |
Array of objects |
否 |
一条或者多条事件详细信息。 详细参数说明请参见表3。 |
meta_data |
MetaData object |
否 |
查询结果元数据统计个数。 详细参数说明请参见表6。 |
名称 |
类型 |
是否必选 |
描述 |
---|---|---|---|
event_name |
String |
是 |
事件名称。必须以字母开头,只能包含0-9/a-z/A-Z/_,长度最短为1,最大为64。 |
event_source |
String |
否 |
事件来源,格式为service.item。service和item必须是字符串,必须以字母开头,只能包含0-9/a-z/A-Z/_,总长度最短为3,最大为32。 |
time |
Long |
是 |
事件发生时间。UNIX时间戳,单位毫秒。 说明:因为客户端到服务器端有延时,因此插入数据的时间戳应该在[当前时间-1小时+20秒,当前时间+10分钟-20秒]区间内,保证到达服务器时不会因为传输时延造成数据不能插入数据库。 |
detail |
Detail object |
是 |
事件详情。 详细参数说明请参见表4。 |
event_id |
String |
否 |
事件ID。 |
名称 |
类型 |
是否必选 |
描述 |
---|---|---|---|
content |
String |
否 |
事件内容,最大长度4096。 |
group_id |
String |
否 |
所属分组。 资源分组对应的ID,必须传存在的分组ID。 |
resource_id |
String |
否 |
资源ID,最大长度128。 |
resource_name |
String |
否 |
资源名称,最大长度128。 |
event_state |
String |
否 |
事件状态。 枚举类型:normal\warning\incident |
event_level |
String |
否 |
事件级别。 枚举类型:Critical, Major, Minor, Info |
event_user |
String |
否 |
事件用户,最大长度64。 |
event_type |
String |
否 |
事件类型。 枚举类型:EVENT.SYS,EVENT.CUSTOM EVENT.SYS为系统事件,EVENT.CUSTOM为自定义事件。 |
dimensions |
Array of objects |
否 |
一个或多个资源维度。 详细参数说明请参见表5。 |
名称 |
类型 |
是否必选 |
描述 |
---|---|---|---|
name |
String |
否 |
监控维度名称,例如弹性云服务器的维度为instance_id。各服务维度请参考支持监控的服务列表,可参考维度中key字段。 |
value |
String |
否 |
维度取值,例如弹性云服务器的ID。 长度最短为1,最大为256。 |
- 响应样例
{ "event_name": "rebootServer", "event_type": "EVENT.SYS", "event_users": [ "" ], "event_sources": [ "SYS.ECS" ], "event_info": [ { "event_id": "ev1606302402256R6doP5YeZ", "event_name": "rebootServer", "event_source": "SYS.ECS", "time": 1606302400000, "detail": { "content": "{\"resourceSpecCode\":\"kc1.4xlarge.2.linux\",\"enterpriseProjectId\":\"6efb843e-391a-46a8-afc8-7fe51c9dd575\"}", "group_id": "", "resource_id": "ef8dad27-0488-4de7-bb43-1a0df9806d90", "resource_name": "CES-POROS-0001", "event_state": "normal", "event_level": "Minor", "event_user": "", "event_type": "EVENT.SYS", "dimensions": [ { "name": "instance_id", "value": "fddad01f-e3b6-420d-8fdc-a42451de7c34" } ] } }, { "event_id": "ev1606296088071wGoAOxVYa", "event_name": "rebootServer", "event_source": "SYS.ECS", "time": 1606296086000, "detail": { "content": "{\"resourceSpecCode\":\"kc1.4xlarge.2.linux\",\"enterpriseProjectId\":\"6efb843e-391a-46a8-afc8-7fe51c9dd575\"}", "group_id": "", "resource_id": "ef8dad27-0488-4de7-bb43-1a0df9806d90", "resource_name": "CES-POROS-0001", "event_state": "normal", "event_level": "Minor", "event_user": "", "event_type": "EVENT.SYS", "dimensions": [ { "name": "instance_id", "value": "fddad01f-e3b6-420d-8fdc-a42451de7c34" } ] } }, { "event_id": "ev1604654426090g7g37E6Yb", "event_name": "rebootServer", "event_source": "SYS.ECS", "time": 1604654425000, "detail": { "content": "{\"resourceSpecCode\":\"c6.4xlarge.2.linux\",\"enterpriseProjectId\":\"129559eb-f795-4b5f-9e46-cbd43a462362\"}", "group_id": "", "resource_id": "0bfa63ee-31f5-40a9-b992-50992c80c58a", "resource_name": "ndrv2-pod-ops-0001", "event_state": "normal", "event_level": "Minor", "event_user": "", "event_type": "EVENT.SYS", "dimensions": [ { "name": "instance_id", "value": "fddad01f-e3b6-420d-8fdc-a42451de7c34" } ] } } ], "meta_data": { "total": 5 } }
返回值
错误码
请参考返回错误码说明。