文档中心

查询黑白屏 TOP URL

最近更新时间：2023.07.04 20:07:10

首次发布时间：2023.02.24 16:48:07

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

说明

单次查询最大时间间隔为 93 天。

注意事项

请求频率：
- API 整体的请求频率限制为 100 次/秒。
- 单用户请求频率限制为 50 次/秒。
数据延迟：数据延迟约为 4 小时。

请求说明

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

说明

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

请求参数

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

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

Query

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

Body

参数	类型	是否必选	示例值	描述
Appid	String	否	`82630`	应用 ID。默认为空，不传则匹配账号下的所有的 App ID。您可以通过调用获取应用列表的方式获取所需的 AppID。
OS	String	否	`WEB`	需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示： `iOS` `Android` `WEB`
QualityType	String	是	`black_suspected`	类型。取值如下所示： `transparent_suspected`：透明图 `white_suspected`：白屏 `black_suspected`：黑屏
StartTime	String	是	`2017-09-23T01:11:03Z`	获取数据起始时间点。日期格式按照`ISO8601`表示法，格式为：`YYYY-MM-DDThh:mm:ss±hh:mm`，比如`2019-06-02T00:00:00+08:00`。起始时间与结束时间间隔小于等于 93 天。
EndTime	String	是	`2020-01-05T09:34:20Z`	获取数据结束时间点，需在起始时间点之后。日期格式按照`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=2018-08-01
{
    "StartTime": "2017-09-23T01:11:03Z",
    "EndTime": "2020-01-05T09:34:20Z",
    "QualityType": "black_suspected",
    "Appid": "xxxx",
    "Top": 1000,
    "OS": "2.3"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribeImageXClientTopQualityURL",
        "Version": "2018-08-01",        
        "Service": "imagex",
        "Region": "cn-north-1"        
    }
    "Result": {
        "TopUrlData": [
            {
                "Url": "http://xxx.xxx",
                "Count": 98
            }
        ]
    }
}

错误码

访问公共错误码和 veImageX 错误码获取详细信息。