文档

DescribeVodDomainUsageData - 查询流量带宽用量

调用DescribeVodDomainUsageData查询加速流量或带宽用量数据。

接口说明

说明
  • 目前服务地址仅支持:华东 2(上海)
  • 支持批量域名查询,多个域名用逗号半角(,)分隔,最多可以一次查询 100 个域名。如果为空则返回账号下所有域名的数据。
  • 最长可查询近 1 年的数据,单次查询跨度最长为 3 个月,查询时间为 1-3 天时,数据按小时粒度返回,查询时间大于 4 天,数据按天粒度返回。
  • 调试

    您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

    授权信息

    下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

    • 操作:是指具体的权限点。
    • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
    • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
      • 对于必选的资源类型,用背景高亮的方式表示。
      • 对于不支持资源级授权的操作,用全部资源表示。
    • 条件关键字:是指云产品自身定义的条件关键字。
    • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
    操作访问级别资源类型条件关键字关联操作
    vod:DescribeVodDomainUsageDataRead
    • 全部资源
      *

    请求参数

    名称类型必填描述示例值
    DomainNamestring

    加速域名。若参数为空,默认返回所有加速域名合并后数据。支持批量查询,多个用半角逗号(,)分隔。

    example.com
    StartTimestring

    获取数据起始时间点。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

    2015-12-10T10:20:00Z
    EndTimestring

    获取数据结束时间点,需晚于起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

    2015-12-10T12:20:00Z
    Fieldstring

    数据类型。取值:

    • bps:带宽。
    • traf:流量。
    bps
    Typestring

    需要获取的用量类型。取值:

    • static:静态。
    • dynamic:动态。
    • all:全部。
    static
    Areastring

    地域代号。默认为 CN 中国大陆。取值:

    • CN:中国大陆。
    • OverSeas:海外区域。
    CN
    Intervalstring

    强制指定获取指定时间粒度的数据,单位为秒。支持 300(5 分钟)、3600(1 小时)和 86400(1 天)。

    • Interval=300:最长可查询最近半年的数据,单次查询的时间跨度最长为 3 天。
    • Interval=360086400:最长可查询最近 1 年的数据。
    • 不指定 Interval:单次查询跨度最长为 1 个月。当查询时间为 1~3 天时,数据按小时粒度返回;当查询时间为 4 天及以上时,数据按天粒度返回。
    300

    返回参数

    名称类型描述示例值
    object
    EndTimestring

    结束时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

    2015-12-10T12:20:00Z
    Typestring

    数据类型。取值:

    • bps:带宽。
    • traf:流量。
    bps
    StartTimestring

    开始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

    2015-12-10T10:20:00Z
    RequestIdstring

    请求 ID。

    B955107D-E658-4E77-****-E0AC3D31693E
    Areastring

    用量区域。

    CN
    DomainNamestring

    加速域名信息。

    example.com
    DataIntervalstring

    每条记录的时间间隔。单位:秒。

    300
    UsageDataPerIntervalobject []

    流量或带宽用量数据。

    Valuestring

    流量或带宽用量。单位:bit/second。

    2592.3920000000003
    TimeStampstring

    时间片起始时刻。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

    2015-12-10T10:00:00Z

    示例

    正常返回示例

    JSON格式

    {
      "EndTime": "2015-12-10T12:20:00Z",
      "Type": "bps",
      "StartTime": "2015-12-10T10:20:00Z",
      "RequestId": "B955107D-E658-4E77-****-E0AC3D31693E",
      "Area": "CN",
      "DomainName": "example.com",
      "DataInterval": "300",
      "UsageDataPerInterval": {
        "DataModule": [
          {
            "Value": "2592.3920000000003",
            "TimeStamp": "2015-12-10T10:00:00Z"
          }
        ]
      }
    }

    错误码

    访问错误中心查看更多错误码。

    变更历史

    变更时间变更内容概要操作
    2024-01-30OpenAPI 错误码发生变更看变更集
    变更项变更内容
    错误码OpenAPI 错误码发生变更
      删除错误码:400

    接口错误码

    下表列举了本接口特有的错误码。

    错误代码错误信息HTTP 状态码说明
    ThrottlingRequest was denied due to request throttling.503请求被流量控制限制。
    IllegalOperationIllegal domain, operation is not permitted.403非法域名, 无法操作。
    OperationDeniedYour account does not open CDN service yet.403未开通 CDN 服务。
    OperationDeniedYour CDN service is suspended.403CDN 服务已被停止。
    InvalidDomain.NotFoundThe domain provided does not belong to you.404域名不存在或不属于当前用户。
    InvalidDomain.OfflineThe domain provided is offline.404域名已下线。
    ServiceBusyThe specified Domain is configuring, please retry later.403域名正在配置中, 请稍后再试。
    InvalidDomain.Configure_failedFailed to configure the provided domain.500域名配置失败。
    InvalidParameterInvalid Parameter.400参数错误。
    InvalidParameterProductInvalid Parameter Product.400Product 参数错误。
    InvalidParameterAreaInvalid Parameter Area.400Area 参数错误。
    InvalidParameterFieldInvalid Parameter Field.400Field 参数错误。
    InvalidParameterStartTimeInvalid Parameter StartTime.400StartTime 参数错误。
    InvalidParameterEndTimeInvalid Parameter EndTime.400EndTime 参数错误。
    InvalidTimeRangeStartTime and EndTime range should less than 1 month.400EndTime 和 StartTime 差值不能超过 31 天。
    InvalidParameterIntervalInvalid Parameter Interval.400Interval 参数错误。