Queries the fine-grained monitoring data of a site monitoring task.

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 DescribeSiteMonitorData

The operation that you want to perform. Set the value to DescribeSiteMonitorData.
MetricName String Yes Availability

The name of the metric. Valid values:

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

The ID of the site monitoring task.
Type String No metric

The type of the monitored object whose monitoring data is to be queried. Valid values:

  • metric
  • event
StartTime String No 1551579637000

The beginning of the time range for the query. Supported formats:

  • UNIX timestamp: The value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
  • Time format: The value is in the YYYY-MM-DDThh:mm:ssZ format.
EndTime String No 1551581437000

The end of the time range for the query. Supported formats:

  • UNIX timestamp: The value is a UNIX timestamp representing the number of milliseconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.
  • Time format: The value is in the YYYY-MM-DDThh:mm:ssZ format.
Period String No 60

The interval at which monitoring data is returned. The value is an integral multiple of 60. Unit: seconds.

Note The default value equals the minimum interval at which detection requests are sent to the monitored address.
NextToken String No 49f7b317-7645-4cc9-94fd-ea42e5220930ea42e5220930ea42e522****

The pagination cursor.
Length Integer No 1000

The number of data points to return.

Response parameters

Parameter Type Example Description
RequestId String 3febb181-0d98-4af9-8b04-7faf36b048b9

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.

NextToken String ea42e5220930ea42e522****

The pagination cursor.
Data String [{"Maximum":247,"Mimimum":61,"Average":154,"userId":"127067667954****","taskId":"49f7b317-7645-4cc9-94fd-ea42e522****","timestamp":1551581760000}]

The returned monitoring data.
Message String Successful

The returned message.

The returned data contains a JSON string that may consist of several or all of the following parameters:

  • Error4XXRate: the percentage of detection results with 4XX status codes.
  • Error6XXRate: the percentage of detection results with 6XX status codes.
  • Error5XXRate: the percentage of detection results with 5XX status codes.
  • Error4XXNumber: the number of detection results with 4XX status codes.
  • Error5XXNumber: the number of detection results with 5XX status codes.
  • Error6XXNumber: the number of detection results with 6XX status codes.
  • Over5totalTime: the percentage of detection requests to which the response time exceeds 5,000 ms.
  • Over3totalTime: the percentage of detection requests to which the response time exceeds 3,000 ms.
  • Over2totalTime: the percentage of detection requests to which the response time exceeds 2,000 ms.
  • Over10FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 10%.
  • Over100FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 99%.
  • Over30FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 30%.
  • Over50FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 50%.
  • Over80FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 80%.
  • Over90FailureRate: the percentage of detection points whose failure rate of detection requests exceeds 90%.
  • Over400NumberRate: the percentage of detection results with status codes that are greater than 400.
  • Over400NumberRate: the percentage of detection results with status codes that are greater than 500.
  • AvailableNumber: the number of detection results in which the status code is smaller than 400.
  • UnavailableNumber: the number of detection results in which the status code is greater than 399.
  • Availability: the percentage of detection results in which the status code is smaller than 400.
  • Unavailability: the percentage of detection results in which the status code is greater than 399.
  • ErrorCodeMaximum: the maximum error code in the detection results that were returned in a specific period. Assume that five status codes are returned in a minute after detection requests are sent from five detection points. The status code in four detection results is 200 and that in one detection result is 404. In this case, the maximum error code is 404.
  • ErrorCodeMinimum: the minimum error code in the detection results returned in a monitoring period. Assume that five status codes are returned in a minute after detection requests are sent from five detection points. The status code in four detection results is 200 and that in one detection result is 404. In this case, the minimum error code is 200.
Note We recommend that you use the AvailableNumber, UnavailableNumber, Availability, Unavailability, ErrorCodeMaximum, or ErrorCodeMinimum metric, whose value is easy to calculate.

Examples

Sample requests

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

Sample success responses

XML format 

