文档

DescribeDcdnDomainUsageData - 查询用量数据

更新时间:

调用DescribeDcdnDomainUsageData查询域名在特定计费区域的用量数据。

接口说明

  • 单用户调用频率:10 次/秒
  • 用量数据包括流量、带宽和请求数三大类,单位分别为 Byte、bps 和次数。

支持查询的时间粒度

根据单次查询的最大时间跨度不同,请求参数 Interval 支持不同的查询数据时间粒度,对应的可查询历史数据时间范围和数据延迟如下:

时间粒度单次查询的最大时间跨度可查询历史数据时间范围数据延迟
5 分钟3 天93 天15 分钟
1 小时31 天186 天一般延迟 3-4 小时
1 天366 天366 天一般延迟 4 小时,最长不超过 24 小时

调试

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

授权信息

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

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

请求参数

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

需要查询的加速域名。支持批量查询,一次最多可以查询 100 个域名,多个域名用英文逗号(,)分隔。

说明 如果不传该参数,默认返回所有加速域名合并后的数据。
example.com
StartTimestring

获取数据的起始时间点,日期格式按照 ISO8601 表示法,并使用 UTC 时间。格式为:yyyy-MM-ddTHH:mm:ssZ。

说明 查询数据的最小粒度为 5 分钟。
2015-12-10T20:00:00Z
EndTimestring

获取数据的结束时间点,日期格式按照 ISO8601 表示法,并使用 UTC 时间。格式为:yyyy-MM-ddTHH:mm:ssZ

说明 结束时间需大于起始时间,且时间相差不能超过 31 天。
2015-12-10T22:00:00Z
Fieldstring

请求的数据类型。取值:

  • bps:带宽。
  • traf:流量。
  • acc:请求数。
说明 acc 不支持根据 Area 参数查询。
bps
Typestring

请求数类型,取值:

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

默认为 all

dynamic
DataProtocolstring

需要获取的数据的协议。取值:

  • quic:QUIC 协议。
  • https:HTTPS 协议。
  • http:HTTP 协议。
  • all:以上全部协议。

默认为 all

all
Areastring

区域代号。取值:

  • CN:中国内地。
  • OverSeas:全球(不包含中国内地)。
  • AP1:亚太 1 区。
  • AP2:亚太 2 区。
  • AP3:亚太 3 区。
  • NA:北美。
  • SA:南美。
  • EU:欧洲。
  • MEAA:中东、非洲。
  • all:以上全部区域。

默认为 CN

CN
Intervalstring

强制指定获取指定时间粒度的数据,单位为秒。

根据单次查询的最大时间跨度不同,该参数支持 300(5 分钟)、3600(1 小时)和 86400(1 天)取值,具体请参见使用说明中支持查询的时间粒度。

300

参数组合说明

计费数据和参数取值的对应关系如下表,具体调用方法请参见请求示例。

计费数据DataProtocol 参数取值Type 参数取值Field 参数取值Area 参数取值
流量all 或不传all 或不传trafCN
OverSeas
AP1
AP2
AP3
NA
SA
EU
MEAA
带宽all 或不传all 或不传bpsCN
OverSeas
AP1
AP2
AP3
NA
SA
EU
MEAA
静态 HTTPS 请求数httpsstaticaccall
动态 HTTP 请求数httpdynamicaccall
动态 HTTPS 请求数httpsdynamicaccall

返回参数

名称类型描述示例值
object
DomainNamestring

查询到的加速域名。

example.com
EndTimestring

查询数据的结束时间。

2015-12-10T22:00:00Z
StartTimestring

查询数据的开始时间。

2015-12-10T20:00:00Z
Typestring

返回的用量类型。

bps
Areastring

返回的用量区域。

CN
RequestIdstring

请求 ID。

B955107D-E658-4E77-B913-E0AC3D31693E
DataIntervalstring

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

/
UsageDataPerIntervalobject []

每个时间间隔的流量数据。

TimeStampstring

时间片起始时刻。

2015-12-10T21:30:00Z
PeakTimestring

Fieldbps 时,该值为峰值带宽时刻,否则值和 TimeStamp 相同。

2015-12-10T21:30:00Z
Valuestring

用量。

4233041**
SpecialValuestring

特殊用量。

说明 用来标记特殊情况下的用量值,没有特殊计费可忽略该参数。
4233041**

示例

正常返回示例

JSON格式

{
  "DomainName": "example.com",
  "EndTime": "2015-12-10T22:00:00Z",
  "StartTime": "2015-12-10T20:00:00Z",
  "Type": "bps",
  "Area": "CN",
  "RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
  "DataInterval": "/",
  "UsageDataPerInterval": {
    "DataModule": [
      {
        "TimeStamp": "2015-12-10T21:30:00Z",
        "PeakTime": "2015-12-10T21:30:00Z",
        "Value": "4233041**",
        "SpecialValue": "4233041**"
      }
    ]
  }
}

错误码

HTTP status code错误码错误信息描述
400InvalidParameterThe specified parameter is invalid.参数错误
400InvalidStartTime.MalformedThe specified StartTime parameter is invalid.请提供正确的开始时间格式。日期格式按照ISO8601表示法,并使用UTC时间,格式为:yyyy-MM-ddTHH:mm:ssZ。
400InvalidEndTime.MalformedThe specified EndTime is invalid.请提供正确的结束时间格式。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:yyyy-MM-ddTHH:mm:ssZ。
400InvalidTime.MalformedSpecified StartTime or EndTime is malformed.开始时间或结束时间格式错误。日期格式按照ISO8601表示法,并使用UTC+0时间,格式为yyyy-MM-ddTHH:mm:ssZ。
400InvalidParameterFieldThe specified Field is invalid.Field参数错误
400InvalidParameterTypeThe specified Type is invalid.Type参数错误,请确认后输入
400InvalidEndTime.MismatchThe specified EndTime is earlier than the StartTime.结束时间早于开始时间,请检查。
400InvalidTimeSpanThe time span exceeds the limit.时间跨度超过限制,请参照接口文档,配置合理查询跨度。
400InvalidParameterIntervalThe specified Interval is invalid.Interval参数错误

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (1)
文档反馈