DescribeSiteMonitorStatistics-阿里云帮助中心

Operation description

This topic provides an example on how to query the average statistics of the Availability metric in the site monitoring task whose ID is ef4cdc8b-9dc7-43e7-810e-f950e56c****. The returned result shows that the availability is 100.

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:DescribeSiteMonitorStatistics

get

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
TaskId	string	Yes	The ID of the site monitoring task. For information about how to obtain the ID of a site monitoring task, see DescribeSiteMonitorList.	ef4cdc8b-9dc7-43e7-810e-f950e56c****
TimeRange	string	No	The statistical period. Unit: minutes. Default value: 1440 (1 day). Maximum value: 43200 (30 days).	1440
StartTime	string	No	The beginning of the time range to query. Unit: milliseconds. Default value: 1 hour before the current time.	1576142850527
MetricName	string	Yes	The name of the metric. Valid values: Availability: the availability. ErrorRate: the error rate. ResponseTime: the response time.	Availability

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

Response elements

Element	Type	Description	Example
	object
Code	string	The HTTP status code. Note The value 200 indicates that the call is successful.	200
Message	string	The returned message.	Successful
Data	string	The statistical result.	100
RequestId	string	The ID of the request.	3AD2724D-E317-4BFB-B422-D6691D071BE1
Success	string	Indicates whether the call is successful. Valid values: true: The call is successful. false: The call failed.	true

Examples

Success response

JSON format

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

Error codes

HTTP status code	Error code	Error message	Description
400	InvalidParameterValue	The specified parameter is not valid.
401	AccessDeniedException	You donot have sufficient access to perform this action.
500	InternalError	The request processing has failed due to some unknown error.
403	Forbidden	You are not authorized to operate the specified resource.	No permission, please use RAM to authorize
403	InvalidClientTokenId	The X.509 certificate or cms access key ID provided does not exist in our records.
206	%s	%s
503	%s	%s
406	%s	%s
429	Throttli∂ngException	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.