最近更新时间:2023.07.04 19:52:04
首次发布时间:2021.02.23 10:42:25
本接口支持通过自定义时间段,获取加速域名网络带宽用量数据。
说明
veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址。
以下请求参数列表仅列出了该接口的部分公共参数,完整公共参数列表见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeImageXDomainBandwidthData | 接口名称。DescribeImageXDomainBandwidthData |
Version | String | 是 | 2018-08-01 | 接口版本。当前 API 的版本为 2018-08-01 。 |
ServiceIds | String | 否 |
| 服务 ID。为空时表示不筛选,支持查询多个服务,使用逗号分隔不同的服务。
|
DomainNames | String | 否 |
| 域名。为空时表示不筛选,支持查询多个域名,不同的域名使用逗号分隔。 |
BillingRegion | String | 否 |
| 过滤计费区域。不传表示不过滤,传入多个用英文逗号分隔。支持取值如下:
|
GroupBy | String | 否 |
| 需要分组查询的参数。不传表示不拆分维度,传入多个用英文逗号分隔。支持取值如下:
|
StartTime | String | 是 |
| 取数据起始时间点。日期格式按照 说明 由于仅支持查询近一年历史数据,则若此刻时间为 |
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 | Integer | 否 |
| 查询数据的时间粒度。单位为秒。缺省时查询
|
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
BpsData | Array of BpsData | 计量数据列表 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Array of Data | 具体数据 | |
ServiceId | String | s1**gh | 服务 ID,GroupBy 包含ServiceId 时有返回值。 |
DomainName | String | test.com | 域名,GroupBy 包含DomainName 时有返回值。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TimeStamp | String | 2019-06-02T00:00:00+08:00 | 统计时间点,时间片开始时刻。日期格式按照ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm 。 |
Value | Float | 3262263979135.4087 | 带宽,单位为 bps。 |
GET https://imagex.volcengineapi.com/?Action=DescribeImageXDomainBandwidthData&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": { "BpsData": [ { "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 错误码获取详细信息。
为了方便您快速开发,veImageX 提供了配套的服务端 SDK,同时支持多种编程语言。建议您使用服务端 SDK 来调用 API,参考文档如下所示: