查询黑白屏 TOP URL--veImageX-火山引擎

文档中心

立即注册

导航

veImageX

查询黑白屏 TOP URL

最近更新时间：2024.08.13 20:23:51首次发布时间：2024.04.12 15:11:29

本接口支持通过指定查询维度，来获取客户端状态监控的黑白屏 Top URL 数据明细。

注意事项

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

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

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

Query

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

Body

参数	类型	是否必选	示例值	描述
Appid	String	否	`123`	应用 ID。默认为空，不传则匹配账号下的所有的 AppID。您可以通过调用获取应用列表的方式获取所需的 AppID。
OS	String	否	`iOS`	需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示： `iOS` `Android` `WEB`
QualityType	String	是	`black_suspected`	类型。取值如下所示： `transparent_suspected`：透明图 `white_suspected`：白屏 `black_suspected`：黑屏
StartTime	String	是	`2023-01-01T00:00:00+08:00`	获取数据起始时间点。日期格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如`2019-06-02T00:00:00+08:00`。起始时间与结束时间间隔小于等于 93 天。
EndTime	String	是	`2023-01-01T00:00:00+08:00`	获取数据结束时间点，需在起始时间点之后。日期格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如`2019-06-02T00:00:00+08:00`。起始时间与结束时间间隔小于等于 93 天。
Top	Integer	否	`1000`	查询 Top URL 条数，取值范围为 [0,1000]，默认值为 1000。

返回参数

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

参数	类型	示例值	描述
TopUrlData	Array of TopUrlData	`-`	Top URL数据

TopUrlData

参数	类型	示例值	描述
Url	String	`http://xxx.xxx`	文件URL
Count	Integer	`98`	上报数据量

请求示例

POST https://imagex.volcengineapi.com/?Action=DescribeImageXClientTopQualityURL&Version=2023-05-01&=
{
    "Appid": "123",
    "OS": "iOS",
    "QualityType": "black_suspected",
    "StartTime": "2023-01-01T00:00:00+08:00",
    "EndTime": "2023-01-01T00:00:00+08:00",
    "Top": 1000
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DescribeImageXClientTopQualityURL",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "TopUrlData": [
            {
                "Url": "http://xxx.xxx",
                "Count": 98
            }
        ]
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。更多信息请见公共错误码和 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 版本 DescribeImageXClientTopQualityURL 接口文档现已停止维护，建议您参考本文档使用最新版本。