文档中心

查询流量用量

最近更新时间：2023.07.05 10:11:35

首次发布时间：2023.02.23 19:47:06

本接口支持通过自定义时间段，获取加速域名网络流量用量。

注意事项

请求频率：单用户请求频率限制为 50 次/秒。
数据延迟：数据延迟约为 15 分钟。
历史数据查询时间范围： 近 1 年。

请求说明

请求方式：GET
请求地址：https://imagex.volcengineapi.com/?Action=DescribeImageXDomainTrafficData&Version=2018-08-01

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeImageXDomainTrafficData`	接口名称。`DescribeImageXDomainTrafficData`
Version	String	是	`2018-08-01`	接口版本
ServiceIds	String	否	`s1,s2`	服务 ID。为空时表示不筛选，支持查询多个服务，使用逗号分隔不同的服务。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考 GetAllImageServices。
DomainNames	String	否	`d1,d2`	域名。为空时表示不筛选，支持查询多个域名，不同的域名使用逗号分隔。您可以通过调用 GetServiceDomains 获取服务下所有域名信息。
BillingRegion	String	否	`CHN,AP1`	过滤计费区域。不传表示不过滤。传入多个用英文逗号分隔。支持取值如下： `CHN`：中国内地 `AP1`：亚太一区 `AP2`：亚太二区 `AP3`：亚太三区 `EU`：欧洲 `ME`：中东和非洲 `SA`：南美 `NA`：北美 `OTHER`：其他
GroupBy	String	否	`DomainName`	需要分组查询的参数。不传表示不拆分维度，传入多个用英文逗号分隔。支持取值如下： `ServiceId`：服务 ID `DomainName` ：域名
StartTime	String	是	`2019-06-02T00:00:00+08:00`	获取数据起始时间点。日期格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如`2019-06-02T00:00:00+08:00`。说明由于仅支持查询近一年历史数据，则若此刻时间为`2011-11-21T16:14:00+08:00`，那么您可输入最早的开始时间为`2010-11-21T00:00:00+08:00`。
EndTime	String	是	`2019-06-02T00:00:00+08:00`	获取数据结束时间点。日期格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如`2019-06-02T00:00:00+08:00`。
Interval	String	否	`300`	查询数据的时间粒度。单位为秒。缺省时查询 StartTime 和 EndTime 时间段全部数据，此时单次查询最大时间跨度为 93 天。支持取值如下： `300`：单次查询最大时间跨度为 31 天 `600`：单次查询最大时间跨度为 31 天 `1200`：单次查询最大时间跨度为 31 天 `1800`：单次查询最大时间跨度为 31 天 `3600`：单次查询最大时间跨度为 93 天 `86400`：单次查询最大时间跨度为 93 天 `604800`：单次查询最大时间跨度为 93 天

返回参数

参数	类型	示例值	描述
TrafficData	Array of TrafficData		计量数据列表

TrafficData

参数	类型	示例值	描述
Data	Array of Data		具体数据
ServiceId	String	`s1`	服务 ID，`GroupBy`包含`ServiceId`时有返回值。
DomainName	String	`d1`	域名，`GroupBy`包含`DomainName`时有返回值。

Data

参数	类型	示例值	描述
TimeStamp	String	`2020-11-27T21:10:00+08:00`	统计时间点，时间片开始时刻。日期格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如 `2019-06-02T00:00:00+08:00`。
Value	Number	`3262263979135.4087`	流量，单位：Byte。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=DescribeImageXDomainTrafficData&Version=2018-08-01&BillingRegion=CHN%2CAP1&DomainNames=d1%2Cd2&EndTime=2019-06-02T00%3A00%3A00%2B08%3A00&GroupBy=DomainName&Interval=300&ServiceIds=s1%2Cs2&StartTime=2019-06-02T00%3A00%3A00%2B08%3A00

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202012061011550100110600880B10EBAB",
    "Action": "DescribeImageXDomainBandwidthData",
    "Version": "2018-08-01",
    "Service": "imagex",
    "Region": "cn-north-1"
  },
  "Result": {
    "TrafficData": [
      {
        "Data": [
          {
            "TimeStamp": "2020-11-27T21:00:00+08:00",
            "Value": 3203865885387.33
          },
          {
            "TimeStamp": "2020-11-27T21:05:00+08:00",
            "Value": 3245473501515.516
          },
          {
            "TimeStamp": "2020-11-27T21:10:00+08:00",
            "Value": 3262263979135.4087
          }
        ]
      }
    ]
  }
}

错误码

访问公共错误码和 veImageX 错误码获取详细信息。

服务端 SDK

为了方便您快速开发，veImageX 提供了配套的服务端 SDK，同时支持多种编程语言。建议您使用服务端 SDK 来调用 API，参考文档如下所示：