You need to enable JavaScript to run this app.
导航
查询带宽用量
最近更新时间:2024.04.12 15:11:26首次发布时间:2024.04.12 15:11:26

本接口支持通过自定义时间段,查询域名带宽用量。

注意事项

  • 请求频率:单用户请求频率限制为 50 次/秒
  • 数据延迟:数据延迟约为 15 分钟
  • 历史数据查询时间范围:近 1 年
  • 服务地址:veImageX 在全球多个区域部署,每个区域有自己对应的 OpenAPI 域名,不支持跨区域调用。具体详情请查看服务地址

请求说明

  • 请求方式:GET
  • 请求地址:https://imagex.volcengineapi.com/?Action=DescribeImageXDomainBandwidthData&Version=2023-05-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数

Query

参数类型是否必选示例值描述
ActionStringDescribeImageXDomainBandwidthData接口名称。当前 API 的名称为 DescribeImageXDomainBandwidthData
VersionString2023-05-01接口版本。当前 API 的版本为 2023-05-01
ServiceIdsStrings1,s2服务 ID。支持查询多个服务,传入多个时用英文逗号“,”分割,缺省情况下表示查询所有服务。您可以在 veImageX 控制台的服务管理模块或者调用 GetAllImageServices 接口获取服务 ID。
DomainNamesStringd1,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

EndTimeString2019-06-02T00:00:00+08:00获取数据结束时间点。日期格式按照 ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00

Interval

Integer

300

查询数据的时间粒度。单位为秒。缺省时查询 StartTimeEndTime 时间段全部数据,此时单次查询最大时间跨度为 93 天。取值如下所示:

  • 300:单次查询最大时间跨度为 31 天
  • 600:单次查询最大时间跨度为 31 天
  • 1200:单次查询最大时间跨度为 31 天
  • 1800:单次查询最大时间跨度为 31 天
  • 3600:单次查询最大时间跨度为 93 天
  • 86400:单次查询最大时间跨度为 93 天
  • 604800:单次查询最大时间跨度为 93 天

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数

参数类型示例值描述
BpsDataArray of BpsData-计量数据列表

BpsData

参数类型示例值描述
DataArray of Data-具体数据。
ServiceIdStrings1服务 ID,GroupBy包含ServiceId时有返回值。
DomainNameStringd1域名,GroupBy包含DomainName时有返回值。

Data

参数类型示例值描述
TimeStampString2023-01-01T00:00:00+08:00统计时间点,时间片开始时刻。日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如 2019-06-02T00:00:00+08:00
ValueFloat123.4带宽用量,单位为 bps。

请求示例

GET https://imagex.volcengineapi.com/?Action=DescribeImageXDomainBandwidthData&Version=2023-05-01&ServiceIds=s1,s2&DomainNames=d1,d2&BillingRegion=CHN,AP1&GroupBy=DomainName&StartTime=2019-06-02T00:00:00+08:00&EndTime=2019-06-02T00:00:00+08:00&Interval=300

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DescribeImageXDomainBandwidthData",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "BpsData": [
            {
                "Data": [
                    {
                        "TimeStamp": "2023-01-01T00:00:00+08:00",
                        "Value": 123.4
                    }
                ],
                "ServiceId": "s1",
                "DomainName": "d1"
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。更多信息请见公共错误码和 veImageX 错误码

状态码错误码错误信息说明
400InvalidParameterMissing Parameter.请求参数错误,请检查您的请求参数是否正确。
401ParamAccountMismatchParam {} did not belong to your account.请求参数不属于账号,请检查您的请求参数是否正确。
500InternalErrorInternal Error.内部错误,请提交工单联系技术支持。