获取数据统计分析结果--veImageX-火山引擎

文档中心

立即注册

导航

获取数据统计分析结果

最近更新时间：2024.08.09 10:27:34首次发布时间：2022.03.17 13:02:03

本接口支持获取按照流量/请求次数排序的数据列表，即按流量或请求次数由大到小排序后，访问量最靠前的域名/URL/Refer/客户端IP/UA/访问区域/运营商等数据。

说明

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

使用说明

URL/Refer/客户端IP/UA 最多支持展示 Top 1000 的数据。
访问区域/运营商可展示展示全量数据。

请求说明

接口名称：DescribeImageXCDNTopRequestData
请求方式：GET
接口地址示例：https://imagex.volcengineapi.com/?Action=DescribeImageXCDNTopRequestData&Version=2018-08-01
请求频率：单用户请求频率限制为 50 次/秒。
数据延迟：数据延迟在 20~30 min 之间。

说明

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

请求参数

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

Query

参数	类型	是否必选	描述
Action	String	是	接口名称。
Version	String	是	接口版本。veImageX 当前 API 的版本为 `2018-08-01`。
StartTime	String	是	获取数据起始时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如 2019-06-02T00:00:00+08:00。
EndTime	String	是	获取数据结束时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如 2019-06-02T00:01:00+08:00。
KeyType	String	是	排序指标。取值如下所示： `URL`：生成的图片访问 URL `UserAgent`：用户代理 `Refer`：请求 Refer `ClientIP`：客户端 IP `Region`：访问区域 `Domain`：域名 `Isp`：运营商
ValueType	String	是	排序依据，即获取按`ValueType`值排序的`KeyType`列表。取值如下所示： `Traffic`：按流量排序 `RequestCnt`：按请求次数排序说明当`KeyType`取值为`Domain`时，`ValueType`仅支持取值为`Traffic`，即按照流量排序获取域名列表。
ServiceIds	String	否	服务 ID。传入多个时用“,”作为分割符，缺省情况下表示不限制服务 ID。您可以在 veImageX 控制台服务管理页面，在创建好的图片服务中获取服务 ID。您也可以通过 OpenAPI 的方式获取服务 ID，具体请参考获取所有服务信息。
DomainNames	String	否	域名。传入多个时用“,”作为分割符，缺省情况下表示不限制域名。您可以通过调用获取服务下全部域名获取所需的域名。
IPVersion	String	否	网络协议。缺省情况下则表示不限制网络协议，取值如下所示： `IPv4` `IPv6` 说明 `KeyType`取值为`Domain`时，`IPVersion`的取值无效。
Limit	String	否	每页查询数据量，默认为`0`，即返回所有数据。
Offset	String	否	分页偏移量，默认取值为`0` 。取值为`10`时，表示跳过前 10 条数据，从第 11 条数据开始取值。
Country	String	否	数据访问区域。仅在`KeyType`取值为`Region`或`Isp`时生效，取值如下所示： `China`：中国。 `Other`：中国境外的区域。

返回参数

参数类型描述

Count Integer 可展示的数据总数量。

TopValue Array of TopValue 数据列表，按Value降序排列。

参数	类型	描述
Count	Integer	可展示的数据总数量。
TopValue	Array of TopValue	数据列表，按`Value`降序排列。
TotalValue	Float	总流量或总请求次数，取值如下所示：当`ValueType`取值为`Traffic`，表示总流量，单位为 Byte；当`ValueType`取值为`RequestCnt`，表示总请求次数，单位为次。

TotalValue

Float

总流量或总请求次数，取值如下所示：

当ValueType取值为Traffic，表示总流量，单位为 Byte；
当ValueType取值为RequestCnt，表示总请求次数，单位为次。

TopValue

参数类型描述

Key String 对应于参数KeyType的取值数据。

参数	类型	描述
Key	String	对应于参数`KeyType`的取值数据。
Value	Float	指标值。取值如下所示：当`ValueType`取值为`Traffic`，表示流量，单位为 Byte；当`ValueType`取值为`RequestCnt`，表示请求次数，单位为次。

Value

Float

指标值。取值如下所示：

当ValueType取值为Traffic，表示流量，单位为 Byte；
当ValueType取值为RequestCnt，表示请求次数，单位为次。

示例

请求示例

GET https://imagex.volcengineapi.com/?Action=DescribeImageXCDNTopRequestData&Version=2018-08-01&StartTime=2019-06-02T00:00:00+08:00&EndTime=2019-06-02T00:01:00+08:00&KeyType=URL&ValueType=RequestCnt&Limit=2

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "20201204164736010008073045100260DA",
        "Action": "DescribeImageXCDNTopRequestData",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
    "Count":1000,
    "TopValue":[
        {
            "Key":"xxxx.com/xxx/0/res/xxx/xxx.png",
            "Value":14312552
        },
        {
            "Key":"xxxx.com/xxx/1/res/xxx/xxx.png",
            "Value":13768439
        }
    ],
    "TotalValue":6780510067
 }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "202208081029270102251451520226FDC1",
        "Action": "DescribeImageXCDNTopRequestData",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1"
        "Error": {
            "CodeN": 280400,
            "Code": "",
            "Message": "parse query error"
        }
    },
    "Result": null
}

错误码

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

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

服务端 SDK

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