<DescribeSiteMonitorData>
		  <Data>
			    <Over5totalTime>0</Over5totalTime>
			    <Error4XXRate>0</Error4XXRate>
			    <UnavailableNumber>0</UnavailableNumber>
			    <Over2totalTime>0</Over2totalTime>
			    <timestamp>1551581040000</timestamp>
			    <Over100FailureRate>0</Over100FailureRate>
			    <Over10FailureRate>0</Over10FailureRate>
			    <Availability>100</Availability>
			    <Over80FailureRate>0</Over80FailureRate>
			    <userId>123****</userId>
			    <AvailableNumber>2</AvailableNumber>
			    <Unavailability>0</Unavailability>
			    <ErrorCodeMaximum>0</ErrorCodeMaximum>
			    <Over10totalTime>0</Over10totalTime>
			    <taskId>49f7b317-7645-4cc9-94fd-1****</taskId>
			    <Over30FailureRate>0</Over30FailureRate>
			    <Error6XXRate>0</Error6XXRate>
			    <Over500NumberRate>0</Over500NumberRate>
			    <Over3totalTime>0</Over3totalTime>
			    <Over400NumberRate>0</Over400NumberRate>
			    <Error5XXRate>0</Error5XXRate>
			    <Error5XXNumber>0</Error5XXNumber>
			    <Over90FailureRate>0</Over90FailureRate>
			    <Error4XXNumber>0</Error4XXNumber>
			    <Over50FailureRate>0</Over50FailureRate>
			    <ErrorCodeMinimum>0</ErrorCodeMinimum>
			    <Error6XXNumber>0</Error6XXNumber>
		  </Data>
		  <Data>
			    <Over5totalTime>0</Over5totalTime>
			    <Error4XXRate>0</Error4XXRate>
			    <UnavailableNumber>0</UnavailableNumber>
			    <Over2totalTime>0</Over2totalTime>
			    <timestamp>1551581100000</timestamp>
			    <Over100FailureRate>0</Over100FailureRate>
			    <Over10FailureRate>0</Over10FailureRate>
			    <Availability>100</Availability>
			    <Over80FailureRate>0</Over80FailureRate>
			    <userId>12345</userId>
			    <AvailableNumber>2</AvailableNumber>
			    <Unavailability>0</Unavailability>
			    <ErrorCodeMaximum>0</ErrorCodeMaximum>
			    <Over10totalTime>0</Over10totalTime>
			    <taskId>49f7b317-7645-4cc9-94fd-1****</taskId>
			    <Over30FailureRate>0</Over30FailureRate>
			    <Error6XXRate>0</Error6XXRate>
			    <Over500NumberRate>0</Over500NumberRate>
			    <Over3totalTime>0</Over3totalTime>
			    <Over400NumberRate>0</Over400NumberRate>
			    <Error5XXRate>0</Error5XXRate>
			    <Error5XXNumber>0</Error5XXNumber>
			    <Over90FailureRate>0</Over90FailureRate>
			    <Error4XXNumber>0</Error4XXNumber>
			    <Over50FailureRate>0</Over50FailureRate>
			    <ErrorCodeMinimum>0</ErrorCodeMinimum>
			    <Error6XXNumber>0</Error6XXNumber>
		  </Data>
		  <RequestId>DBDEAC51-EA3C-4853-8F25-6B48D38A28A9</RequestId>
		  <Success>true</Success>
		  <Code>200</Code>
</DescribeSiteMonitorData>

JSON format 

{
    "Data": [
        {
            "Over5totalTime": 0,
            "Error4XXRate": 0,
            "UnavailableNumber": 0,
            "Over2totalTime": 0,
            "timestamp": 1551581040000,
            "Over100FailureRate": 0,
            "Over10FailureRate": 0,
            "Availability": 100,
            "Over80FailureRate": 0,
            "userId": "123****",
            "AvailableNumber": 2,
            "Unavailability": 0,
            "ErrorCodeMaximum": 0,
            "Over10totalTime": 0,
            "taskId": "49f7b317-7645-4cc9-94fd-1****",
            "Over30FailureRate": 0,
            "Error6XXRate": 0,
            "Over500NumberRate": 0,
            "Over3totalTime": 0,
            "Over400NumberRate": 0,
            "Error5XXRate": 0,
            "Error5XXNumber": 0,
            "Over90FailureRate": 0,
            "Error4XXNumber": 0,
            "Over50FailureRate": 0,
            "ErrorCodeMinimum": 0,
            "Error6XXNumber": 0
        },
        {
            "Over5totalTime": 0,
            "Error4XXRate": 0,
            "UnavailableNumber": 0,
            "Over2totalTime": 0,
            "timestamp": 1551581100000,
            "Over100FailureRate": 0,
            "Over10FailureRate": 0,
            "Availability": 100,
            "Over80FailureRate": 0,
            "userId": "12345",
            "AvailableNumber": 2,
            "Unavailability": 0,
            "ErrorCodeMaximum": 0,
            "Over10totalTime": 0,
            "taskId": "49f7b317-7645-4cc9-94fd-1****",
            "Over30FailureRate": 0,
            "Error6XXRate": 0,
            "Over500NumberRate": 0,
            "Over3totalTime": 0,
            "Over400NumberRate": 0,
            "Error5XXRate": 0,
            "Error5XXNumber": 0,
            "Over90FailureRate": 0,
            "Error4XXNumber": 0,
            "Over50FailureRate": 0,
            "ErrorCodeMinimum": 0,
            "Error6XXNumber": 0
        }
    ],
    "RequestId": "DBDEAC51-EA3C-4853-8F25-6B48D38A28A9",
    "Success": true,
    "Code": "200"
}

Error codes

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