DescribeSiteMonitorData - CloudMonitor - Alibaba Cloud Documentation Center

Debugging

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

Debug

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	Yes	The ID of the site monitoring task.	49f7b317-7645-4cc9-94fd-ea42e522****
Type	string	No	The type of the monitored object whose monitoring data is to be queried. Valid values: metric event	metric
MetricName	string	Yes	The name of the metric. Valid values: Availability ResponseTime	Availability
StartTime	string	No	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.	1551579637000
EndTime	string	No	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.	1551581437000
Period	string	No	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.	60
NextToken	string	No	The pagination cursor.	49f7b317-7645-4cc9-94fd-ea42e5220930ea42e5220930ea42e522****
Length	integer	No	The number of data points to return.	1000

Response parameters

Parameter	Type	Description	Example
	object
Data	string	The returned monitoring data.	[{"Maximum":247,"Mimimum":61,"Average":154,"userId":"127067667954**","taskId":"49f7b317-7645-4cc9-94fd-ea42e522**","timestamp":1551581760000}]
NextToken	string	The pagination cursor.	ea42e5220930ea42e522****
RequestId	string	The ID of the request.	3febb181-0d98-4af9-8b04-7faf36b048b9
Success	string	Indicates whether the call was successful. The value true indicates a success. The value false indicates a failure.	true
Code	string	The HTTP status code. Note The status code 200 indicates that the call was successful.	200
Message	string	The returned message.	Successful

Examples

Sample success responses

JSONformat

{
  "Data": "[{\"Maximum\":247,\"Mimimum\":61,\"Average\":154,\"userId\":\"127067667954****\",\"taskId\":\"49f7b317-7645-4cc9-94fd-ea42e522****\",\"timestamp\":1551581760000}]",
  "NextToken": "ea42e5220930ea42e522****",
  "RequestId": "3febb181-0d98-4af9-8b04-7faf36b048b9",
  "Success": "true",
  "Code": "200",
  "Message": "Successful"
}

Error codes

HTTP status code	Error code	Error message
400	InvalidQueryParameter	%s
401	AccessDeniedException	You donot have sufficient access to perform this action.
402	LimitExceeded	The quota for this customer had been reached.
403	Forbidden	You are not authorized to operate the specified resource.
406	ExceedingQuota	Exceeding quota limits.
409	%s	%s
429	ThrottlingException	The request was denied due to request throttling.
500	InternalError	%s

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