DescribeMetricLast - 查询指定监控项的最新监控数据

更新时间:
复制为 MD 格式

调用DescribeMetricLast接口查询指定监控项的最新监控数据。

接口说明

使用限制

  • 调用 DescribeMetricLast、DescribeMetricList、DescribeMetricData 和 DescribeMetricTop 的接口,有 100 万次/月免费额度(总计),当免费额度用完且您没有开通基础云监控按量计费时,将无法正常使用该 API。如果您已开通基础云监控的按量计费,当免费调用额度用完时,该 API 仍然可以正常使用,超出免费额度部分将自动按使用量计费。开通方法详见开通按量计费

  • 单个 API 的调用次数限制为 50 次/秒,即一个阿里云账号及该账号下的 RAM 用户共用 50 次/秒。

说明

当您调用 API 时,如果返回信息Throttling.UserRequest was denied due to user flow control,则说明该 API 被限流。处理方法,请参见如何处理查询 API 限流问题

注意事项

各云产品监控数据的存储时长与Period(统计周期)有关,Period越大,查询的监控数据越稀疏,监控数据的存储时间越长,具体关系如下:

  • Period小于 60 秒,存储时长为 7 天。

  • Period等于 60 秒,存储时长为 31 天。

  • Period大于等于 300 秒,存储时长为 91 天。

使用说明

本文将提供一个示例,查询云产品acs_ecs_dashboard监控项CPUUtilization的最新监控数据。返回结果显示,当前账号123456789876****下实例i-abcdefgh12****间隔 60 秒的最大值为 100、最小值为 93.1、平均值为 99.52。

调试

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

调试

授权信息

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

  • 操作:是指具体的权限点。

  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。

  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:

    • 对于必选的资源类型,用前面加 * 表示。

    • 对于不支持资源级授权的操作,用全部资源表示。

  • 条件关键字:是指云产品自身定义的条件关键字。

  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。

操作

访问级别

资源类型

条件关键字

关联操作

cms:QueryMetricLast

get

*全部资源

*

请求参数

名称

类型

必填

描述

示例值

Namespace

string

云产品的数据命名空间。

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

acs_ecs_dashboard

MetricName

string

云产品的监控项名称。

关于监控项名称,请参见云产品监控项

CPUUtilization

Period

string

监控数据的统计周期。

取值:15、60、900 和 3600。

单位:秒。

说明
  • 如果不设置统计周期,则按照注册监控项时申请的上报周期来查询监控数据。 - 每个云产品的监控项(MetricName)的统计周期不同。更多信息,请参见云产品监控项中目标云产品指标列表页面中的Min Periods列。

60

StartTime

string

查询监控项的开始时间。

2019-01-31 10:00:00

EndTime

string

查询监控项的结束时间。

  • 对于秒级数据,查询数据的起始时间是 EndTime 往前倒推 20 分钟后与 startTime 对比的最大值。

  • 对于分钟级数据,查询数据的起始时间是 EndTime 往前倒推 2 小时后与 startTime 对比的最大值。

  • 对于小时级数据,查询数据的起始时间是 EndTime 往前倒推 2 天后与 startTime 对比的最大值。

2019-01-31 10:10:00

Dimensions

string

指定资源的监控维度。

格式:key:value键值对形式的集合,例如:{"userId":"120886317861****"}{"instanceId":"i-2ze2d6j5uhg20x47****"}

说明

单次请求最多支持批量查询 50 个实例。

[{"instanceId":"i-2ze2d6j5uhg20x47****"}]

NextToken

string

分页游标的标识。

  • 如果匹配查询条件的返回结果超过了分页大小,则会返回这个分页游标。

  • 如果需要获取下一页数据,将返回的游标值作为请求参数即可,直到无游标值返回,表示已经获取了全部数据。

15761432850009dd70bb64cff1f0fff6c0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****

Length

string

返回监控数据的每页大小,用于分页查询。

默认值:1000,即每页 1000 条监控数据。

说明

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

1000

Express

string

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

{"groupby":["userId","instanceId"]}

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

返回参数

名称

类型

描述

示例值

object

NextToken

string

分页游标标识。

xxxxxx

RequestId

string

请求 ID。

021472A6-25E3-4094-8D00-BA4B6A5486C3

Success

boolean

操作是否成功。取值:

  • true:成功。

  • false:失败。

true

Datapoints

string

监控数据列表。

[{"timestamp":1548777660000,"userId":"123456789876****","instanceId":"i-abcdefgh12****","Minimum":93.1,"Average":99.52,"Maximum":100}]

Code

string

状态码。

说明

200 表示成功。

200

Message

string

错误信息。

The specified resource is not found.

Period

string

时间间隔。

单位:秒。

60

示例

正常返回示例

JSON格式

{
  "NextToken": "xxxxxx",
  "RequestId": "021472A6-25E3-4094-8D00-BA4B6A5486C3",
  "Success": true,
  "Datapoints": "[{\"timestamp\":1548777660000,\"userId\":\"123456789876****\",\"instanceId\":\"i-abcdefgh12****\",\"Minimum\":93.1,\"Average\":99.52,\"Maximum\":100}]",
  "Code": "200",
  "Message": "The specified resource is not found.",
  "Period": "60"
}

错误码

HTTP status code

错误码

错误信息

描述

400 ParameterInvalid Illegal parameters.
500 InternalError The request processing has failed due to some unknown error.
403 AccessForbidden User not authorized to operate on the specified resource.
404 ResourceNotFound The specified resource is not found. 未找到指定资源。

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

变更历史

更多信息,参考变更详情