DescribeSystemEventCount API Reference - Cloud Monitor - Alibaba Cloud - Cloud Monitor

Queries the number of events that occurred for each Alibaba Cloud service under the current account.

Operation description

Background information

You can call DescribeSystemEventMetaList to obtain the Alibaba Cloud services and their system events supported by CloudMonitor.

Operation description

This topic provides an example of how to query the number of events that occurred for Elastic Compute Service (ECS) under the current account. The response shows that a total of 3 events occurred.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:DescribeSystemEventCount

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Product	string	No	The name of the Alibaba Cloud service. Call the DescribeSystemEventMetaList operation to obtain the value of the `Product` response parameter, which provides the Alibaba Cloud service names for all events under the current Alibaba Cloud account. For more information, see DescribeSystemEventMetaList.	ECS
EventType	string	No	The event type. Call the DescribeSystemEventMetaList operation to obtain the value of the `EventType` response parameter, which provides the event types for all Alibaba Cloud services under the current Alibaba Cloud account. For more information, see DescribeSystemEventMetaList.	StatusNotification
Name	string	No	The event name. Call the DescribeSystemEventMetaList operation to obtain the value of the `Name` response parameter, which provides the event names for all Alibaba Cloud services under the current Alibaba Cloud account. For more information, see DescribeSystemEventMetaList.	Instance:StateChange
Level	string	No	The event level. Valid values: Critical: critical. Warn: warning. Info: information. Call the DescribeSystemEventMetaList operation to obtain the value of the `Level` response parameter, which provides the event levels for all Alibaba Cloud services under the current Alibaba Cloud account. For more information, see DescribeSystemEventMetaList.	Info
Status	string	No	The event status. Call the DescribeSystemEventMetaList operation to obtain the value of the `Status` response parameter, which provides the event statuses for all Alibaba Cloud services under the current Alibaba Cloud account. For more information, see DescribeSystemEventMetaList.	Normal
GroupId	string	No	The application group ID.	17285****
SearchKeywords	string	No	The keywords contained in the event content for searching. Valid values: To search for event content that contains both a and b, search for `a and b`. To search for event content that contains either a or b, search for `a or b`.	ECS
StartTime	string	No	The timestamp of the start time for the event query. Unit: milliseconds.	1635993541000
EndTime	string	No	The timestamp of the end time for the event query. Unit: milliseconds.	1635993921000

For more information about common request parameters, see Common parameters.

Response elements

Element	Type	Description	Example
	object
Code	string	The status code. Note A value of 200 indicates success.	200
Message	string	The returned message. If the request is successful, a success message is returned. If the request fails, the failure reason is returned.	success
RequestId	string	The request ID.	C7A7B776-0ACE-5A93-9B07-DE8008D9CCDF
Success	string	Indicates whether the operation is successful. Valid values: true: The operation is successful. false: The operation failed.	true
SystemEventCounts	object
SystemEventCount	array<object>	The event details.
	object	The event details.
Status	string	The status of the system event.	Normal
Time	integer	The time when the system event occurred. The value is a timestamp. Unit: milliseconds.	1635993751000
GroupId	string	The ID of the application group.	17285****
Product	string	The name of the cloud service in which the system event occurred.	ECS
InstanceName	string	The name of the instance.	ECS-test
Num	integer	The number of times that the system event has occurred.	3
ResourceId	string	The resource ID.	i-rj99xc6cptkk64ml****
Name	string	The name of the system event.	Instance:StateChange
Content	string	The description of the system event.	Instance status change notification
Level	string	The level of the system event. Valid values: Critical Warn Info	Info
RegionId	string	The region ID.	cn-hangzhou

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "success",
  "RequestId": "C7A7B776-0ACE-5A93-9B07-DE8008D9CCDF",
  "Success": "true",
  "SystemEventCounts": {
    "SystemEventCount": [
      {
        "Status": "Normal",
        "Time": 1635993751000,
        "GroupId": "17285****",
        "Product": "ECS",
        "InstanceName": "ECS-test",
        "Num": 3,
        "ResourceId": "i-rj99xc6cptkk64ml****",
        "Name": "Instance:StateChange",
        "Content": "Instance status change notification",
        "Level": "Info",
        "RegionId": "cn-hangzhou"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterInvalid	Illegal parameters.
500	InternalError	The request processing has failed due to some unknown error.
403	AccessForbidden	User not authorized to operate on the specified resource.
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.