DescribeSiteMonitorData - Cloud Monitor - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

cms:DescribeSiteMonitorData

get

*All Resource

*

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 elements

Element	Type	Description	Example
	object
NextToken	string	The pagination token.	ea42e5220930ea42e522****
Data	string	The monitoring data.	[{"Maximum":247,"Mimimum":61,"Average":154,"userId":"127067667954**","taskId":"49f7b317-7645-4cc9-94fd-ea42e522**","timestamp":1551581760000}]
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

Success response

JSON format

{
  "NextToken": "ea42e5220930ea42e522****",
  "Data": "[{\"Maximum\":247,\"Mimimum\":61,\"Average\":154,\"userId\":\"127067667954****\",\"taskId\":\"49f7b317-7645-4cc9-94fd-ea42e522****\",\"timestamp\":1551581760000}]",
  "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.
500	InternalError	%s
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
503	%s	%s
406	ExceedingQuota	Exceeding quota limits.	The number of tasks exceeds the limit
429	ThrottlingException	The request was denied due to request throttling.
409	%s	%s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.