查询大图文件分辨率 Top URL--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

查询大图文件分辨率 Top URL

最近更新时间：2024.08.13 20:23:50首次发布时间：2024.03.19 20:35:15

本接口支持查询大图文件分辨率 Top 1000 的 URL 数据。

注意事项

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

请求说明

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

请求参数

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

参数	类型	是否必选	示例值	描述
Content-Type	String	是	`application/json`	请求头数据

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeImageXSensibleTopResolutionURL`	接口名称。当前 API 的名称为 `DescribeImageXSensibleTopResolutionURL`。
Version	String	是	`2023-05-01`	接口版本。当前 API 的版本为 `2023-05-01`。

Body

参数	类型	是否必选	示例值	描述
Appid	String	否	`123`	应用 ID。默认为空，缺省情况下匹配账号下的所有的 App ID。您可以通过调用GetImageXQueryApps的方式获取所需的 AppID。
OS	String	否	`Android`	需要匹配的系统类型，缺省情况下匹配非 WEB 端的所有系统。取值如下所示： `iOS` `Android` `WEB`
AppVer	Array of String	否	`["1.0.0"]`	需要匹配 App 版本，缺省情况下则匹配 App 的所有版本。
SdkVer	Array of String	否	`["1.0.0"]`	需要匹配的 SDK 版本，缺省情况下匹配所有版本。
ImageType	Array of String	否	`["PNG"]`	需要匹配的图片类型，缺省情况下则匹配所有图片类型。支持以下取值： `GIF` `PNG` `JPEG` `HEIF` `HEIC` `WEBP` `AWEBP` `VVIC` `AVIF` `AVIS` `其他`
ExtraDims	Array of ExtraDims	否	`-`	需要匹配的自定义维度项
StartTime	String	是	`2019-06-02T00:00:00+08:00`	获取数据起始时间点。日期格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如`2019-06-02T00:00:00+08:00`。
EndTime	String	是	`2019-06-03T00:00:00+08:00`	获取数据结束时间点，需在起始时间点之后。日期格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如`2019-06-02T00:00:00+08:00`。
Top	Integer	否	`1000`	查询 Top URL 条数，取值范围为(0,1000]。缺省情况下默认为 1000。
OrderByIdx	Integer	是	`1`	支持以下取值： `1`：按上报次数排序； `2`：按图片分辨率排序； `3`：按 view 分辨率排序。

ExtraDims

参数	类型	是否必选	示例值	描述
Dim	String	是	`biz_tag`	自定义维度名称。说明您可以通过调用获取自定义维度列表来获取。
Vals	Array of String	是	`["4g"]`	需要匹配的对应维度值。说明您可以通过调用获取自定义维度值来获取。

返回参数

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

参数	类型	示例值	描述
TopUrlData	Array of TopUrlData	`-`	具体数据

TopUrlData

参数	类型	示例值	描述
Count	Integer	`124`	上报次数
ImageHeight	Integer	`833`	图片高
ImageWidth	Integer	`481`	图片宽
URL	String	`http://xxx.image`	图片 URL
ViewHeight	Integer	`800`	图片展示背景 view 高
ViewWidth	Integer	`500`	图片展示背景 view 宽
ActivityViewTree	String	`Controller/View`	Activity+View 树，控件信息
BizTag	String	`xxxx`	业务标识

请求示例

POST https://imagex.volcengineapi.com/?Action=DescribeImageXSensibleTopResolutionURL&Version=2023-05-01&=
{
    "Appid": "123",
    "OS": "Android",
    "AppVer": [
        "1.0.0"
    ],
    "SdkVer": [
        "1.0.0"
    ],
    "ImageType": ["PNG"],
    "ExtraDims": [
        {
            "Dim": "biz_tag",
            "Vals": [
                "4g"
            ]
        }
    ],
    "StartTime": "2019-06-02T00:00:00+08:00",
    "EndTime": "2019-06-03T00:00:00+08:00",
    "Top": 1000,
    "OrderByIdx": 1
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DescribeImageXSensibleTopResolutionURL",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "TopUrlData": [
            {
                "Count": 124,
                "ImageHeight": 833,
                "ImageWidth": 481,
                "URL": "http://xxx.image",
                "ViewHeight": 800,
                "ViewWidth": 500,
                "ActivityViewTree": "Controller/View",
                "BizTag": "xxxx"
            }
        ]
    }
}

错误码

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

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

服务端 SDK

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

历史版本

2018-08-01 版本 DescribeImageXSensibleTopResolutionURL 接口文档现已停止维护，建议您参考本文档使用最新版本。