文档

DescribeSiteMonitorData - 查询任务的细粒度监控数据

更新时间:

调用DescribeSiteMonitorData接口查询任务的细粒度监控数据。

调试

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

授权信息

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

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
cms:DescribeSiteMonitorDataRead
  • 全部资源
    *

请求参数

名称类型必填描述示例值
TaskIdstring

任务 ID。

49f7b317-7645-4cc9-94fd-ea42e522****
Typestring

监控的数据类型。取值:

  • metric:时序类指标监控
  • event:事件类监控
metric
MetricNamestring

监控项的名称。取值:

  • Availability:可用率
  • ResponseTime:响应时间
Availability
StartTimestring

开始时间。支持的格式:

  • Unix 时间戳:从 1970 年 1 月 1 日开始所经过的毫秒数。

  • Format 格式:YYYY-MM-DDThh:mm:ssZ。

1551579637000
EndTimestring

结束时间。支持的格式:

  • Unix 时间戳:从 1970 年 1 月 1 日开始所经过的毫秒数。

  • Format 格式:YYYY-MM-DDThh:mm:ssZ。

1551581437000
Periodstring

统计周期。单位:秒,取值为 60 或 60 的整数倍。

说明 默认根据探测频率最小周期返回数据。
60
NextTokenstring

分页游标。

49f7b317-7645-4cc9-94fd-ea42e5220930ea42e5220930ea42e522****
Lengthinteger

返回的数据点数量。

1000

返回参数

名称类型描述示例值
object
Datastring

监控数据。

[{"Maximum":247,"Mimimum":61,"Average":154,"userId":"127067667954****","taskId":"49f7b317-7645-4cc9-94fd-ea42e522****","timestamp":1551581760000}]
NextTokenstring

分页游标。

ea42e5220930ea42e522****
RequestIdstring

请求 ID。

3febb181-0d98-4af9-8b04-7faf36b048b9
Successstring

操作是否成功。true 表示成功,false 表示失败。

true
Codestring

状态码。

说明 200 表示成功。
200
Messagestring

返回信息。

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格式

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

JSON格式

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

错误码

HTTP status code错误码错误信息描述
400InvalidQueryParameter%s-
401AccessDeniedExceptionYou donot have sufficient access to perform this action.-
402LimitExceededThe quota for this customer had been reached.-
403ForbiddenYou are not authorized to operate the specified resource.没有权限,请使用RAM进行授权
406ExceedingQuotaExceeding quota limits.-
409%s%s-
429ThrottlingExceptionThe request was denied due to request throttling.-
500InternalError%s-

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)