查询请求命中率--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

查询请求命中率

最近更新时间：2024.12.25 15:42:39首次发布时间：2022.12.29 16:35:58

查询当前账号下对应域名的 CDN 请求次数命中率用量数据。

说明

该接口属于历史版本 API，建议您使用新版 DescribeImageXHitRateRequestData 接口。

注意事项

请求频率：单用户请求频率限制为 50 次/秒。
数据延迟：数据延迟约为 5~10 分钟。
历史数据查询时间范围：近 93 天。

请求说明

请求方式：GET
请求地址：https://imagex.volcengineapi.com/?Action=DescribeImageXHitRateRequestData&Version=2018-08-01

说明

veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求参数

以下请求参数列表仅列出了该接口的部分公共参数，完整公共参数列表见公共参数。

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeImageXHitRateRequestData`	接口名称。`DescribeImageXHitRateRequestData`
Version	String	是	`2018-08-01`	接口版本。当前 API 的版本为 `2018-08-01`。
StartTime	String	是	`2019-06-02T00:00:00+08:00`	获取数据起始时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm。例如`2019-06-02T00:00:00+08:00`。说明由于仅支持查询近 93 天的历史数据，则若此刻时间为`2011-11-21T16:14:00+08:00`，那么您可输入最早的开始时间为`2011-08-21T00:00:00+08:00`。
EndTime	String	是	`2019-06-02T00:00:00+08:00`	获取数据结束时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm。例如`2019-06-02T00:00:00+08:00`。
Interval	String	否	`300`	查询数据的时间粒度，单位为秒。缺省时查询`StartTime`和`EndTime`时间段全部数据，此时单次查询最大时间跨度为 93 天。支持以下取值： `60`：单次查询最大时间跨度为 6 小时 `120`：单次查询最大时间跨度为 6 小时 `300`：单次查询最大时间跨度为 31 天 `600`：单次查询最大时间跨度为 31 天 `1200`：单次查询最大时间跨度为 31 天 `1800`：单次查询最大时间跨度为 31 天 `3600`：单次查询最大时间跨度为 93 天 `86400`：单次查询最大时间跨度为 93 天 `604800`：单次查询最大时间跨度为 93 天
ServiceIds	String	否	`ysl*,4qp*`	限制查询的服务 ID，传入多个时用英文逗号分割。缺省情况下表示不限制服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考 GetAllImageServices。
DomainNames	String	否	`xxx.com,yyy.com`	限制查询的域名，传入多个时用英文逗号分割。缺省情况下表示不限制域名。您可以通过调用 GetServiceDomains 获取服务下所有域名信息。
GroupBy	String	否	`DomainName`	需要分组查询的参数。仅支持取值`DomainName`。

返回参数

参数	类型	示例值	描述
HitRateData	Array of HitRateData		命中率数据

HitRateData

参数	类型	示例值	描述
Data	Array of Data		具体数据
DomainName	String	`xxx.com`	域名，当`GroupBy`指定了`DomainName`时有返回值。

Data

参数	类型	示例值	描述
TimeStamp	String	`2022-10-19T00:00:00+08:00`	统计时间点，时间片开始时刻，格式为：YYYY-MM-DDThh:mm:ss±hh:mm。
Value	Number	`0.2`	请求命中率

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=DescribeImageXHitRateRequestData&Version=2018-08-01&DomainNames=xxx.com%2Cyyy.com&EndTime=2019-06-02T00%3A00%3A00%2B08%3A00&GroupBy=DomainName&Interval=300&ServiceIds=ysl%2A%2A%2A%2C4qp%2A%2A%2A&StartTime=2019-06-02T00%3A00%3A00%2B08%3A00

返回示例

{   
   "ResponseMetadata":{
		  "RequestId":"201806041104200100100232280022D30",
      "Action":"DescribeImageXHitRateRequestData",
      "Version":"2018-08-01",
      "Service":"imagex",
      "Region":"cn-north-1",     
   },
   "Result": {
	    "HitRateData": [
        {
            "Data": [
                {
                    "TimeStamp": "2022-10-19T00:00:00+08:00",
                    "Value": 0.2
                }
            ],
            "DomainName": "xxx.com"
        }
    ]
}
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	InvalidParameter	Missing Parameter.	请求参数错误
401	ParamAccountMismatch	Param {} did not belong to your account.	请求参数不属于账号
500	InternalError	Internal Error.	内部错误

服务端 SDK

veImageX 提供了配套的开发工具集 SDK，支持多种编程语言，帮助您更方便的调用 API。