查询事件列表
功能介绍
查询事件列表接口用于获取系统中记录的事件信息。该接口适用于以下场景:当用户需要监控系统状态、排查问题或进行审计时,可通过此接口查询系统中发生的事件记录。使用该接口的前提条件是用户具有相应的权限,并且系统中已存在事件记录。查询操作完成后,接口将返回事件列表,包含事件ID、类型、时间、描述等信息。若用户无权限、事件记录不存在或查询参数有误,接口将返回相应的错误信息。
调试
您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。
URI
GET /v1/{project_id}/events
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
project_id |
是 |
String |
参数解释: 用户项目ID。获取方法请参见获取项目ID和名称。 约束限制:1 - 64字符,字母、数字和中划线。 取值范围:不涉及。 默认取值:不涉及。 |
|
参数 |
是否必选 |
参数类型 |
描述 |
|---|---|---|---|
|
resource |
是 |
String |
参数解释:事件所属资源类型。可选值为pools,表示资源池。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
name |
是 |
String |
参数解释:事件所属资源名称。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
limit |
否 |
Integer |
参数解释:单页查询最大数量,该值为空或者0时默认返回500条记录,单页最大允许查询500条记录。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
continue |
否 |
String |
参数解释:分页查询的上一页标记,内容为UUID字符串,查询第一页时为空。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
since |
否 |
Integer |
参数解释:事件开始时间戳。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
until |
否 |
Integer |
参数解释:事件结束时间戳。 约束限制:不涉及。 取值范围:不涉及。 默认取值:不涉及。 |
|
type |
否 |
String |
参数解释:事件类型。 约束限制:不涉及。 取值范围:可选值如下:
默认取值:不涉及。 |
请求参数
无
响应参数
状态码:200
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
apiVersion |
String |
参数描述:API版本。 取值范围:可选值如下:
|
|
kind |
String |
参数描述:资源类型。 取值范围:可选值如下:
|
|
metadata |
EventListMeta object |
参数描述:事件列表的元信息。 |
|
items |
Array of EventModel objects |
参数描述:事件列表。 |
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
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 |
参数解释:ModelArts错误码。 取值范围:不涉及。 |
|
error_msg |
String |
参数解释:具体错误信息。 取值范围:不涉及。 |
状态码:404
|
参数 |
参数类型 |
描述 |
|---|---|---|
|
error_code |
String |
参数解释:ModelArts错误码。 取值范围:不涉及。 |
|
error_msg |
String |
参数解释:具体错误信息。 取值范围:不涉及。 |
请求示例
分页查询资源池pool-6f5da086876d4cd084d36f8bd3346036的事件列表。
/v1/{project_id}/events?resource=pools&name=pool-6f5da086876d4cd084d36f8bd3346036&limit=5&continue=cde36780-1120-4753-bf75-0edb9ebd5a9e
{ }
响应示例
状态码:200
OK。
{
"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
Bad Request。
{
"error_code" : "ModelArts.50004000",
"error_msg" : "Bad request."
}
状态码:404
Not Found。
{
"error_code" : "ModelArts.50015001",
"error_msg" : "Pool {name} not found."
}
状态码
|
状态码 |
描述 |
|---|---|
|
200 |
OK。 |
|
400 |
Bad Request。 |
|
404 |
Not Found。 |
错误码
请参见错误码。