调用DescribeMetricData接口查询指定时间段内的云产品时序指标监控数据。

各云产品的参数NamespaceProjectMetricPeriodDimensions等的取值,请参见DescribeMetricMetaList云监控主要监控项

说明 该接口与DescribeMetricList不同,该接口带有统计功能,即Dimension={"userId:"xxxx"},将该用户下的所有数据进行聚合计算。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String DescribeMetricData

要执行的操作,取值:DescribeMetricData

MetricName String cpu_idle

监控项名称。

Namespace String acs_ecs_dashboard

产品的数据命名空间,用于区分不同的产品。

命名方式:acs_产品名。

Period String 60

时间间隔,单位为秒。取值一般为60(1分钟)、300(5分钟)、900(15分钟)。

请根据需要设置此参数。例如:

  • 如果查询一天范围时设置Period为60,则返回1000条数据(实际存在1440,因为最大返回值不超过1000,则只返回前1000条)。
  • 如果设置Period为300,则返回288条数据。
StartTime String 2019-01-30 00:00:00

开始时间。支持的格式:

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

结束时间。支持的格式:

  • Unix时间戳:从1970年1月1日开始所经过的秒数。
  • Format格式:YYYY-MM-DDThh:mm:ssZ。
Dimensions String [{"instanceId": "i-abcdefgh12****"}]

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

格式为key-value键值对形式的集合,常用的key-value集合为instanceId:XXXXXX

keyvalue的长度为1~64个字节,超过64个字节时截取前64字节。keyvalue的取值可包含字母、数字、点号(.)、短横线(-)、下划线(_)、正斜线(/)和反斜线(\)。

说明 Dimensions传入时需要使用JSON字符串表示该Map对象,必须按顺序传入。
Express String “{"groupby":["userId","instanceId"]}”

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

目前仅支持groupby(类似数据库的groupby语句)。

Length String 1000

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

默认值为:1000。

返回数据

名称 类型 示例值 描述
Code String 200

状态码。

说明 状态码为200表示成功,其余取值表示失败。
Datapoints String [{"timestamp":1548777660000,"userId":"123****","instanceId":"i-abc****","Minimum":9.92,"Average":9.92,"Maximum":9.92}]

监控数据列表。

Message String Success

返回信息。

Period String 60

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

RequestId String 6A5F022D-AC7C-460E-94AE-B9E75083D027

请求ID。

示例

请求示例

http(s)://[Endpoint]/?Action=DescribeMetricData
&MetricName=cpu_idle
&Namespace=acs_ecs_dashboard
&<公共请求参数>

正常返回示例

XML 格式

<Period>60</Period>
<Datapoints>
    <timestamp>1490152860000</timestamp>
    <Maximum>100</Maximum>
    <userId>123456789876****</userId>
    <Minimum>93.1</Minimum>
    <instanceId>i-abcdefgh12****</instanceId>
    <Average>99.52</Average>
</Datapoints>
<Datapoints>
    <timestamp>1490152920000</timestamp>
    <Maximum>100</Maximum>
    <userId>123456789876****</userId>
    <Minimum>92.59</Minimum>
    <instanceId>i-abcdefgh12****</instanceId>
    <Average>99.49</Average>
</Datapoints>
<Datapoints>
    <timestamp>1490152980000</timestamp>
    <Maximum>100</Maximum>
    <userId>123456789876****</userId>
    <Minimum>92.86</Minimum>
    <instanceId>i-abcdefgh12****</instanceId>
    <Average>99.44</Average>
</Datapoints>
<Datapoints>
    <timestamp>1490153040000</timestamp>
    <Maximum>100</Maximum>
    <userId>123456789876****</userId>
    <Minimum>91.43</Minimum>
    <instanceId>i-abcdefgh12****</instanceId>
    <Average>99.36</Average>
</Datapoints>
<Datapoints>
    <timestamp>1490153100000</timestamp>
    <Maximum>100</Maximum>
    <userId>123456789876****</userId>
    <Minimum>93.55</Minimum>
    <instanceId>i-abcdefgh12****</instanceId>
    <Average>99.51</Average>
</Datapoints>
<Datapoints>
    <timestamp>1490153160000</timestamp>
    <Maximum>100</Maximum>
    <userId>123456789876****</userId>
    <Minimum>93.1</Minimum>
    <instanceId>i-abcdefgh12****</instanceId>
    <Average>99.52</Average>
</Datapoints>
<Datapoints>
    <timestamp>1490153220000</timestamp>
    <Maximum>100</Maximum>
    <userId>123456789876****</userId>
    <Minimum>92.59</Minimum>
    <instanceId>i-abcdefgh12****</instanceId>
    <Average>99.42</Average>
</Datapoints>
<Datapoints>
    <timestamp>1490153280000</timestamp>
    <Maximum>100</Maximum>
    <userId>123456789876****</userId>
    <Minimum>91.18</Minimum>
    <instanceId>i-abcdefgh12****</instanceId>
    <Average>99.34</Average>
</Datapoints>
<Datapoints>
    <timestamp>1490153340000</timestamp>
    <Maximum>100</Maximum>
    <userId>123456789876****</userId>
    <Minimum>92.86</Minimum>
    <instanceId>i-abcdefgh12****</instanceId>
    <Average>99.46</Average>
</Datapoints>
<Datapoints>
    <timestamp>1490153400000</timestamp>
    <Maximum>100</Maximum>
    <userId>123456789876****</userId>
    <Minimum>91.18</Minimum>
    <instanceId>i-abcdefgh12****</instanceId>
    <Average>99.35</Average>
</Datapoints>
<RequestId>6A5F022D-AC7C-460E-94AE-B9E75083D027</RequestId>
<Code>200</Code>

JSON 格式

{
    "Period": "60",
    "Datapoints": [
        {
            "timestamp": 1490152860000,
            "Maximum": 100,
            "userId": "123456789876****",
            "Minimum": 93.1,
            "instanceId": "i-abcdefgh12****",
            "Average": 99.52
        },
        {
            "timestamp": 1490152920000,
            "Maximum": 100,
            "userId": "123456789876****",
            "Minimum": 92.59,
            "instanceId": "i-abcdefgh12****",
            "Average": 99.49
        },
        {
            "timestamp": 1490152980000,
            "Maximum": 100,
            "userId": "123456789876****",
            "Minimum": 92.86,
            "instanceId": "i-abcdefgh12****",
            "Average": 99.44
        },
        {
            "timestamp": 1490153040000,
            "Maximum": 100,
            "userId": "123456789876****",
            "Minimum": 91.43,
            "instanceId": "i-abcdefgh12****",
            "Average": 99.36
        },
        {
            "timestamp": 1490153100000,
            "Maximum": 100,
            "userId": "123456789876****",
            "Minimum": 93.55,
            "instanceId": "i-abcdefgh12****",
            "Average": 99.51
        },
        {
            "timestamp": 1490153160000,
            "Maximum": 100,
            "userId": "123456789876****",
            "Minimum": 93.1,
            "instanceId": "i-abcdefgh12****",
            "Average": 99.52
        },
        {
            "timestamp": 1490153220000,
            "Maximum": 100,
            "userId": "123456789876****",
            "Minimum": 92.59,
            "instanceId": "i-abcdefgh12****",
            "Average": 99.42
        },
        {
            "timestamp": 1490153280000,
            "Maximum": 100,
            "userId": "123456789876****",
            "Minimum": 91.18,
            "instanceId": "i-abcdefgh12****",
            "Average": 99.34
        },
        {
            "timestamp": 1490153340000,
            "Maximum": 100,
            "userId": "123456789876****",
            "Minimum": 92.86,
            "instanceId": "i-abcdefgh12****",
            "Average": 99.46
        },
        {
            "timestamp": 1490153400000,
            "Maximum": 100,
            "userId": "123456789876****",
            "Minimum": 91.18,
            "instanceId": "i-abcdefgh12****",
            "Average": 99.35
        }
    ],
    "RequestId": "6A5F022D-AC7C-460E-94AE-B9E75083D027",
    "Code": "200"
}

错误码

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