全部产品
Search

搜索本产品

    云监控：DescribeMetricData - 查询指定云产品的某个监控项的监控数据

    文档中心

    云监控：DescribeMetricData - 查询指定云产品的某个监控项的监控数据

    更新时间：Nov 08, 2024

    调用DescribeMetricData接口查询指定云产品的某个监控项的监控数据。

    接口说明

    使用限制

    • 调用 DescribeMetricLast、DescribeMetricList、DescribeMetricData 和 DescribeMetricTop 的接口，有 100 万次/月免费额度（总计），当免费额度用完且您没有开通基础云监控按量计费时，将无法正常使用该 API。如果您已开通基础云监控的按量计费，当免费调用额度用完时，该 API 仍然可以正常使用，超出免费额度部分将自动按使用量计费。开通方法详见开通按量计费。
    • 单个 API 的调用次数限制为 10 次/秒。一个阿里云账号及该账号下的 RAM 用户共用 10 次/秒。

    使用说明

    说明 与 DescribeMetricList 不同，本接口具有统计功能（即Dimension={"instanceId": "i-abcdefgh12****"}），将该账号下的所有监控数据进行聚合统计。

    本文将提供一个示例，查询云产品acs_ecs_dashboard监控项cpu_idle的监控数据。

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    Namespacestring是

    云产品的数据命名空间。

    关于云产品的数据命名空间，请参见云产品监控项。

    		acs_ecs_dashboard
    MetricNamestring是

    云产品的监控项名称。

    关于云产品的监控项名称，请参见云产品监控项。

    		cpu_idle
    Periodstring否

    监控项的统计周期。

    取值：15、60、900 和 3600。

    单位：秒。

    说明
  • 如果不设置统计周期，则按照注册监控项时申请的上报周期来查询监控数据。
    •
    		60
    StartTimestring否

    查询监控数据的开始时间。

    • 当您未设置StartTime和EndTime时，查询当前时间最近一个统计周期Period的监控数据。

    • 当您同时设置StartTime和EndTime时，查询指定时间段内距离EndTime最近一个统计周期Period的监控数据。具体如下：

      • 当Period设置为 15 秒时，指定时间段必须小于或等于 20 分钟。例如：StartTime 为 2021-05-08 08:10:00，EndTime 为 2021-05-08 08:30:00，统计距离 2021-05-08 08:30:00 最近一个 15 秒的监控数据。

      • 当Period设置为 60 秒或 900 秒时，指定时间段必须小于或等于 2 小时。例如：Period 为 60 秒，StartTime 为 2021-05-08 08:00:00，EndTime 为 2021-05-08 10:00:00，统计距离 2021-05-08 10:00:00 最近一个 60 秒的监控数据。

      • 当Period设置为 3600 秒时，指定时间段必须小于或等于 2 天。例如：StartTime 为 2021-05-08 08:00:00，EndTime 为 2021-05-10 08:00:00，统计距离 2021-05-10 08:00:00 最近一个 3600 秒的监控数据。

    开始时间支持的格式：

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

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

    说明
  • StartTime如果设置过早，则无效。
    •
    • 建议您使用 Unix 时间戳，避免时区的问题。
    		1618368900000
    EndTimestring否

    查询监控数据的结束时间。

    • 当您未设置StartTime和EndTime时，查询当前时间最近一个统计周期Period的监控数据。

    • 当您同时设置StartTime和EndTime时，查询指定时间段内距离EndTime最近一个统计周期Period的监控数据。具体如下：

      • 当Period设置为 15 秒时，指定时间段必须小于或等于 20 分钟。例如：StartTime 为 2021-05-08 08:10:00，EndTime 为 2021-05-08 08:30:00，统计距离 2021-05-08 08:30:00 最近一个 15 秒的监控数据。

      • 当Period设置为 60 秒或 900 秒时，指定时间段必须小于或等于 2 小时。例如：Period 为 60 秒，StartTime 为 2021-05-08 08:00:00，EndTime 为 2021-05-08 10:00:00，统计距离 2021-05-08 10:00:00 最近一个 60 秒的监控数据。

      • 当Period设置为 3600 秒时，指定时间段必须小于或等于 2 天。例如：StartTime 为 2021-05-08 08:00:00，EndTime 为 2021-05-10 08:00:00，统计距离 2021-05-10 08:00:00 最近一个 3600 秒的监控数据。

    结束时间支持的格式：

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

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

    说明 建议您使用 Unix 时间戳，避免时区的问题。
    		1618368960000
    Dimensionsstring否

    维度 Map，用于查询指定资源的监控数据。

    格式：key-value 键值对形式的集合，常用的 key-value 集合为instanceId:i-2ze2d6j5uhg20x47****。

    说明 单次请求最多支持批量查询 50 个实例。
    		[{"instanceId": "i-abcdefgh12****"}]
    Expressstring否

    对查询出的现有结果进行实时计算的表达式。

    说明 目前仅支持groupby（类似数据库groupby语句）。
    		{"groupby":["userId","instanceId"]}
    Lengthstring否

    每页显示的记录条数，用于分页查询。

    默认值：1000。

    说明 单次请求 Length 的最大值为 1440。
    		1000

    关于公共请求参数的详情，请参见公共参数。

    返回参数

    名称类型描述示例值
    object

    无。

    Codestring

    状态码。

    说明 200 表示成功。
    		200
    Messagestring

    错误信息。

    		The specified resource is not found.
    RequestIdstring

    请求 ID。

    		6A5F022D-AC7C-460E-94AE-B9E75083D027
    Datapointsstring

    监控数据列表。包括如下信息：

    • timestamp：发生报警的时间戳。

    • userId：发生报警的用户 ID。

    • instanceId：发生报警的实例 ID。

    • Minimum、Average、Maximum：报警规则。

    		[{\"timestamp\":1618368900000,\"Average\":95.8291666666667,\"Minimum\":65.48,\"Maximum\":100.0},{\"timestamp\":1618368960000,\"Average\":95.8683333333333,\"Minimum\":67.84,\"Maximum\":100.0}]
    Periodstring

    监控数据的统计周期。

    取值：15、60、900 和 3600。

    单位：秒。

    		60

    示例

    正常返回示例

    JSON格式

    {
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "6A5F022D-AC7C-460E-94AE-B9E75083D027",
  "Datapoints": "[{\\\"timestamp\\\":1618368900000,\\\"Average\\\":95.8291666666667,\\\"Minimum\\\":65.48,\\\"Maximum\\\":100.0},{\\\"timestamp\\\":1618368960000,\\\"Average\\\":95.8683333333333,\\\"Minimum\\\":67.84,\\\"Maximum\\\":100.0}]",
  "Period": "60"
}

    错误码

    HTTP status code错误码错误信息描述
    400ParameterInvalidIllegal parameters.-
    403AccessForbiddenUser not authorized to operate on the specified resource.-
    404ResourceNotFoundThe specified resource is not found.未找到指定资源。
    500InternalErrorThe request processing has failed due to some unknown error.-

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

    变更历史

    变更时间变更内容概要操作
    2024-01-23OpenAPI 错误码发生变更查看变更详情