调用DescribeDomainHitRateData查询字节命中率(命中字节百分比)。
接口说明
- 如果您不指定 StartTime 和 EndTime,该接口返回过去 24 小时的数据;指定 StartTime 和 EndTime,该接口返回指定时间段的数据。
支持查询的时间粒度
根据单次查询的最大时间跨度不同,请求参数 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)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
cdn:DescribeDomainHitRateData | none |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DomainName | string | 否 | 加速域名,多个域名用半角逗号(,)分隔,一次最多支持 500 个域名查询。 默认查询所有加速域名。 | example.com |
StartTime | string | 否 | 获取数据起始时间点。 日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 | 2019-12-30T08:00:00Z |
EndTime | string | 否 | 获取数据结束时间点。 日期格式按照 ISO8601 表示法,并使用 UTC 时间,格式为 yyyy-MM-ddTHH:mm:ssZ。 说明
结束时间需大于起始时间。
| 2019-12-30T08:10:00Z |
Interval | string | 否 | 指定查询数据的时间粒度,单位:秒。 根据单次查询的最大时间跨度不同,该参数支持 300(5 分钟)、3600(1 小时)和 86400(1 天)取值,具体请参见使用说明中支持查询的时间粒度。 | 300 |
返回参数
示例
正常返回示例
JSON
格式
{
"EndTime": "2019-12-30T08:10:00Z",
"StartTime": "2019-12-30T08:00:00Z",
"RequestId": "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
"DomainName": "example.com",
"DataInterval": "300",
"HitRateInterval": {
"DataModule": [
{
"Value": "100.0",
"TimeStamp": "2019-12-30T08:00:00Z",
"HttpsValue": "50.0"
}
]
}
}
错误码
HTTP status code | 错误码 | 错误信息 | 描述 |
---|---|---|---|
400 | MissingTimeParameter | The StartTime and EndTime must be both specified. | 请同时提供开始时间和结束时间。 |
400 | InvalidStartTime.Malformed | The specified value of parameter StartTime is malformed. | 开始时间格式错误。日期格式请参考所调用API的帮助文档说明。 |
400 | InvalidEndTime.Malformed | The specified value of parameter EndTime is malformed. | 参数EndTime格式错误。 |
400 | InvalidEndTime.Mismatch | Specified EndTime does not match the specified StartTime. | 指定的EndTime与StartTime不匹配,StartTime应早于EndTime。 |
400 | InvalidStartTime.ValueNotSupported | The specified value of parameter StartTime is not supported. | 开始时间设置错误,请检查更新后重试。 |
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-06-13 | OpenAPI 错误码发生变更 | 查看变更详情 |