调用DescribeSiteMonitorData查询站点监控任务的细粒度数据-云监控-阿里云

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用前面加 * 表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cms:DescribeSiteMonitorData

get

*全部资源

*

无

请求参数

名称	类型	必填	描述	示例值
TaskId	string	是	任务 ID。	49f7b317-7645-4cc9-94fd-ea42e522****
Type	string	否	监控的数据类型。取值： metric：时序类指标监控 event：事件类监控	metric
MetricName	string	是	监控项的名称。取值： Availability：可用率 ResponseTime：响应时间	Availability
StartTime	string	否	开始时间。支持的格式： Unix 时间戳：从 1970 年 1 月 1 日开始所经过的毫秒数。 Format 格式：YYYY-MM-DDThh:mm:ssZ。	1551579637000
EndTime	string	否	结束时间。支持的格式： Unix 时间戳：从 1970 年 1 月 1 日开始所经过的毫秒数。 Format 格式：YYYY-MM-DDThh:mm:ssZ。	1551581437000
Period	string	否	统计周期。单位：秒，取值为 60 或 60 的整数倍。说明默认根据探测频率最小周期返回数据。	60
NextToken	string	否	分页游标。	49f7b317-7645-4cc9-94fd-ea42e5220930ea42e5220930ea42e522****
Length	integer	否	返回的数据点数量。	1000

返回参数

名称	类型	描述	示例值
	object
NextToken	string	分页游标。	ea42e5220930ea42e522****
Data	string	监控数据。	[{"Maximum":247,"Mimimum":61,"Average":154,"userId":"127067667954**","taskId":"49f7b317-7645-4cc9-94fd-ea42e522**","timestamp":1551581760000}]
RequestId	string	请求 ID。	3febb181-0d98-4af9-8b04-7faf36b048b9
Success	string	操作是否成功。true 表示成功，false 表示失败。	true
Code	string	状态码。说明 200 表示成功。	200
Message	string	返回信息。	Successful

返回结果是一个 JSON 字符串，描述信息如下：

Error4XXRate：4XX 错误占比
Error6XXRate：6xx 错误占比
Error5XXRate：5xx 错误占比
Error4XXNumber：4xx 错误探针的数量
Error5XXNumber：5xx 错误探针的数量
Error6XXNumber：6xx 错误探针数量
Over5totalTime：响应时间超过 5000 毫秒的占比
Over3totalTime：响应时间超过 3000 毫秒的占比
Over2totalTime：响应时间超过 2000 毫秒的占比
Over10FailureRate：错误大于 10%所占的比例
Over100FailureRate：错误大于 99%所占的比例
Over30FailureRate：错误大于 30%所占的比例
Over50FailureRate：错误大于 50%所占的比例
Over80FailureRate：错误大于 80%所占的比例
Over90FailureRate：错误大于 90%所占的比例
Over400NumberRate：超过 4XX 错误所占的比例
Over500NumberRate：超过 5XX 错误所占的比例
AvailableNumber：可用探针数量
UnavailableNumber：不可用探测点数量
Availability：可用率
Unavailability：不可用率
ErrorCodeMaximum：最大错误码，例如：1 分钟内 5 个探测点有 4 个是 200， 1 个是 404，那么最大错误码就是 404
ErrorCodeMinimum：最小错误码，例如：1 分钟内 5 个探测点有 4 个是 200， 1 个是 404，那么最小错误码就是 200

说明

建议您使用 AvailableNumber、UnavailableNumber、Availability、Unavailability、ErrorCodeMaximum 或 ErrorCodeMinimum，其他计算方式较繁琐。

示例

正常返回示例

JSON格式

{
  "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"
}

错误码

HTTP status code	错误码	错误信息	描述
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.	没有权限，请使用RAM进行授权
503	%s	%s
406	ExceedingQuota	Exceeding quota limits.	任务数量超出限额
429	ThrottlingException	The request was denied due to request throttling.
409	%s	%s

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。