Querying the Monitoring Details of an Event

project_id

Yes

String

Definition

Project ID. It 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, see Obtaining a Project ID.

Constraints

N/A

Range

1 to 64 characters

Default Value

N/A

event_name

Yes

String

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

Yes

String

Definition:

Event type.

Constraints:

N/A

Range:

The value can be:

• EVENT.SYS: system events

• EVENT.CUSTOM: custom events

Default Value:

N/A

sub_event_type

No

String

Definition:

Event subcategory.

Constraints:

N/A

Range:

The value can be:

• SUB_EVENT.OPS: O&M events

• SUB_EVENT.PLAN: planned events

• SUB_EVENT.CUSTOM: custom events

Default Value:

N/A

event_source

No

String

Definition:

Event source. The value is the namespace of each cloud service. For details, see Services Interconnected with Cloud Eye.

Constraints:

N/A

Range:

The value can contain 0 to 32 characters.

A regular expression matches a string that consists of letters, digits, and underscores (_), with a letter at the beginning and a dot (.) in the middle.

Default Value:

N/A

event_level

No

String

Definition:

Event severity.

Constraints:

N/A

Range:

The value can be:

• Critical

• Major

• Minor

• Info

Default Value:

N/A

event_user

No

String

Definition:

Name of the user who reports the event monitoring data. It can also be a project ID.

Constraints:

N/A

Range:

The value can contain 0 to 64 characters.

A regular expression that matches strings made up of letters (optional), digits, underscores (_), hyphens (-), slashes (/), spaces, at symbols (@), or dots (.).

Default Value:

N/A

event_state

No

String

Definition:

Event status

Constraints:

N/A

Range:

The value can be:

• normal

• warning

• incident

Default Value:

N/A

from

No

Long

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

to

No

Long

Definition:

End time of the query. The value is a UNIX timestamp in milliseconds.

Constraints:

The time of from must be earlier than that of to.

Range:

N/A

Default Value:

N/A

start

No

Long

Definition:

Pagination start value.

Constraints:

N/A

Range:

N/A

Default Value:

0

limit

No

Integer

Definition:

Maximum number of records that can be queried at a time.

Constraints:

N/A

Range:

The value is an integer ranging from 1 to 100.

Default Value:

100

Content-Type

No

String

Definition

MIME type of the request body.

Constraints

N/A

Range

1 to 64 characters

Default Value

The default value is application/json; charset=UTF-8. For APIs used to upload objects or images, the MIME type varies with the flow type.

X-Auth-Token

No

String

Definition

User token.

Constraints

N/A

Range

1 to 16,384 characters

Default Value

N/A

event_name

String

Definition:

Event name, which can be the name of a system event or a custom event.

Range:

N/A

event_type

String

Definition:

Event type.

Range:

The value can be:

• EVENT.SYS: system events

• EVENT.CUSTOM: custom events

sub_event_type

String

Definition:

Event subcategory.

Range:

The value can be:

If the event type is system event, the value can be SUB_EVENT.OPS or SUB_EVENT.PLAN.

If the event type is custom event, the value is SUB_EVENT.CUSTOM.

• SUB_EVENT.OPS: O&M event

• SUB_EVENT.PLAN: planned event

• SUB_EVENT.CUSTOM: custom event

event_users

Array of strings

Definition:

Name of the user who reports the event. It can also be a project ID.

Range:

N/A

event_sources

Array of strings

Definition:

Event source.

If the event is a system event, the source is the namespace of each service. For details, see "Services Interconnected with Cloud Eye". If the event is a custom event, the event source is defined by the user.

Range:

N/A

event_info

Array of EventInfoDetailResp objects

Definition:

Details of one or more events.

meta_data

TotalMetaData object

Definition:

Number of metadata records in the query results.

event_name

String

Definition:

Event name.

Range:

The value must start with a letter and allow 1 to 64 characters. It can only contain letters, digits, and underscores (_).

event_source

String

Definition:

Event source.

Range:

The value is in the service.item format. It allows 3 to 32 characters. service and item each must start with a letter and contain only letters, digits, and underscores (_).

time

Long

Definition:

Time when an event occurred. The value is a UNIX timestamp in milliseconds.

Range:

Since there is a latency between the client and the server, the timestamp when data was inserted must be within the time range [Current time – 1h + 20s, Current time + 10 mins – 20s]. In this way, the data will be inserted to the database without being affected by the latency.

detail

ShowEventItemDetailResp object

Definition:

Event details.

event_id

String

Definition:

Event ID.

Range:

N/A

content

String

Definition:

Event content.

Range:

1 to 4,096 characters

group_id

String

Definition:

Resource group that the event belongs to.

Range:

24 characters

resource_id

String

Definition:

Resource ID.

Range:

1 to 128 characters

resource_name

String

Definition:

Resource name.

Range:

1 to 128 characters

event_state

String

Definition:

Event status.

Range:

The value can be:

• normal

• warning

• incident

event_level

String

Definition:

Event severity.

Range:

The value can be:

• Critical

• Major

• Minor

• Info

event_user

String

Definition:

Event user.

Range:

The value allows 0 to 64 characters and can contain underscores (_), hyphens (-), slashes (/), at signs (@), and periods (.).

event_type

String

Definition:

Event type.

Range:

The value can be:

• EVENT.SYS: system events

• EVENT.CUSTOM: custom events

dimensions

Array of MetricsDimensionResp objects

Definition:

Event dimension. Resource information is described by dimension.

Event alarm rules can be configured by dimension to monitor specified resources and resource groups.

Range:

A maximum of four dimensions are supported.

name

String

Definition:

Dimension of a resource. For example, the dimension of an ECS can be instance_id. A maximum of four dimensions are supported. For the metric dimension of each resource, see Service metric dimension.

Range:

The value starts with a letter and can contain letters, digits, underscores (_), or hyphens (-). The length is [1,32] characters.

value

String

Definition

Resource dimension value, which is an instance ID, for example, 4270ff17-aba3-4138-89fa-820594c39755.

Range

1 to 256 characters

total

Integer

Definition

Total number of records.

Range

[0,2147483647]

-

String

Request error.

-

String

The authentication information is not provided or is incorrect.

-

String

Access to the requested page is forbidden.

-

String

The request timed out.

-

String

Too many requests.

-

String

Failed to complete the request because of an internal service error.

-

String

The system is currently unavailable.

200

OK

400

Bad Request

401

Unauthorized

403

Forbidden

408

Request Timeout

429

Too Many Requests

500

Internal Server Error

503

Service Unavailable