调用DescribeDomainUsageData查询域名在特定计费区域的用量数据。
接口说明
- 单用户调用频率:10 次/秒。
- 支持查询的时间粒度:根据单次查询的最大时间跨度不同,请求参数 Interval 支持不同的查询数据时间粒度,对应的可查询历史数据时间范围和数据延迟如下:
时间粒度 | 单次查询的最大时间跨度 | 可查询历史数据时间范围 | 数据延迟 |
---|---|---|---|
5 分钟 | 3 天 | 93 天 | 15 分钟 |
1 小时 | 7 天 | 186 天 | 一般延迟 3-4 小时 |
1 天 | 31 天 | 366 天 | 一般延迟 4 小时,不超过 24 小时 |
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cdn:DescribeDomainUsageData | none | *Domain acs:cdn:*:{#accountId}:domain/{#DomainName} |
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DomainName | string | 否 | 需要查询的加速域名。支持批量查询,多个域名用英文逗号(,)分隔,一次最多可以查询 100 个域名。 说明
如果参数为空,默认返回账号下所有加速域名合并后的数据。
| example.com |
StartTime | string | 是 | 获取数据的起始时间点。 日期格式按照 ISO 8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 说明
查询数据时间粒度为 5 分钟。
| 2015-12-10T20:00:00Z |
EndTime | string | 是 | 获取数据的结束时间点。 日期格式按照 ISO 8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 说明
结束时间需晚于起始时间,且时间相差不能超过 31 天。
| 2015-12-10T22:00:00Z |
Field | string | 是 | 请求的数据类型。取值:
说明
acc 不支持根据 Area 参数查询。
| bps |
Type | string | 否 | 需要获取的用量类型。取值:
| static |
DataProtocol | string | 否 | 需要获取的数据的协议。取值:
| all |
Area | string | 否 | 区域代号。取值:
| CN |
Interval | string | 否 | 强制指定获取指定时间粒度的数据,单位为秒。支持 300(5 分钟)、3600(1 小时)和 86400(1 天)。
| 300 |
参数组合说明
计费数据和参数取值的对应关系如下表,具体调用方法可参见请求示例。
计费数据 | DataProtocol 参数取值 | Type 参数取值 | Field 参数取值 | Area 参数取值 |
---|---|---|---|---|
流量 | all 或不传 | all 或不传 | traf | CN、OverSeas、AP1、AP2、AP3、NA、SA、EU、MEAA |
带宽 | all 或不传 | all 或不传 | bps | CN、OverSeas、AP1、AP2、AP3、NA、SA、EU、MEAA |
静态 HTTPS 请求数 | https | static | acc | all |
动态 HTTP 请求数 | http | dynamic | acc | all |
动态 HTTPS 请求数 | https | dynamic | acc | all |
动态 QUIC 请求数 | quic | dynamic | acc | all |
静态 QUIC 请求数 | quic | static | acc | all |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "B955107D-E658-4E77-B913-E0AC3D31693E",
"DomainName": "example.com",
"StartTime": "2015-12-10T20:00:00Z",
"EndTime": "2015-12-10T22:00:00Z",
"Type": "bps",
"Area": "CN",
"DataInterval": "300",
"UsageDataPerInterval": {
"DataModule": [
{
"Value": "423304182",
"TimeStamp": "2015-12-10T21:30:00Z",
"PeakTime": "2015-12-10T21:30:00Z",
"SpecialValue": "423304182"
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | InvalidParameter | The specified parameter is invalid. | 参数错误 |
400 | InvalidParameterType | The specified Type is invalid. | Type参数错误,请确认后输入 |
400 | InvalidParameterField | The specified Field is invalid. | Field参数错误,请确认后输入 |
400 | InvalidParameterStartTime | The parameter StartTime is invalid. | 参数StartTime无效。 |
400 | InvalidParameterEndTime | The parameter EndTime is invalid. | 参数EndTime无效。 |
400 | InvalidEndTime.Mismatch | Specified EndTime does not match the specified StartTime. | 指定的EndTime与StartTime不匹配,StartTime应早于EndTime。 |
400 | InvalidIntervalParameter | The specified Interval is invalid. | 指定的时间粒度无效。 |
400 | InvalidTimeSpan | The time span exceeds the limit. | 时间跨度超过限制,请参照接口文档,配置合理查询跨度。 |
400 | InvalidStartTime.ValueNotSupported | The specified value of parameter StartTime is not supported. | 开始时间设置错误,请检查更新后重试。 |
400 | InvalidTime.Malformed | Specified StartTime or EndTime is malformed. | 开始时间或结束时间格式错误。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2024-06-13 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-06-13 | OpenAPI 错误码发生变更 | 查看变更详情 |
2023-03-16 | OpenAPI 错误码发生变更 | 查看变更详情 |