You need to enable JavaScript to run this app.
导航
云手机
  • 文档首页
    • /云手机/云手机-iPaaS/服务端 OpenAPI 参考/实例管理/查询实例监控指标 ListInstanceMetricData
查询实例监控指标 ListInstanceMetricData
最近更新时间：2024.05.09 17:19:41首次发布时间：2023.08.29 19:09:48
我的收藏

查询指定实例的监控指标数据（上行带宽、下行带宽、最大带宽）。使用说明如下：

  • 支持查询最近2个月（62天）以内的监控数据
  • 单次查询的时间跨度不能大于1个月（31天）
  • 查询返回的数据按指定的粒度做聚合处理，聚合逻辑如下：
    • 最小的数据采集粒度为5分钟1个监控数据点；
    • 可选的数据聚合粒度为：5分钟、10分钟、30分钟、60分钟；
    • 单次查询时间跨度小于等于1天，默认返回原始采集数据点（5分钟频次）；
    • 单次查询时间跨度大于1天、小于等于3天，默认按10分钟粒度一个聚合点返回，按最大值max聚合；
    • 单次查询时间跨度大于3天、小于等于7天，默认按30分钟粒度一个聚合点返回，按最大值max聚合；
    • 单次查询时间跨度大于7天，默认按1小时粒度一个聚合点返回，按最大值max聚合。

请求方式

使用 POST 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考 公共请求参数。

字段
位置
类型
必填
说明
值
ActionQueryString是公共参数，OpenAPI 接口名称ListInstanceMetricData
VersionQueryString是公共参数，OpenAPI 接口版本2023-08-01

Body 参数

字段
类型
必填
说明
ProductIdString是业务 ID，可在「云手机控制台-业务管理-业务详情」中获取
InstanceIdString是实例 ID，可通过调用 ListInstance 接口获取

MetricName

Array of String

是

监控指标名称列表，支持以下网络监控指标：

  • UpBandwidth（上行带宽）

  • DownBandwidth（下行带宽）

  • MaxBandwidth（最大带宽）

详细信息，参考以下 监控指标说明

MetricType

String

是

监控指标类型：

  • Bandwidth（带宽）

详细信息，参考以下 监控指标说明

SampleRate

Integer

否

数据聚合粒度（单位：分钟）：

  • 5

  • 10

  • 30

  • 60

StartTimeInteger是查询开始时间，秒级时间戳
EndTimeInteger是查询结束时间，秒级时间戳

监控指标说明

指标类型指标名称指标说明单位
BandwidthUpBandwidth上行带宽bps
BandwidthDownBandwidth下行带宽bps
BandwidthMaxBandwidth公网带宽，同一时刻上报的上下行带宽较大值bps

返回结果

通用返回参数，请参考 ResponseMetadata 结构说明。

Result 字段包含以下参数：

字段
类型
说明
StartTimeInteger监控指标查询的开始时间
EndTimeInteger监控指标查询的结束时间
MetricNameArray of String监控指标名称列表
MetricTypeString监控指标类型
SimpleRateInteger数据聚合粒度
UpBandwidthResultArray of Object查询到的上行带宽数据，参考以下 监控指标数据结构说明
DownBandwidthResultArray of Object查询到的下行带宽数据，参考以下 监控指标数据结构说明
MaxBandwidthResultArray of Object查询到的最大带宽数据，参考以下 监控指标数据结构说明

监控指标数据结构说明

字段
类型
说明
TimeStampString数据采集的时间
ValueFloat数值，带宽单位为：bps

示例

请求示例

POST https://open.volcengineapi.com?Action=ListInstanceMetricData
&Version=2023-08-01
&<通过header传入的公共请求参数>

{
    "ProductId": "1692006971189xxxxxx",
    "InstanceId": "i-1774479484xxxxxx",
    "MetricName": ["UpBandwidth","DownBandwidth","MaxBandwidth"],
    "MetricType": "Bandwidth",
    "SampleRate": 60,
    "StartTime": 1692588239,
    "EndTime": 1692688239
}

返回示例

{
    "ResponseMetadata": {
        "Action": "ListInstanceMetricData",
        "Region": "cn-north-1",
        "RequestId": "20230822151943C9F3AE2F95B9116E63C5",
        "Service": "iPaaS",
        "Version": "2023-08-01"
    },
    "Result": {
        "StartTime": 1692588239,
        "EndTime": 1692688239,
        "MetricName": [
            "UpBandwidth",
            "DownBandwidth",
            "MaxBandwidth"
        ],
        "MetricType": "Bandwidth",
        "SimpleRate": 60,
        "UpBandwidthResult": [
            {
                "TimeStamp": "2023-08-21T11:00:00+08:00",
                "Value": 285.26666666666665
            },
            {
                "TimeStamp": "2023-08-21T12:00:00+08:00",
                "Value": 329.22222222222223
            },
            {
                "TimeStamp": "2023-08-21T13:00:00+08:00",
                "Value": 285.23333333333335
            }
        ],
        "DownBandwidthResult": [
            {
                "TimeStamp": "2023-08-21T11:00:00+08:00",
                "Value": 447.56666666666666
            },
            {
                "TimeStamp": "2023-08-21T12:00:00+08:00",
                "Value": 485.8965517241379
            },
            {
                "TimeStamp": "2023-08-21T13:00:00+08:00",
                "Value": 450.2
            }
        ],
        "MaxBandwidthResult": [
            {
                "TimeStamp": "2023-08-21T11:00:00+08:00",
                "Value": 447.56666666666666
            },
            {
                "TimeStamp": "2023-08-21T12:00:00+08:00",
                "Value": 485.8965517241379
            },
            {
                "TimeStamp": "2023-08-21T13:00:00+08:00",
                "Value": 450.2
            }
        ]
    }
}