You need to enable JavaScript to run this app.
导航
火山引擎入门实验
  • 文档首页
    • /
  • 火山引擎入门实验

Postman 调用 GetMetricData 接口获取共享带宽包出流量

最近更新时间：2024.01.10 10:13:31

首次发布时间：2024.01.10 10:13:31

我的收藏

本文介绍使用 Postman 调用GetMetricData 接口获取共享带宽包出流量过程。

前言

通过GetMetricData接口，查询共享带宽包的出流量聚合的时序数据，用于评估共享带宽包按照95计费还是主流量计费更省钱。

关于实验

预计实验时间：60分钟
级别：中级
相关产品：共享带宽包（cbwps）
受众： 通用

实验说明
前置条件
  • 确保您账户的 可用余额 和可用于共享带宽包的代金券二者总值不小于100.00元人民币，且可用余额不小于0。具体操作请参考 充值操作指引 。
  • 申请一个基础防护类型的公网IP实例。具体操作请参考 申请公网IP 。
实验步骤

使用 Postman 构建 OpenAPI 请求。相较于其它方式，Postman 具有简单易用的图形用户界面，可以保存接口请求的历史记录，测试集 Collections 可以更有效的管理组织接口，便于在团队之间同步接口数据。

第一步：安装 Postman

下载安装包

在 Download Postman 页面，单击 “Download the App”，根据本地电脑配置，下载对应安装包。

安装 Postman

  1. 双击下载好的安装包，软件将自动安装到本地电脑中。
  2. 启动 Postman，出现如下图所示界面，说明安装成功。
    image.png

第二步：生成OpenAPI签名

本示例使用Postman+OpenAPI请求GetMetricData接口，您可以使用其他工具或语言完成OpenAPI的请求，Postman使用时，需要将签名算法写到Pre-request Sscript中。
单击 “Pre-request Script”，在对应页签下完成签名机制的脚本编写，具体脚本用户可根据实际需求参考 签名机制 编写，需自行构造签名的http请求。

另外也提供Postman签名demo,复制粘贴到Pre-request Script即可：

demo.txt
12.05KB

第三步：Postman+OpenAPI生成POST请求

  • Postman 请求示例：
https://open.volcengineapi.com?Action=GetMetricData&Version=2018-01-01

alt

注意

Postman Headers Key字段ServiceName与Pre-request Script生成签名保持一致即可，除GetMetricData接口外，一般产品OpenAPI 服务名称：Service

  • Postman Body

{
    "MetricName":"OutTraffic",   #查询指标，如InTraffic、OutTraffic
    "StartTime":1692158400,
    "EndTime":1692159000,
    "Period":"24h",  #查询数据的间隔粒度，支持秒（s）和分钟（m）粒度，例如1440m 为一天
    "Namespace":"VCM_BandwidthPackage",
    "Instances":[
        {
            "Dimensions":[
                {
                    "Name":"ResourceID",
                    "Value":"共享带宽包实例ID"
                }
            ]
        }
    ],
    "SubNamespace":"Instance"
}

  • 格式化时间到时间戳

可以谷歌搜索，这里提供一个时间戳转换在线工具：https://tool.lu/timestamp/
alt

  • GetMetricData必填请求参数

参数类型是否必填示例值描述
StartTimeInteger是1648048800查询的时间选段的开始时间，秒级时间戳，例如1632904500。
EndTimeInteger是1648049400查询的时间选段的结束时间，秒级时间戳，例如1632904801。
InstancesArray是-要查询的监控指标信息。具体请参见Instance请求参数。
MetricNameString是InTraffic要查询的监控指标名称。参见云产品监控指标下各产品的MetricName。
NamespaceString是VCM_EIP要查询的监控指标所属的产品空间。参见云产品监控指标下各产品的Namespace。
SubNamespaceString是Instance要查询的指标所属的维度。SubNamespace在不同Namespace下的可选值不同，参见云产品监控指标下各产品的SubNamespace。

Period

String

是

1m

查询数据的间隔粒度，支持秒（s）、分钟（m）和时（h）粒度。
例如查询10分钟内的数据，并根据1分钟进行分割，则会返回10条数据。当时间选段较长时，不建议使用小单位作为间隔，否则将会导致数据集过大。关于传入Period后，StartTime、EndTime偏移的说明，请参见Period说明。

alt

  • GetMetricData返回示例

#出方向流量
2023-08-03 08:00:00   7758156364305 Bytes
2023-08-04 08:00:00   8803535990174 Bytes
2023-08-05 08:00:00   8858123717437 Bytes
2023-08-06 08:00:00   8872222895419 Bytes
2023-08-07 08:00:00   9839441519669 Bytes
2023-08-08 08:00:00   8535006460293 Bytes
2023-08-09 08:00:00   8079048934908 Bytes
2023-08-10 08:00:00   8083918169744 Bytes
2023-08-11 08:00:00   8112077844147 Bytes
2023-08-12 08:00:00   8105655361523 Bytes
2023-08-13 08:00:00   8123467879549 Bytes
2023-08-14 08:00:00   8055030284547 Bytes
2023-08-15 08:00:00   6670194486204 Bytes
参考链接

GetMetricData
共享带宽包
API访问密钥参考