查询黑白屏率时序数据--veImageX-火山引擎

文档中心

立即注册

导航

查询黑白屏率时序数据

最近更新时间：2024.08.09 10:27:34首次发布时间：2023.02.24 16:48:07

本接口支持通过指定查询维度，来获取客户端状态监控的黑白屏率时序数据。（黑白屏监控指客户端解码后出现纯黑、纯白、透明图占上报图片总数量的比例。）

说明

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

请求说明

接口名称：DescribeImageXClientQualityRateByTime
请求方式：POST
接口地址示例：https://imagex.volcengineapi.com/?Action=DescribeImageXClientQualityRateByTime&Version=2018-08-01
请求频率：
- API 整体的请求频率限制为 100 次/秒。
- 单用户请求频率限制为 50 次/秒。
数据延迟：数据延迟时间约为 15 分钟。
单次查询的最大时间跨度 90 天。

说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	描述
Appid	String	否	应用 ID。默认为空，不传则匹配账号下的所有的 App ID。说明您可以通过调用获取应用列表的方式获取所需的 AppID。
AppVer	Array of String	否	需要匹配的 App 版本，不传则匹配 App 的所有版本。
OS	String	否	需要匹配的系统类型，不传则匹配非 WEB 端的所有系统。取值如下所示： `iOS` `Android` `WEB`
SdkVer	Array of String	否	需要匹配的 SDK 版本，不传则匹配所有版本。
Country	String	否	需要匹配的国家名称，不传则匹配所有国家，取值`海外`匹配海外所有国家。
Province	String	否	需要匹配的省份名称，不传则匹配所有省份。
Isp	Array of String	否	需要匹配的运营商名称，不传则匹配所有运营商。取值如下所示： `电信` `联通` `移动` `铁通` `鹏博士` `教育网` `其他`
Domain	Array of String	否	需要匹配的域名，不传则匹配所有域名。您可以通过调用获取服务下全部域名获取所需的域名。
ImageType	Array of String	否	需要匹配的图片类型，不传则匹配所有图片类型。取值如下所示： `GIF` `PNG` `JPEG` `HEIF` `HEIC` `WEBP` `AWEBP` `VVIC` `其他`
ExtraDims	Array of ExtraDims	否	需要匹配的自定义维度项
GroupBy	String	否	拆分维度。默认为空，不拆分。支持取值：公共维度：`Appid`、`OS`、`AppVer`、`SdkVer`、`ImageType`、`Country`、`Province`、`Isp`、`Domain` 自定义维度：您可以通过调用 GetImageXQueryDims接口获取自定义维度指标
QualityType	String	是	质量类型。取值如下所示： `white_suspected`：查询白屏率 `black_suspected`：查询黑屏率 `transparent_suspected`：查询透明图率
StartTime	String	是	获取数据起始时间点。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如 2019-06-02T00:00:00+08:00。起始时间与结束时间间隔小于等于 90 天。
EndTime	String	是	获取数据结束时间点，需在起始时间点之后。日期格式按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm，比如 2019-06-02T00:00:00+08:00。起始时间与结束时间间隔小于等于 90 天。
Granularity	String	是	返回数据的时间粒度，取值如下所示： `5m`：5 分钟 `1h`：1 小时 `1d`：1 天

ExtraDims

参数	类型	是否必选	描述
Dim	String	是	自定义维度名称。您可以通过调用获取自定义维度列表来获取。
Vals	Array of String	是	需要匹配的对应维度值。您可以通过调用获取自定义维度值来获取。

返回参数

参数	类型	描述
QualityRateData	Array of QualityRateData	黑白屏率数据

QualityRateData

参数	类型	描述
Type	String	数据类型，不拆分时值为`Total`，拆分时为具体的维度值。
Count	Integer	该数据类型对应的总上报量。
Data	Array of Data	具体数据

Data

参数	类型	描述
Value	Float	黑白屏率
Count	Integer	数据对应的上报量。
Timestamp	String	数据对应时间点，按照 ISO8601 表示法，格式为：YYYY-MM-DDThh:mm:ss±hh:mm。

示例

请求示例

POST https://imagex.volcengineapi.com/?Action=DescribeImageXClientQualityRateByTime&Version=2018-08-01 
{
    "StartTime": "2013-11-17T22:07:46Z",
    "EndTime": "2008-11-27T21:09:53Z",
    "Granularity": "5m",
    "QualityType": "xxx",
    "OS": "1.2",
    "ExtraDims": [
        {
            "Dim": "xxxx",
            "Vals": [
                "xxxx"
            ]
        }
    ],
    "Appid": "xxx",
    "SdkVer": [
        "2.3.0"
    ],
    "ImageType": [
        "xxx"
    ],
    "AppVer": [
        "3.4"
    ],
    "GroupBy": "xxx"
}

正常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribeImageXClientQualityRateByTime",
        "Version": "2018-08-01",       
        "Service": "imagex",
        "Region": "cn-north-1"
    },
    "Result": {
        "QualityRateData": [
            {
                "Type": "Total",
                "Count": 1000,
                "Data": [
                    {
                        "Timestamp": "2020-01-01T08:00:00+08:00",
                        "Value": 60.47,
                        "Count": 67
                    }
                ]
            }
        ]
    }
}

异常返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "DescribeImageXClientQualityRateByTime",
        "Version": "2018-08-01",
        "Service": "imagex",
        "Region": "cn-north-1",
        "Error": {
            "Code": "200000",
            "Message": "参数异常"
        }
    }
}

错误码

访问公共错误码以及通用错误码获取详细信息。