首页 云监控 开发参考 API参考 API目录 云产品监控 DescribeMetricList - 查询指定云产品的指定监控项的监控数据

DescribeMetricList - 查询指定云产品的指定监控项的监控数据

更新时间: 2023-09-05 15:22:06

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

接口说明

使用限制

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

使用说明

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

调试

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

调试

授权信息

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

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

请求参数

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

云产品的数据命名空间。命名方式:acs_云产品名称。

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

acs_ecs_dashboard
MetricNamestring

监控项名称。

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

cpu_idle
Periodstring

时间间隔。

取值:60、300、900。 单位:秒。

说明 请根据您的实际需求设置该参数。
60
StartTimestring

开始时间。支持的格式:

  • Unix时间戳:从1970年1月1日开始所经过的毫秒数。
  • Format格式:YYYY-MM-DDThh:mm:ssZ。
说明
  • 开始和结束时间执行的是左开右闭的模式,StartTime不能等于或大于EndTime。
    • StartTime和EndTime之间的间隔小于等于31天。
    2019-01-30 00:00:00
    EndTimestring

    结束时间。支持的格式:

    • Unix时间戳:从1970年1月1日开始所经过的毫秒数。
    • Format格式:YYYY-MM-DDThh:mm:ssZ。
    说明 StartTime和EndTime之间的间隔小于等于31天。
    2019-01-30 00:10:00
    Dimensionsstring

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

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

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

    分页游标标识。

    说明 如果不设置该参数,则表示获取第一页的数据。当该参数有返回值时,说明还有下一页,您可以将返回的NextToken作为参数再次请求获得下一页的数据,直到返回为Null为止,表示获取到了所有的数据。
    15761485350009dd70bb64cff1f0fff750b08ffff073be5fb1e785e2b020f1a949d5ea14aea7fed82f01dd8****
    Lengthstring

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

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

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

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

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

    返回参数

    名称类型描述示例值
    object
    NextTokenstring

    分页游标标识。

    15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****
    RequestIdstring

    请求ID。

    3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42
    Successboolean

    操作是否成功。取值:

    • true:成功。

    • false:失败。

    true
    Datapointsstring

    监控数据列表。

    [{"timestamp":1548777660000,"userId":"120886317861****","instanceId":"i-abc","Minimum":9.92,"Average":9.92,"Maximum":9.92}]
    Codestring

    状态码。

    说明 200表示成功。
    200
    Messagestring

    错误信息。

    The specified resource is not found.
    Periodstring

    时间间隔。单位:秒。取值:60、300、900。

    60

    示例

    正常返回示例

    JSON格式

    {
      "NextToken": "15761441850009dd70bb64cff1f0fff6d0b08ffff073be5fb1e785e2b020f7fed9b5e137bd810a6d6cff5ae****",
      "RequestId": "3121AE7D-4AFF-4C25-8F1D-C8226EBB1F42",
      "Success": true,
      "Datapoints": "[{\"timestamp\":1548777660000,\"userId\":\"120886317861****\",\"instanceId\":\"i-abc\",\"Minimum\":9.92,\"Average\":9.92,\"Maximum\":9.92}]",
      "Code": "200",
      "Message": "The specified resource is not found.",
      "Period": "60"
    }

    错误码

    HTTP status code错误码错误信息描述
    400%s%s-
    404ResourceNotFoundThe specified resource is not found.未找到指定资源。
    500InternalErrorThe request processing has failed due to some unknown error.-
    500InternalError%s-

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

    变更历史

    变更时间变更内容概要操作
    2023-03-10OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400
      删除错误码:403
      删除错误码:404
      删除错误码:500
    阿里云首页 云监控 相关技术圈