# 查询某一事件监控详情 - ListEventDetail #### 功能介绍 根据事件监控名称，查询该事件发生的详细信息。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/CES/doc?api=ListEventDetail&version=v1)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-ces/ces_03_0045.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | ces:events:get | Read | - | - | - | - | #### URI GET /V1.0/{project_id}/event/{event_name} 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释**: 项目ID。用于明确项目归属，配置后可通过该ID查询项目下资产，可以通过调用API获取，也可以从控制台获取。获取方式请参见[获取项目ID](https://support.huaweicloud.com/api-ces/ces_03_0057.html)。 **约束限制**: 不涉及。 **取值范围**: 长度为\[1,64\]个字符。 **默认取值**: 不涉及。 | | event_name | 是 | String | **参数解释**： 事件名称，输入自定义事件名称，或输入系统事件的事件ID。例如弹性云服务器的系统事件删除虚拟机，对应的event_name为deleteServer。各云服务支持的系统事件请参阅事件监控支持的事件说明[支持事件的服务列表](https://support.huaweicloud.com/api-ces/ces_01_0054.html)。 **约束限制**： 不涉及。 **取值范围**： 长度为\[1,64\]个字符。 **默认取值**： 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | event_type | 是 | String | **参数解释**： 事件类型。 **约束限制**： 不涉及。 **取值范围**： 值为EVENT.SYS或EVENT.CUSTOM。 - EVENT.SYS：系统事件。 - EVENT.CUSTOM：自定义事件。 **默认取值**： 不涉及。 | | sub_event_type | 否 | String | **参数解释**： 事件子类。 **约束限制**： 不涉及。 **取值范围**： 枚举类型 - SUB_EVENT.OPS: 运维事件 - SUB_EVENT.PLAN: 计划事件 - SUB_EVENT.CUSTOM: 自定义事件 **默认取值**： 不涉及。 | | event_source | 否 | String | **参数解释**： 事件来源，取值为各云服务的命名空间。云服务的命名空间请参考"[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)"。 **约束限制**： 不涉及。 **取值范围**： 长度为\[0,32\]个字符。 正则匹配：以字母开头，中间有一个点，包含字母、数字、下划线的字符串。 **默认取值**： 不涉及。 | | event_level | 否 | String | **参数解释**： 事件的级别。 **约束限制**： 不涉及。 **取值范围**： 值为Critical、Major、Minor、Info。 - Critical: 紧急 - Major: 重要 - Minor: 次要 - Info: 提示 **默认取值**： 不涉及。 | | event_user | 否 | String | **参数解释**： 上报事件监控数据时用户的名称，也可为projectID。 **约束限制**： 不涉及。 **取值范围**： 长度为\[0,64\]个字符。 正则匹配：由零个或多个字母、数字、下划线、横线、斜杠、空格、@ 符号或点号组成的字符串。 **默认取值**： 不涉及。 | | event_state | 否 | String | **参数解释**： 事件的状态。 **约束限制**： 不涉及。 **取值范围**： 值为normal、warning、incident。 - normal: 正常 - warning: 警告 - incident: 故障 **默认取值**： 不涉及。 | | from | 否 | Long | **参数解释**： 查询数据起始时间，UNIX时间戳，单位毫秒。例如：1605952700911。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | to | 否 | Long | **参数解释**： 查询数据截止时间，UNIX时间戳，单位毫秒。 **约束限制**： 其中from必须小于to。 **取值范围**： 不涉及。 **默认取值**： 不涉及。 | | start | 否 | Long | **参数解释**： 分页起始值。 **约束限制**： 不涉及。 **取值范围**： 不涉及。 **默认取值**： 0 | | limit | 否 | Integer | **参数解释**： 单次查询的条数限制，用于限制结果数据条数。 **约束限制**： 不涉及。 **取值范围**： 大小为\[1,100\]的整数 **默认取值**： 100 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | Content-Type | 否 | String | **参数解释**: 发送的实体的MIME类型。 **约束限制**: 不涉及。 **取值范围**: 长度为\[1,64\]个字符。 **默认取值**: 默认使用 application/json; charset=UTF-8，如果API是对象、镜像上传等接口，媒体类型可按照流类型的不同进行确定。 | | X-Auth-Token | 否 | String | **参数解释**: 用户Token。Token认证，具体操作请参考[认证鉴权](https://support.huaweicloud.com/api-ces/ces_03_0011.html)。 **约束限制**: 不涉及。 **取值范围**: 长度为\[1,16384\]个字符。 **默认取值**: 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | event_name | String | **参数解释**： 事件名称，值为系统产生的事件名称，或用户自定义上报的事件名称。 **取值范围**： 不涉及。 | | event_type | String | **参数解释**： 事件类型。 **取值范围**： 值为EVENT.SYS或EVENT.CUSTOM。 - EVENT.SYS: 系统事件。 - EVENT.CUSTOM: 自定义事件。 | | sub_event_type | String | **参数解释**： 事件子类。 **取值范围**： 枚举类型。 当事件类型为系统事件时，参数值为SUB_EVENT.OPS或SUB_EVENT.PLAN。 当事件类型为自定义事件时，参数值为SUB_EVENT.CUSTOM。 - SUB_EVENT.OPS：运维事件。 - SUB_EVENT.PLAN：计划事件。 - SUB_EVENT.CUSTOM：自定义事件。 | | event_users | Array of strings | **参数解释**： 上报事件时用户的名称，也可能为projectID。 **取值范围**： 不涉及。 | | event_sources | Array of strings | **参数解释**： 事件来源。 如果是系统事件则值为各服务的命名空间，可查看支持监控的服务列表。如果是自定义事件，则为用户自定义上报定义。 **取值范围**： 不涉及。 | | event_info | Array of [EventInfoDetailResp] objects | **参数解释**： 一条或者多条事件详细信息。 | | meta_data | [TotalMetaData] object | **参数解释**： 查询结果元数据统计个数。 | 表5EventInfoDetailResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | 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 | [ShowEventItemDetailResp] object | **参数解释**： 事件详情。 | | event_id | String | **参数解释**： 事件ID。 **取值范围**： 不涉及。 | 表6ShowEventItemDetailResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | content | String | **参数解释**： 事件内容。 **取值范围**： 长度为\[1,4096\]个字符。 | | group_id | String | **参数解释**： 所属分组。 **取值范围**： 长度只能为24个字符。 | | resource_id | String | **参数解释**： 资源ID。 **取值范围**： 长度为\[1,128\]个字符。 | | resource_name | String | **参数解释**： 资源名称。 **取值范围**： 长度为\[1,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: 自定义事件。 | | sub_event_type | String | **参数解释**： 事件子类。 **取值范围**： 枚举类型。 当事件类型为系统事件时，参数值为SUB_EVENT.OPS或SUB_EVENT.PLAN。 当事件类型为自定义事件时，参数值为SUB_EVENT.CUSTOM。 - SUB_EVENT.OPS：运维事件。 - SUB_EVENT.PLAN：计划事件。 - SUB_EVENT.CUSTOM：自定义事件。 | | dimensions | Array of [MetricsDimensionResp] objects | **参数解释**： 事件的维度，根据维度描述资源信息。 用于指定资源、资源分组的事件告警场景中，支持按维度配置告警规则。 **取值范围**： 目前最大支持4个维度 | 表7MetricsDimensionResp | 参数 | 参数类型 | 描述 | |:---|:---|:---| | name | String | **参数解释** 资源维度，如：弹性云服务器，则维度为instance_id；目前最大支持4个维度，各服务资源的维度名称，请参阅具体云服务的文档。您可以直接从[支持监控的服务列表](https://support.huaweicloud.com/api-ces/ces_03_0059.html)页面导航至相应文档。 **取值范围** 由字母开头，后面可以包含字母、数字、_或-，长度为\[1,32\]个字符 | | value | String | **参数解释** 资源维度值，为资源的实例ID，如：4270ff17-aba3-4138-89fa-820594c39755。 **取值范围** 长度为\[1,256\]个字符 | 表8TotalMetaData | 参数 | 参数类型 | 描述 | |:---|:---|:---| | total | Integer | **参数解释**： 总条数。 **取值范围**： 在\[0,2147483647\]区间内。 | **状态码：400** 表9响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 请求错误。 | **状态码：401** 表10响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 未提供认证信息，或认证信息错误。 | **状态码：403** 表11响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 请求页面被禁止访问。 | **状态码：408** 表12响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 请求超出了服务器的等待时间。 | **状态码：429** 表13响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 请求过多。 | **状态码：500** 表14响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 请求未完成，服务异常。 | **状态码：503** 表15响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | - | String | 系统暂时不可用，请求受限。 | #### 请求示例 ``` /V1.0/{project_id}/event/rebootServer?event_type=EVENT.SYS&start=0&limit=10&from=1603973487399&to=1606565487399 ``` #### 响应示例 **状态码：200** OK ``` { "event_name" : "rebootServer", "event_type" : "EVENT.SYS", "sub_event_type" : "SUB_EVENT.CUSTOM", "event_users" : [ "user001" ], "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" : "rg1606377637506DmVOENVyL", "resource_id" : "ef8dad27-0488-4de7-bb43-1a0df9806d90", "resource_name" : "CES-POROS-0001", "event_state" : "normal", "event_level" : "Minor", "event_user" : "user001", "event_type" : "EVENT.SYS", "sub_event_type" : "SUB_EVENT.OPS", "dimensions" : [ { "name" : "cluster_id", "value" : "xxxxxxxx002" } ] } }, { "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" : "rg1606377637506DmVOENVyL", "resource_id" : "ef8dad27-0488-4de7-bb43-1a0df9806d90", "resource_name" : "CES-POROS-0001", "event_state" : "normal", "event_level" : "Minor", "event_user" : "user001", "event_type" : "EVENT.SYS", "sub_event_type" : "SUB_EVENT.PLAN", "dimensions" : [ { "name" : "cluster_id", "value" : "xxxxxxxx002" } ] } }, { "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" : "rg1606377637506DmVOENVyL", "resource_id" : "0bfa63ee-31f5-40a9-b992-50992c80c58a", "resource_name" : "ndrv2-pod-ops-0001", "event_state" : "normal", "event_level" : "Minor", "event_user" : "user001", "event_type" : "EVENT.SYS", "sub_event_type" : "SUB_EVENT.OPS", "dimensions" : [ { "name" : "cluster_id", "value" : "xxxxxxxx002" } ] } } ], "meta_data" : { "total" : 5 } } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | OK | | 400 | Bad Request | | 401 | Unauthorized | | 403 | Forbidden | | 408 | Request Timeout | | 429 | Too Many Requests | | 500 | Internal Server Error | | 503 | Service Unavailable | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-ces/ErrorCode.html)。