DescribeCustomEventCount - CloudMonitor - Alibaba Cloud Documentation Center

Queries the number of times that a custom event occurred in a specified time period.

Operation description

Note This operation counts the number of times that a custom event occurred for each service.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cms:DescribeCustomEventCount	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
Name	string	No	The name of the custom event.	BABEL_BUY
EventId	string	No	The ID of the custom event.	123
GroupId	string	No	The ID of the application group.	12345
SearchKeywords	string	No	The keywords that are contained in the content of the custom event to query. You can use a logical operator between keywords. 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 the epoch time 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 the epoch time January 1, 1970, 00:00:00 UTC.	1552220485596

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The HTTP status code. Note The status code 200 indicates that the call was successful.	200
Message	string	The returned message. If the call was successful, the value success is returned. If the call failed, an error message is returned.	success
RequestId	string	The ID of the request.	60912C8D-B340-4253-ADE7-61ACDFD25CFC
Success	boolean	Indicates whether the call was successful. The value true indicates a success. The value false indicates a failure.	true
CustomEventCounts	array<object>	The details of the custom event.
	object
Time	long	The time when the custom event occurred. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.	1552267615000
Num	integer	The number of times that the custom event occurred in the specified time period.	20
Name	string	The name of the custom event.	BABEL_BUY

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "success",
  "RequestId": "60912C8D-B340-4253-ADE7-61ACDFD25CFC",
  "Success": true,
  "CustomEventCounts": {
    "CustomEventCount": [
      {
        "Time": 1552267615000,
        "Num": 20,
        "Name": "BABEL_BUY"
      }
    ]
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterInvalid	Illegal parameters.	-
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.
500	InternalError	The request processing has failed due to some unknown error.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history