DescribeCustomEventHistogram - Cloud Monitor - Alibaba Cloud Documentation Center

Queries the number of times that a custom event occurred during each interval within a period of time.

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:DescribeCustomEventHistogram

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The event name.	BucketIngressBandwidth
Level	string	No	The severity level of the event. Valid values: CRITICAL WARN INFO	CRITICAL
EventId	string	No	The event ID.	123
GroupId	string	No	The ID of the application group.	12345
SearchKeywords	string	No	The keywords that are used to search for the event. If you need to query the custom event whose content contains a and b, set the value to "a and b". If you need to query the custom event whose content contains a or b, set the value to "a or b".	cms
StartTime	string	No	The beginning of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1552209685596
EndTime	string	No	The end of the time range to query. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1552220485596

Response elements

Element	Type	Description	Example
	object
Code	string	The status code. Note The status code 200 indicates that the request was successful.	200
Message	string	The returned message. If the request was successful, a success message is returned. If the request failed, an error message is returned.	success
RequestId	string	The request ID.	486029C9-53E1-44B4-85A8-16A571A043FD
Success	string	Indicates whether the request was successful. Valid values: true and false.	true
EventHistograms	object
EventHistogram	array<object>	The information about the number of times that the custom event occurred during each interval of the specified time period.
	object
EndTime	integer	The end time. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1552226750000
StartTime	integer	The start time. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.	1552226740000
Count	integer	The information about the number of times that the custom event occurred during an interval of the specified time period.	3

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "success",
  "RequestId": "486029C9-53E1-44B4-85A8-16A571A043FD",
  "Success": "true",
  "EventHistograms": {
    "EventHistogram": [
      {
        "EndTime": 1552226750000,
        "StartTime": 1552226740000,
        "Count": 3
      }
    ]
  }
}

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.