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

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes DescribeCustomEventHistogram

The operation that you want to perform. Set the value to DescribeCustomEventHistogram.
Name String No BucketIngressBandwidth

The name of the custom event.
Level String No CRITICAL

The level of the custom event. Valid values:

  • CRITICAL
  • WARN
  • INFO
EventId String No 123

The ID of the custom event.
GroupId String No 12345

The ID of the application group.
SearchKeywords String No cms

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.
StartTime String No 1552209685596

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.

EndTime String No 1552220485596

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.

Response parameters

Parameter Type Example Description
RequestId String 486029C9-53E1-44B4-85A8-16A571A043FD

The ID of the request.
Code String 200

The HTTP status code.

Note The status code 200 indicates that the call was successful.
Success String true

Indicates whether the call was successful. The value true indicates a success. The value false indicates a failure.

EventHistograms Array N/A

The information about the number of times that the custom event occurred during each interval of a time period.

EventHistogram N/A N/A N/A
Count Long 3

The information about the number of times that the custom event occurred during an interval of a time period.

EndTime Long 1552226750000

The end of an interval.

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.

StartTime Long 1552226740000

The beginning of an interval.

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.

Message String success

The returned message. If the call was successful, the value success is returned. If the call failed, an error message is returned.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeCustomEventHistogram
&<Common request parameters>

Sample success responses

XML format 

<DescribeCustomEventHistogramResponse>
          <Message>success</Message>
          <RequestId>5977C7EE-E727-4EC4-B756-ECC8CB820CF4</RequestId>
          <EventHistograms>
                <EventHistogram>
                      <EndTime>1596000690000</EndTime>
                      <StartTime>1596000689000</StartTime>
                      <Count>0</Count>
                </EventHistogram>
                <EventHistogram>
                      <EndTime>1596000720000</EndTime>
                      <StartTime>1596000690000</StartTime>
                      <Count>0</Count>
                </EventHistogram>
                <EventHistogram>
                      <EndTime>1596000930000</EndTime>
                      <StartTime>1596000900000</StartTime>
                      <Count>0</Count>
                </EventHistogram>
                <EventHistogram>
                      <EndTime>1596000960000</EndTime>
                      <StartTime>1596000930000</StartTime>
                      <Count>0</Count>
                </EventHistogram>
                <EventHistogram>
                      <EndTime>1596000990000</EndTime>
                      <StartTime>1596000960000</StartTime>
                      <Count>0</Count>
                </EventHistogram>
          </EventHistograms>
          <Code>200</Code>
          <Success>true</Success>
</DescribeCustomEventHistogramResponse>

JSON format 

{
    "Message": "success",
    "RequestId": "5977C7EE-E727-4EC4-B756-ECC8CB820CF4",
    "EventHistograms": {
        "EventHistogram": [
            {
                "EndTime": 1596000690000,
                "StartTime": 1596000689000,
                "Count": 0
            },
            {
                "EndTime": 1596000720000,
                "StartTime": 1596000690000,
                "Count": 0
            },
            {
                "EndTime": 1596000930000,
                "StartTime": 1596000900000,
                "Count": 0
            },
            {
                "EndTime": 1596000960000,
                "StartTime": 1596000930000,
                "Count": 0
            },
            {
                "EndTime": 1596000990000,
                "StartTime": 1596000960000,
                "Count": 0
            }
        ]
    },
    "Code": "200",
    "Success": true
}

Error codes

For a list of error codes, visit the API Error Center.