# 获取在线服务事件列表 - ListInferServiceEvents #### 功能介绍 该接口适用于需要监控和管理在线服务事件的场景，例如用户或运维人员需要定期检查服务的日志事件，以及时发现和处理问题。通过调用此接口，用户可以获取当前在线服务的所有事件记录，包括事件类型、事件信息、时间、发生次数等信息。用户必须具有查询服务事件列表的权限，才能成功访问该接口。获取成功后，返回事件列表；若失败，返回具体的错误信息。常见异常包括权限验证错误、服务状态错误和参数验证错误。 #### 调试 您可以在[API Explorer](https://console.huaweicloud.com/apiexplorer/#/openapi/ModelArts/doc?api=ListInferServiceEvents)中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。 #### 授权信息 账号具备所有API的调用权限，如果使用账号下的IAM用户调用当前API，该IAM用户需具备调用API所需的权限。 - 如果使用角色与策略授权，具体权限要求请参见[权限和授权项](https://support.huaweicloud.com/api-modelarts/modelarts_03_0138.html)。 - 如果使用身份策略授权，需具备如下身份策略权限。 | 授权项 | 访问级别 | 资源类型（\*为必须） | 条件键 | 别名 | 依赖的授权项 | |:---|:---|:---|:---|:---|:---| | modelarts:service:get | Read | service \* | - | - | - | #### URI GET /v2/{project_id}/services/{service_id}/events 表1路径参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | project_id | 是 | String | **参数解释：** 用户项目ID。获取方法请参见[获取项目ID和名称](https://support.huaweicloud.com/api-modelarts/modelarts_03_0147.html)。 **约束限制：** 不涉及。 **取值范围：** 账号的项目ID。 **默认取值：** 不涉及。 | | service_id | 是 | String | **参数解释：** 服务ID，在[创建服务](https://support.huaweicloud.com/api-modelarts/CreateInferService.html#ZH-CN_TOPIC_0000002723741846)时即可在返回体中获取，也可通过[查询服务列表](https://support.huaweicloud.com/api-modelarts/ListInferServices.html#ZH-CN_TOPIC_0000002723741848)获取当前用户拥有的服务，其中service_id字段即为服务ID。 **约束限制：** 不涉及。 **取值范围：** 服务ID。 **默认取值：** 不涉及。 | 表2Query参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | event_type | 否 | String | **参数解释：** 在线服务事件类型。 **约束限制：** 不涉及。 **取值范围：** - NORMAL：正常 - ABNORMAL：异常 - WARNING：警告 **默认取值：** 不涉及。 | | start_time | 否 | Long | **参数解释：** 事件开始时间。 **约束限制：** 不涉及。 **取值范围：** 毫秒级时间戳，13位数字。 **默认取值：** 不涉及。 | | end_time | 否 | Long | **参数解释：** 事件结束时间。 **约束限制：** 不涉及。 **取值范围：** 毫秒级时间戳，13位数字。 **默认取值：** 不涉及。 | | event_info_key | 否 | String | **参数解释：** 事件信息过滤关键字。 **约束限制：** 不支持'";%_\*!@#$\&\\这些字符的查询。 | | limit | 否 | Integer | **参数解释：** 指定返回的最大条目数。 **约束限制：** 不涉及。 **取值范围：** \[1,500\] **默认取值：** 10。 | | offset | 否 | Integer | **参数解释：** 分页列表查询的偏移量。 **约束限制：** offset必须是limit的整数倍。 **取值范围：** 不涉及。 **默认取值：** 0。 | | sort_key | 否 | String | **参数解释：** 排序字段，多个字段以","分隔，支持create_at, update_at，默认值update_at。 **约束限制：** 不涉及。 **取值范围：** - create_at：按创建时间排序。 - update_at：按更新时间排序。 **默认取值：** update_at。 | | sort_dir | 否 | String | **参数解释：** 排序方式。 **约束限制：** 不涉及。 **取值范围：** - ASC: 递增排序。 - DESC: 递减排序。 **默认取值：** DESC。 | #### 请求参数 表3请求Header参数 | 参数 | 是否必选 | 参数类型 | 描述 | |:---|:---|:---|:---| | X-Auth-Token | 是 | String | **参数解释：** 用户Token。通过调用IAM服务获取用户Token接口获取响应消息头中X-Subject-Token的值。获取方法请参见[获取IAM用户Token（使用密码）](https://support.huaweicloud.com/api-modelarts/modelarts_03_0004.html)。 **约束限制：** 不涉及。 **取值范围：** 不涉及。 **默认取值：** 不涉及。 | | Content-Type | 是 | String | **参数解释：** 消息体的类型（格式）。 **约束限制：** 不涉及。 **取值范围：** - application/json - application/json;charset=utf-8 **默认取值：** 不涉及。 | #### 响应参数 **状态码：200** 表4响应Body参数 | 参数 | 参数类型 | 描述 | |:---|:---|:---| | current | Integer | **参数解释：** 当前页。 **取值范围：** 不涉及。 | | pages | Integer | **参数解释：** 总页数。 **取值范围：** 不涉及。 | | size | Integer | **参数解释：** 每一页的数量。 **取值范围：** 不涉及。 | | total | Integer | **参数解释：** 总记录数。 **取值范围：** 不涉及。 | | data | Array of [ServiceEventResponse] objects | **参数解释：** 服务事件列表。 **取值范围：** 不涉及。 | 表5ServiceEventResponse | 参数 | 参数类型 | 描述 | |:---|:---|:---| | id | String | **参数解释：** 服务事件ID。 **取值范围：** 不涉及。 | | service_id | String | **参数解释：** 服务ID。 **取值范围：** 不涉及。 | | service_version_id | String | **参数解释：** 服务版本ID。 **取值范围：** 不涉及。 | | event_count | Integer | **参数解释：** 服务事件发生计数 **取值范围：** 不涉及。 | | event_type | String | **参数解释：** 服务事件类型：NORMAL/ABNORMAL/WARNING **取值范围：** 不涉及。 | | event_info | String | **参数解释：** 服务事件信息（英文） **取值范围：** 不涉及。 | | event_info_cn | String | **参数解释：** 服务事件信息（中文） **取值范围：** 不涉及。 | | create_at | Long | **参数解释：** 服务事件第一次发生时间 **取值范围：** 不涉及。 | | update_at | Long | **参数解释：** 服务事件最后发生时间 **取值范围：** 不涉及。 | #### 请求示例 获取在线服务事件列表。 ``` GET https://{endpoint}/v2/{project_id}/services/{service_id}/events ``` #### 响应示例 **状态码：200** ``` { "current" : 0, "data" : [ { "create_at" : 1730446221357, "event_count" : 1, "event_info" : "Start to deploy service [xxx], version: 0.0.1, id: dcbadcba-dcba-dcba-dcba-dcbadcbadcba.", "event_info_cn" : "开始部署服务【xxx】，版本：0.0.1，ID：dcbadcba-dcba-dcba-dcba-dcbadcbadcba。", "event_type" : "NORMAL", "id" : "abcdabcd-abcd-abcd-abcd-abcdabcdabcd", "service_id" : "dcbadcba-dcba-dcba-dcba-dcbadcbadcba", "service_version_id" : "dcbadcba-dcba-dcba-dcba-dcbadcbadcba", "update_at" : 1730446221357 }, { "create_at" : 1730446254868, "event_count" : 1, "event_info" : "Service [xxx] create success.", "event_info_cn" : "服务【xxx】部署成功", "event_type" : "NORMAL", "id" : "abcdabcd-abcd-abcd-abcd-abcdabcdabcd", "service_id" : "dcbadcba-dcba-dcba-dcba-dcbadcbadcba", "service_version_id" : "dcbadcba-dcba-dcba-dcba-dcbadcbadcba", "update_at" : 1730446254868 } ], "pages" : 1, "size" : 10, "total" : 2 } ``` #### 状态码 | 状态码 | 描述 | |:---|:---| | 200 | 获取在线服务事件列表。 | #### 错误码 请参见[错误码](https://support.huaweicloud.com/api-modelarts/modelarts_03_0095.html)。