You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /
  • 视频点播

获取命中率

最近更新时间：2023.12.27 21:13:09

首次发布时间：2023.07.19 15:18:25

我的收藏

此接口用域名等条件，获取一定时间范围内的命中率数据。

请求说明

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

调试

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

请求参数

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

参数类型是否必选示例值描述
ActionString是ListCdnHitrateData接口名称。当前 API 的名称为 ListCdnHitrateData。
VersionString是2022-01-01接口版本。当前 API 的版本为 2022-01-01。
DomainsString是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 天，则会报错。

StartTimestampLong否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：是。

返回参数

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

参数类型示例值描述
DatasArray of Datas-数据列表。
NoPermissionDomainsArray of String["example.vod.com"]无权限域名列表。

Datas

参数类型示例值描述
NameStringtotal统计目标名称。
MetricStringhitrate指标类别。
DataTypeString统计类别。
PointsArray of Points-打点数据。
RegionString国家或地区代码。
IspString用户运营商。
BillingRegionString计费区域。

Points

参数类型示例值描述
TimestampDouble1703185200时间戳。

Value

Double

97.9457

数值。

说明

该参数可能不存在，当不存在时则默认返回 0。

请求示例

https://vod.volcengineapi.com?Action=ListCdnHitrateData&Version=2022-01-01

返回示例

{
    "ResponseMetadata": {
        "Region": "cn-north-1",
        "RequestId": "202306041104***100232280022D31",
        "Version": "2022-01-01",
        "Service": "vod",
        "Action": "ListCdnHitrateData"
    },
    "Result": {
        "Datas": [
            {
                "BillingRegion": "September",
                "DataType": "毛每或名原设西速",
                "Points": [
                    {
                        "Value": 910,
                        "Timestamp": 451
                    }
                ],
                "Isp": "bird",
                "Metric": "积土义圆明红共场大",
                "Region": "业派音何持法无参发",
                "Name": "上号长选组权"
            }
        ],
        "NoPermissionDomains": [
            "few"
        ]
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

状态码错误码错误信息说明
400InvalidParameter.InvalidDomains-无效的 Domains。
400InvalidParameter.InvalidInterval-无效的 Interval。
400InvalidParameter.InvalidMetric-无效的 Metric。

服务端 SDK

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