获取命中率--视频点播-火山引擎

文档中心

立即注册

导航

获取命中率

最近更新时间：2024.07.03 18:10:31首次发布时间：2023.07.19 15:18:25

此接口用于设置域名、指标类别等参数，在一定时间范围内，获取指定的命中率数据。

注意事项

时间范围：查询的时间跨度不能超过 90 天。

请求说明

请求地址：https://vod.volcengineapi.com?Action=ListCdnHitrateData&Version=2022-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	`ListCdnHitrateData`	接口名称。当前 API 的名称为 `ListCdnHitrateData`。
Version	String	是	`2022-01-01`	接口版本。当前 API 的版本为 `2022-01-01`。
Domains	String	是	`example.vod.com`	域名，多个用英文逗号 `,` 隔开。您可通过 ListDomain 接口获取指定空间下的域名列表。
Interval	String	是	`auto`	指定查询数据的时间粒度，单位为秒。取值如下： `auto`：自动聚合。说明当时间查询范围为小于等于 7 天时，则返回 `5min` 数据粒度。当时间查询范围为 (7,31] 时，则返回 `hour` 数据粒度。当时间范围为 (31,90] 时，则返回 `day` 数据粒度。当时间范围为大于 90 天，则会报错。 `5min`：5 分钟粒度。当时间查询范围为 31 天内（含 31 天），则返回 `5min` 数据粒度。当时间范围为大于 31 天，则会报错。 `hour`：1 小时粒度。当时间查询范围为 31 天内（含 31 天），则返回 `hour` 数据粒度。当时间范围为大于 31 天，则会报错。 `day`：天粒度。当时间查询范围为大于 90 天，则返回 `day` 数据粒度。当时间范围为大于 90 天，则会报错。
StartTimestamp	Long	否	`1703174399`	查询范围起始时间。Unix 时间戳，单位为秒。它表示从 1970 年 1 月 1 日 00:00:00 UTC 到指定时间的秒数。默认当天 0 点。
EndTimestamp	Long	否	`1703227620`	查询范围截止时间。Unix 时间戳，单位为秒。它表示从 1970 年 1 月 1 日 00:00:00 UTC 到指定时间的秒数。默认为第二天 0 点。说明最大支持单次查询 90 天的数据。
Metric	String	是	`hitrate`	指标类别。取值如下： `hitrate`：流量命中率。 `pvhitrate`：请求命中率。
NeedDetail	Boolean	否	`true`	是否需要详细数据。取值如下： `false`：（默认）否。 `true`：是。

返回参数

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

参数	类型	示例值	描述
Datas	Object[]	`-`	用量信息。
Name	String	`total`	统计目标名。
Metric	String	`bandwidth`	指标类别。取值如下： `hitrate`：流量命中率。 `pvhitrate`：请求命中率。
Points	Object[]	`-`	打点数据。
Timestamp	Double	`1653494400`	时间戳。
Value	Double	`458700098.3547`	数值，单位为次。说明该参数可能不存在。
NoPermissionDomains	String[]	`["example.vod.com"]`	无权限域名列表。

请求示例

https://vod.volcengineapi.com?Action=ListCdnHitrateData&Version=2022-01-01&Domains=example.vod.com&StartTime=1718208000&EndTime=1718899199&Interval=auto&Metric=hitrate

返回示例

{
    "ResponseMetadata": {
        "Region": "cn-north-1",
        "RequestId": "202306041104***100232280022D31",
        "Version": "2022-01-01",
        "Service": "vod",
        "Action": "ListCdnHitrateData"
    },
    "Result": {
        "Datas":  [
        {
            "Name": "total",
            "Metric": "hitrate",
            "Points": [
            {
                "Timestamp": 1718899200,
                "Value": 1
            }
            ]
        }
 ]
    }
}

错误码

下表列举了本接口特有的错误码。如需了解更多错误码，详见视频点播公共错误码。

状态码	错误码	错误信息	说明
400	InvalidParameter.InvalidDomains	-	无效的域名。
400	InvalidParameter.InvalidInterval	-	无效的时间粒度。
400	InvalidParameter.InvalidMetric	-	无效的指标类别。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API。此 API 各语言调用的示例代码，请参考如下：