查询事件列表 - ListEvents
功能介绍
查询事件列表接口用于获取ModelArts OS服务中的事件记录信息。该接口适用于以下场景:在系统运维时监控服务运行状态、排查异常事件时定位问题根源、或审计用户操作记录时追溯事件详情。使用该接口的前提条件是用户需具备查看事件日志的权限且事件服务已启用,同时可选参数包括事件类型(如告警/操作/系统事件)、时间范围及分页参数。调用后将返回符合筛选条件的事件列表,包含事件时间、类型、描述及关联资源等信息,用户可根据返回数据进行故障分析或操作审计。若用户权限不足、事件服务未启用或请求参数超出范围,接口将返回对应错误码及提示信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
授权信息
账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限。
- 如果使用角色与策略授权,具体权限要求请参见权限和授权项。
- 如果使用身份策略授权,需具备如下身份策略权限。
URI
GET /v1/{project_id}/events
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释:用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:1-64字符,字母、数字和中划线。 取值范围:不涉及。 默认取值:不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| resource | 是 | String | 参数解释:事件所属资源类型。 约束限制:不涉及。 取值范围:可选值如下: 默认取值:不涉及。 |
| name | 是 | String | 参数解释:事件所属资源ID。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
| limit | 否 | Integer | 参数解释:单页查询最大数量,该值为空或者0时默认返回500条记录,单页最大允许查询500条记录。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
| offset | 否 | Integer | 参数解释:分页查询的偏移量,查询第一页时为空。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
| type | 否 | String | 参数解释:事件类型。 约束限制:不涉及。 取值范围:可选值如下: 该字段为空则返回所有类型的事件。 默认取值:不涉及。 |
| since | 否 | Integer | 参数解释:事件开始时间戳。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
| until | 否 | Integer | 参数解释:事件结束时间戳。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
| ascend | 否 | Boolean | 参数解释:是否为升序。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| apiVersion | String | 参数解释:API版本。 取值范围:可选值如下: |
| kind | String | 参数解释:资源类型。 取值范围:可选值如下: |
| metadata | EventListMeta object | 参数解释:事件列表的元信息。 |
| items | Array of EventModel objects | 参数解释:事件列表。 |
| total | Integer | 参数解释:总事件条数。 取值范围:不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| continue | String | 参数解释:分页标记。 取值范围:不涉及。 |
| remainingItemCount | Integer | 参数解释:分页剩余数量。 取值范围:不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| apiVersion | String | 参数解释:API版本。 取值范围:可选值如下: |
| kind | String | 参数解释:资源类型。 取值范围:可选值如下: |
| type | String | 参数解释:事件类型。 取值范围:可选值如下: |
| firstTimestamp | String | 参数解释:事件第一次出现时间。 取值范围:不涉及。 |
| lastTimestamp | String | 参数解释:事件最后一次出现时间。 取值范围:不涉及。 |
| count | Integer | 参数解释:事件连续出现次数。 取值范围:不涉及。 |
| reason | String | 参数解释:事件产生的原因。 取值范围:不涉及。 |
| message | String | 参数解释:事件详细信息。 取值范围:不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
状态码:404
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 错误码。 |
| error_msg | String | 错误描述。 |
请求示例
分页查询资源池pool-6f5da086876d4cd084d36f8bd3346036的事件列表。
GET https://{endpoint}/v1/{project_id}/events?resource=pools&name=pool-5ff6-6f5da086876d4cd084d36f8bd3346036&limit=10&offset=0&ascend=false
{ } 响应示例
状态码:200
{
"kind" : "EventList",
"apiVersion" : "v1",
"metadata" : {
"continue" : "52eddc13-cfad-42d3-aee4-92fea5813e7f"
},
"items" : [ {
"kind" : "Event",
"apiVersion" : "v1",
"type" : "Warning",
"firstTimestamp" : "2022-12-30T02:16:19Z",
"lastTimestamp" : "2022-12-30T02:16:19Z",
"count" : 1,
"reason" : "PoolResourcesStatusChange",
"message" : "Pool resources status changed, available/abnormal/creating/deleting count from 1/0/0/0 to 0/1/0/0, timestamp: 1672366579."
}, {
"kind" : "Event",
"apiVersion" : "v1",
"type" : "Normal",
"firstTimestamp" : "2023-01-02T09:02:45Z",
"lastTimestamp" : "2023-01-02T09:02:45Z",
"count" : 1,
"reason" : "PoolResourcesStatusChange",
"message" : "Pool resources status changed, available/abnormal/creating/deleting count from 0/1/0/0 to 1/0/0/0, timestamp: 1672650165."
}, {
"kind" : "Event",
"apiVersion" : "v1",
"type" : "Warning",
"firstTimestamp" : "2023-01-16T06:55:35Z",
"lastTimestamp" : "2023-01-16T06:55:35Z",
"count" : 1,
"reason" : "PoolStatusChange",
"message" : "Pool status changed, from Running to Abnormal, details: ."
}, {
"kind" : "Event",
"apiVersion" : "v1",
"type" : "Warning",
"firstTimestamp" : "2023-01-16T06:57:51Z",
"lastTimestamp" : "2023-01-16T06:57:51Z",
"count" : 1,
"reason" : "PoolResourcesStatusChange",
"message" : "Pool resources status changed, available/abnormal/creating/deleting count from 1/0/0/0 to 0/1/0/0, timestamp: 1673852271."
}, {
"kind" : "Event",
"apiVersion" : "v1",
"type" : "Normal",
"firstTimestamp" : "2023-01-29T02:29:04Z",
"lastTimestamp" : "2023-01-29T02:29:04Z",
"count" : 1,
"reason" : "PoolStatusChange",
"message" : "Pool status changed, from Abnormal to Running."
} ]
} 状态码:400
{
"error_code" : "ModelArts.50004000",
"error_msg" : "Bad request."
} 状态码:404
{
"error_code" : "ModelArts.50015001",
"error_msg" : "Pool {name} not found."
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | OK。 |
| 400 | Bad Request。 |
| 404 | Not Found。 |
错误码
请参见错误码。