You need to enable JavaScript to run this app.
导航
veImageX
  • 文档首页
    • /
  • veImageX

获取数据统计分析结果

最近更新时间：2024.04.12 15:11:27

首次发布时间：2024.04.12 15:11:27

我的收藏

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

说明

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

注意事项

  • 请求频率：单用户请求频率限制为 50 次/秒。
  • 数据延迟：数据延迟约为 20~30 分钟。
  • 服务地址：veImageX 在全球多个区域部署，每个区域有自己对应的 OpenAPI 域名，不支持跨区域调用。具体详情请查看服务地址。

请求说明

  • 请求方式：GET
  • 请求地址：https://imagex.volcengineapi.com/?Action=DescribeImageXCDNTopRequestData&Version=2023-05-01

请求参数

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

Query

参数类型是否必选示例值描述
ActionString是DescribeImageXCDNTopRequestData接口名称。当前 API 的名称为 DescribeImageXCDNTopRequestData。
VersionString是2023-05-01接口版本。当前 API 的版本为 2023-05-01。
ServiceIdsString否s1,s2服务 ID。支持查询多个服务，传入多个时用英文逗号“,”分割，缺省情况下表示查询所有服务。您可以在 veImageX 控制台的服务管理模块或者调用 GetAllImageServices 接口获取服务 ID。
DomainNamesString否d1,d2域名。支持查询多个域名，传入多个时用英文逗号“,”分割，缺省情况下表示查询所有域名。您可以通过调用 GetServiceDomains 获取所需的域名。

IPVersion

String

否

IPv4

网络协议。缺省情况下则表示不限制网络协议，取值如下所示：

  • IPv4
  • IPv6

说明

KeyType取值为Domain时，IPVersion的取值无效。

Country

String

否

China

数据访问区域。仅在KeyType取值为Region或Isp时生效，取值如下所示：

  • China：中国。
  • Other：中国境外的区域。

KeyType

String

是

URL

排序依据，取值如下所示：

  • URL：生成的图片访问 URL
  • UserAgent：用户代理
  • Refer：请求 Refer
  • ClientIP：客户端 IP
  • Region：访问区域
  • Domain：域名
  • Isp：运营商

ValueType

String

是

Traffic

排序依据，即获取按ValueType值排序的KeyType列表。取值如下所示：

  • Traffic：按流量排序
  • RequestCnt：按请求次数排序

说明

当KeyType取值为Domain时，仅支持将ValueType取值为Traffic，即按照流量排序获取域名列表。

StartTimeString是2019-06-02T00:00:00+08:00获取数据起始时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如 2019-06-02T00:00:00+08:00。
EndTimeString是2019-06-02T00:00:00+08:00获取数据结束时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如 2019-06-02T00:00:00+08:00。
LimitString否10每页查询数据量，默认为0，即返回所有数据。
OffsetString否1分页偏移量，默认取值为0 。取值为10时，表示跳过前 10 条数据，从第 11 条数据开始取值。

返回参数

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

参数类型示例值描述
CountInteger1000可展示的数据总数量。
TopValueArray of TopValue-数据列表，按Value降序排列。

TotalValue

Float

123

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

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

TopValue

参数类型示例值描述
KeyStringu1对应于参数KeyType的取值数据。

Value

Float

123

指标值。取值如下所示：

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

请求示例

GET https://imagex.volcengineapi.com/?Action=DescribeImageXCDNTopRequestData&Version=2023-05-01&ServiceIds=s1,s2&DomainNames=d1,d2&IPVersion=IPv4&Country=China&KeyType=URL&ValueType=Traffic&StartTime=2019-06-02T00:00:00+08:00&EndTime=2019-06-02T00:00:00+08:00&Limit=10&Offset=1

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DescribeImageXCDNTopRequestData",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "Count": 1000,
        "TopValue": [
            {
                "Key": "u1",
                "Value": 123
            }
        ],
        "TotalValue": 123
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。更多信息请见公共错误码和 veImageX 错误码。

状态码错误码错误信息说明
400InvalidParameterMissing Parameter.请求参数错误，请检查您的请求参数是否正确。
401ParamAccountMismatchParam {} did not belong to your account.请求参数不属于账号，请检查您的请求参数是否正确。
500InternalErrorInternal Error.内部错误，请提交工单联系技术支持。