Querying Details of an Event

Function

This API is used to query details of an event based on the event name.

Event subcategory parameters are only available in regions CN East-Shanghai1, CN East-Shanghai2, CN North-Beijing4, and CN South-Guangzhou.

Debugging

You can debug the API in API Explorer which supports automatic authentication. API Explorer can automatically generate and debug example SDK code.

URI

GET /V1.0/{project_id}/event/{event_name}

• Parameter description

  Table 1 Parameter description

  Parameter	Type	Mandatory	Description
  project_id	String	Yes	Definition Project ID, which is used to specify the project that an asset belongs to. You can query the assets of a project by project ID. You can obtain the project ID from the API or console. For details about how to obtain the project ID, see Obtaining a Project ID. Constraints N/A Range 1 to 64 characters Default Value N/A
  event_name	String	Yes	Definition Event name. The name can be a system event name or a custom event name. Constraints N/A Range 1 to 64 characters Default Value N/A
  event_type	String	Yes	Definition Event type. Constraints N/A Range The value can be: EVENT.SYS: system event EVENT.CUSTOM: custom event Default Value N/A
  sub_event_type	String	No	Definition Event subcategory. Constraints N/A Range The options are as follows: If the event type is system event, the value can be SUB_EVENT.OPS (O&M event) or SUB_EVENT.PLAN (planned event). If the event type is custom event, the value is SUB_EVENT.CUSTOM (custom event). Default Value SUB_EVENT.OPS
  event_source	String	No	Definition Event source. The value is the namespace of each cloud service. For details about the namespaces of cloud services, see Events Supported by Event Monitoring.
  event_level	String	No	Constraints N/A Range The value cannot exceed 32 characters. Regular matching: ^((([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*\.([a-z]|[A-Z]){1}([a-z]|[A-Z]|[0-9]|_)*)|)$ Default Value N/A
  event_user	String	No	Definition Event severity, which can be Critical, Major, Minor, or Info. Constraints N/A Range Critical, Major, Minor, or Info Default Value N/A
  event_state	String	No	Definition Name of the user who reports the event monitoring data. It can also be a project ID. Constraints N/A Range The value cannot exceed 64 characters. Regular matching: ^([a-z]|[A-Z]|[0-9]|_|-|\/| |@|\.|)+$ Default Value N/A
  from	Long	No	Definition Event status, which can be normal, warning, or incident. Constraints N/A Range normal, warning, or incident Default Value N/A
  to	Long	No	Definition Start time of the query. The value is a UNIX timestamp, in milliseconds. Example: 1605952700911 Constraints N/A Range N/A Default Value N/A
  start	Integer	No	Definition End time of the query. The value is a UNIX timestamp, in milliseconds. Constraints from must be earlier than to. Range N/A Default Value N/A
  limit	Integer	No	Definition Pagination start value. Constraints N/A Range ≥ 0 Regular matching: ^(0|[1-9][0-9]*)$ Default Value 0 Definition Maximum number of records that can be queried at a time. The value range is (0,100] and the default value is 100. Constraints N/A Range 1 to 100 Regular matching: ^([1-9]|[1-9][0-9]|100)$ Default Value 100

• Example

  GET https://{Cloud Eye endpoint}/V1.0/{project_id}/event/{event_name}

Request

None

Response

• Response parameters

Returned Values

• Normal

  200

• Abnormal

  Returned Value	Description
  400 Bad Request	Request error.
  401 Unauthorized	The authentication information is not provided or is incorrect.
  403 Forbidden	Access to the requested page is forbidden.
  408 Request Timeout	The request timed out.
  429 Too Many Requests	Concurrent requests are excessive.
  500 Internal Server Error	Failed to complete the request because of an internal service error.
  503 Service Unavailable	The service is currently unavailable.

Error Codes

See Error Codes.