全部产品
Search

搜索本产品

    云服务器 ECS：DescribeMetricData - 查询监控指标

    文档中心

    云服务器 ECS：DescribeMetricData - 查询监控指标

    更新时间：Nov 12, 2024

    查询资源监控指标。

    调试

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

    授权信息

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

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

    请求参数

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

    指标名称。可选的值有：

    • disk_bps_percent
    • disk_iops_percent
    • disk_read_block_size
    • disk_read_bps
    • disk_read_iops
    • disk_read_latency
    • disk_write_block_size
    • disk_write_bps
    • disk_write_iops
    • disk_write_latency
    		disk_bps_percent
    StartTimestring否

    获取指标数据的起始时间点。最远可选当前时刻过去一年内的时刻作为起始时间点。当 StartTime 和 EndTime 参数都为空时，默认查询最近一个 period 的监控指标。按照 ISO 8601 标准表示，并使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。

    		2023-11-21T01:50:00Z
    EndTimestring否

    获取指标数据的结束时间点。不应大于当前时刻。按照 ISO 8601 标准表示，并使用 UTC +0 时间，格式为 yyyy-MM-ddTHH:mm:ssZ。

    		2023-11-21T02:00:00Z
    Periodinteger否

    获取指标数据的间隔时间。单位：秒。默认值为 5 秒。可选的取值：

    • 5：5s 精度查询，可查询 12 小时时间长度
    • 10：10s 精度查询，可查询 24 小时时间长度
    • 60：60s 精度查询，可查询 7 天时间长度

    其中，disk_slow_io_triggerred 指标只支持 60s 精度查询。

    		60
    Dimensionsstring否

    维度 Map，JSON 格式，表示查询的维度，当前可选的键为：diskId（云盘名）。

    		{"diskId":["d-bp14xxxx","d-bp11xxxx"]}
    RegionIdstring否

    地域 ID。

    		cn-shanghai
    AggreOpsstring否

    时间维度聚合方式。可选的值有：

    • SUM
    • COUNT
    • AVG
    • MAX
    • MIN
    		SUM

    返回参数

    名称类型描述示例值
    object

    DescribeMetricDataResponse

    TotalCountinteger

    查询到的数据总数。

    		1
    DataListarray<object>

    云盘的监控数据集合。

    metricDataobject

    返回数据列表。

    Labelsany

    标签。

    		{"DiskId": "d-1234"}
    Datapointsany

    监控数据列表，一系列连续的秒级时间戳和查询的指标对应时刻的值的列表。

    		{"1699258861": 1,"1699259461": 0}
    RequestIdstring

    请求 ID。

    		11B55F58-D3A4-4A9B-9596-342420D0****

    示例

    正常返回示例

    JSON格式

    {
  "TotalCount": 1,
  "DataList": [
    {
      "Labels": "{\"DiskId\": \"d-1234\"}",
      "Datapoints": "{\"1699258861\": 1,\"1699259461\": 0}"
    }
  ],
  "RequestId": "11B55F58-D3A4-4A9B-9596-342420D0****"
}

    错误码

    HTTP status code错误码错误信息描述
    400InvalidParameterThe parameter %s is invalid.参数错误
    400InvalidParameter.ConflictThe specified parameter %s and %s are not blank at the same time.参数冲突
    400InvalidParameter.FormatSpecified parameter format is not valid.返回值格式不正确（Format 不支持）。返回格式支持 XML 与 JSON，默认为 XML。
    400MissingParameterThe input parameter %s that is mandatory for processing this request is not supplied.参数缺失。
    403ForbiddenUser is not authorized to operate.当前用户无权限对当前资源执行任何操作。请检查您的账号权限或者咨询您的主账号管理员。
    403Forbidden.ActionUser is not authorized to operate this action.当前用户无权限执行该操作。请检查您的账号权限或者咨询您的主账号管理员。
    403InvalidAccountStatus.NotEnoughBalanceYour account does not have enough balance.您的账户余额不足。
    403LastTokenProcessingThe last token request is processing.相同clientToken的请求正在执行，请稍后再重试。
    403NoPermission.SLRThe RAM user does not have the permission to create service linked role: AliyunServiceLinkedRoleForEBS.当前用户无权限创建SLR。
    403OperationDeniedThe operation is not allowed.当前操作不允许执行。
    404InvalidApi.NotFoundSpecified api is not found, please check your url and method.找不到指定的 API。请检查调用的 URL 和方法。您调用的 API 不存在。请检查 API 的名称是否正确，请注意确认大小写。
    404NoSuchResourceThe specified resource does not exist.指定的资源不存在。
    429BLOCK.LimitedRequestRequest was denied due to user flow control.-
    500InternalErrorThe request processing has failed due to some unknown error, exception or failure.内部错误。
    504RequestTimeoutThe request is timeout, please try again later.该请求超时，请稍后再重试。

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

    变更历史

    变更时间变更内容概要操作
    2024-11-07OpenAPI 错误码发生变更、OpenAPI 入参发生变更查看变更详情
    2024-01-03OpenAPI 错误码发生变更查看变更详情