Querying a Trace List
Function
This API is used to obtain the event information recorded in the system. This API is used when you need to query the event records recorded in the system when monitoring the system status, locating faults, or auditing. Before using this API, ensure that you have the required permission and the event records exist in the system. After the query, the API returns the event list, including the event ID, type, time, and description. If you do not have the required permission, the event record does not exist, or the query parameter is incorrect, the API will return an error message.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
GET /v1/{project_id}/events
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Definition: User project ID. For details, see Obtaining a Project ID and Name. Constraints: The value can contain 1 to 64 characters. Letters, digits, and hyphens (-) are allowed. Range: N/A Default Value: N/A |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
resource |
Yes |
String |
Definition: Type of the resource where the event is generated. The value can be pools, indicating the resource pool. Constraints: N/A Range: N/A Default Value: N/A |
|
name |
Yes |
String |
Definition: Name of the resource where the event is generated. Constraints: N/A Range: N/A Default Value: N/A |
|
limit |
No |
Integer |
Definition: Maximum number of records on each page. If this parameter is left blank or set to 0, 500 records are returned by default. A maximum of 500 records are allowed on each page. Constraints: N/A Range: N/A Default Value: N/A |
|
continue |
No |
String |
Definition: Marker of the previous page in pagination query. The value is a UUID string. This parameter is left blank when the first page is queried. Constraints: N/A Range: N/A Default Value: N/A |
|
since |
No |
Integer |
Definition: Timestamp of the event start time. Constraints: N/A Range: N/A Default Value: N/A |
|
until |
No |
Integer |
Definition: Timestamp of the event end time. Constraints: N/A Range: N/A Default Value: N/A |
|
type |
No |
String |
Definition: Event type. Constraints: N/A Range
Default Value: N/A |
Request Parameters
None
Response Parameters
Status code: 200
|
Parameter |
Type |
Description |
|---|---|---|
|
apiVersion |
String |
Definition: API version. Range:
|
|
kind |
String |
Definition: Resource type. Range:
|
|
metadata |
EventListMeta object |
Definition: Metadata of the event list. |
|
items |
Array of EventModel objects |
Definition: Event list. |
|
Parameter |
Type |
Description |
|---|---|---|
|
continue |
String |
Definition: Pagination marker. Range: N/A |
|
remainingItemCount |
Integer |
Definition: Number of remaining records on the current page. Range: N/A |
|
Parameter |
Type |
Description |
|---|---|---|
|
apiVersion |
String |
Definition: API version. Range:
|
|
kind |
String |
Definition: Resource type. Range:
|
|
type |
String |
Definition: Event type. Range:
|
|
firstTimestamp |
String |
Definition: Time when an event occurs for the first time. Range: N/A |
|
lastTimestamp |
String |
Definition: Time when an event occurs for the last time. Range: N/A |
|
count |
Integer |
Definition: Number of consecutive occurrences of an event. Range: N/A |
|
reason |
String |
Definition: Cause of an event. Range: N/A |
|
message |
String |
Definition: Event details. Range: N/A |
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Range: N/A |
|
error_msg |
String |
Definition: Error message. Range: N/A |
Status code: 404
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Range: N/A |
|
error_msg |
String |
Definition: Error message. Range: N/A |
Example Requests
This interface is used to query the trace list of resource pool pool-6f5da086876d4cd084d36f8bd3346036 by page.
/v1/{project_id}/events?resource=pools&name=pool-6f5da086876d4cd084d36f8bd3346036&limit=5&continue=cde36780-1120-4753-bf75-0edb9ebd5a9e
{ }
Example Responses
Status code: 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."
} ]
}
Status code: 400
Bad Request.
{
"error_code" : "ModelArts.50004000",
"error_msg" : "Bad request."
}
Status code: 404
Not Found.
{
"error_code" : "ModelArts.50015001",
"error_msg" : "Pool {name} not found."
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
OK. |
|
400 |
Bad Request. |
|
404 |
Not Found. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot