Queries the statistics of a site monitoring task in a specified 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 DescribeSiteMonitorStatistics

The operation that you want to perform. Set the value to DescribeSiteMonitorStatistics.

MetricName String Yes Availability

The name of the metric to query. Valid values:

  • Availability
  • ErrorRate
  • ResponseTime
TaskId String Yes 49f7b317-7645-4cc9-94fd-ea42e522****

The ID of the site monitoring task.

StartTime String No 1576142850527

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.

TimeRange String No 60

The time period from which you want to collect statistics. Unit: minutes. Maximum value: 1440, which equals one day.

Response parameters

Parameter Type Example Description
RequestId String 3fcd12e7-d387-42ee-b77e-661c775bb17f

The ID of the request.

Success String true

Indicates whether the call was successful.

Code String 200

The HTTP status code.

Note The status code 200 indicates that the call was successful.
Data Long 100

The statistics that were collected.

Message String successful

The returned message.

Examples

Sample requests


http(s)://[Endpoint]/? Action=DescribeSiteMonitorStatistics
&MetricName=Availability
&TaskId=49f7b317-7645-4cc9-94fd-ea42e522****
&<Common request parameters>

Sample success responses

XML format

<Message>successful</Message>
<RequestId>3fcd12e7-d387-42ee-b77e-661c775bb17f</RequestId>
<Data>100</Data>
<Code>200</Code>
<Success>true</Success>

JSON format

{
	"Data":"123",
	"Message":"successful",
	"RequestId":"3fcd12e7-d387-42ee-b77e-661c775bb17f",
	"Success":true,
	"Code":"200"
}

Error codes

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