DescribeSiteMonitorData - CloudMonitor - Alibaba Cloud Documentation Center

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.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cms:DescribeSiteMonitorData	get	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	Yes	The job ID.	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 metric name. Valid values: Availability ResponseTime	Availability
StartTime	string	No	The start of the time range to query. The following formats are supported: UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 UTC on Thursday, January 1, 1970. UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format.	1551579637000
EndTime	string	No	The end of the time range to query. The following formats are supported: UNIX timestamp: the number of milliseconds that have elapsed since 00:00:00 UTC on Thursday, January 1, 1970. UTC time: the UTC time that follows the YYYY-MM-DDThh:mm:ssZ format.	1551581437000
Period	string	No	The statistical period. 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 token.	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 monitoring data.	[{"Maximum":247,"Mimimum":61,"Average":154,"userId":"127067667954**","taskId":"49f7b317-7645-4cc9-94fd-ea42e522**","timestamp":1551581760000}]
NextToken	string	The pagination token.	ea42e5220930ea42e522****
RequestId	string	The request ID.	3febb181-0d98-4af9-8b04-7faf36b048b9
Success	string	Indicates whether the request was successful. Valid values: true: The request was successful. false: The request failed.	true
Code	string	The responses code. Note The status code 200 indicates that the request was successful.	200
Message	string	The returned message.	Successful

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 available detection points.
UnavailableNumber: the number of unavailable detection points.
Availability: the availability rate.
Unavailability: the unavailability rate.
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 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	Description
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.	No permission, please use RAM to authorize
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.

Change history

Change time	Summary of changes	Operation

No change history