Queries the statistics of a site monitoring task in a specified period.

In this topic, the 49f7b317-7645-4cc9-94fd-ea42e522**** site monitoring task is specified as an example. The monitored metric is Availability. The result indicates that the availability rate of the site is 100%.

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 DescribeSiteMonitorData.

MetricName String Yes Availability

The name of the metric. Valid values:

  • Availability
  • ErrorRate
  • ResponseTime
TaskId String Yes ef4cdc8b-9dc7-43e7-810e-f950e56c****

The ID of the site monitoring task.

TimeRange String No 60

The interval at which monitoring data is returned. Unit: minutes. Maximum value: 1440.

StartTime String No 1576142850527

The timestamp that specifies the beginning of the time range to query. Unit: milliseconds.

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

Response parameters

Parameter Type Example Description
RequestId String 3AD2724D-E317-4BFB-B422-D6691D071BE1

The ID of the request.

Success String true

Indicates whether the call was successful. Valid values:

  • true: The call was successful.
  • false: The call failed.
Code String 200

The HTTP status code.

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

The statistics that were collected.

Message String Succcessful

The returned message.

Examples

Sample requests

http(s)://[Endpoint]/?Action=DescribeSiteMonitorStatistics
&MetricName=Availability
&TaskId=ef4cdc8b-9dc7-43e7-810e-f950e56c****
&<Common request parameters>

Sample success responses

XML format

<DescribeSiteMonitorStatisticsResponse>
	  <Message>successful</Message>
	  <RequestId>3AD2724D-E317-4BFB-B422-D6691D071BE1</RequestId>
	  <Data>100</Data>
	  <Code>200</Code>
	  <Success>true</Success>
</DescribeSiteMonitorStatisticsResponse>

JSON format

{
	"Message": "successful",
	"RequestId": "3AD2724D-E317-4BFB-B422-D6691D071BE1",
	"Data": 100,
	"Code": "200",
	"Success": true
}

Error codes

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