You need to enable JavaScript to run this app.
导航
查询解码成功率
最近更新时间:2024.04.12 15:11:30首次发布时间:2024.04.12 15:11:30

本接口支持通过指定查询维度,来获取客户端状态监控的解码成功率数据。

说明

单次查询的时间跨度不能超过 90 天。

注意事项

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

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringDescribeImageXClientDecodeSuccessRateByTime接口名称。当前 API 的名称为 DescribeImageXClientDecodeSuccessRateByTime
VersionString2023-05-01接口版本。当前 API 的版本为 2023-05-01

Body

参数类型是否必选示例值描述

Appid

String

123

应用 ID。默认为空,不传则匹配账号下的所有的 AppID。

说明

您可以通过调用获取应用列表的方式获取所需的 AppID。

AppVerArray of String["1.2.0"]需要匹配的 App 版本,不传则匹配 App 的所有版本。

OS

String

WEB

需要匹配的系统类型,不传则匹配非 WEB 端的所有系统。取值如下所示:

  • iOS
  • Android
  • WEB
SdkVerArray of String["1.2.0"]需要匹配的 SDK 版本,不传则匹配所有版本.

Country

String

海外

需要匹配的国家名称。

  • 不传则匹配所有国家。
  • 取值为海外时,匹配海外所有国家。
ProvinceString北京需要匹配的省份名称,不传则匹配所有省份。

Isp

Array of String

["电信"]

需要匹配的运营商名称,不传则匹配所有运营商。取值如下所示:

  • 电信
  • 联通
  • 移动
  • 铁通
  • 鹏博士
  • 教育网
  • 其他
DomainArray of String["d1"]需要匹配的域名,不传则匹配所有域名。

ImageType

Array of String

["PNG"]

需要匹配的图片类型,不传则匹配所有图片类型。取值如下所示:

  • GIF
  • PNG
  • JPEG
  • HEIF
  • HEIC
  • WEBP
  • AWEBP
  • VVIC
  • 其他
ExtraDimsArray of ExtraDims-需要匹配的自定义维度项 。

GroupBy

String

OS

拆分维度。默认为空,不拆分。支持取值:

  • 公共维度:AppidOSAppVerSdkVerImageTypeCountryProvinceIspDomain
  • 自定义维度:您可以通过调用 获取自定义维度列表接口获取自定义维度指标。

StartTime

String

2019-06-27T13:00:00+08:00

获取数据起始时间点。
日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00

EndTime

String

2019-06-27T15:00:00+08:00

获取数据结束时间点,需在起始时间点之后。
日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm,比如2019-06-02T00:00:00+08:00

Granularity

String

1h

返回数据的时间粒度。取值如下所示:

  • 5m:5 分钟;
  • 1h:1 小时;
  • 1d:1 天。

ExtraDims

参数类型是否必选示例值描述

Dim

String

access

自定义维度名称。

说明

您可以通过调用获取自定义维度列表来获取。

Vals

Array of String

["4g"]

需要匹配的对应维度值

说明

您可以通过调用获取自定义维度值来获取。

返回参数

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

参数类型示例值描述
SuccessRateDataArray of SuccessRateData-解码成功率数据。

SuccessRateData

参数类型示例值描述
TypeStringTotal数据类型,不拆分时值为Total,拆分时为具体的维度值。
CountInteger123该数据类型对应的总上报量。
DataArray of Data-对应的解码成功率数据列表。

Data

参数类型示例值描述
ValueFloat0.98解码成功率。
CountInteger123数据对应的上报量。

Timestamp

String

2023-01-01T00:00:00+08:00

数据对应时间点。
日期格式按照ISO8601表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm

请求示例

POST https://imagex.volcengineapi.com/?Action=DescribeImageXClientDecodeSuccessRateByTime&Version=2023-05-01&=
{
    "Appid": "123",
    "AppVer": [
        "1.2.0"
    ],
    "OS": "WEB",
    "SdkVer": [
        "1.2.0"
    ],
    "Country": "海外",
    "Province": "北京",
    "Isp": [
        "电信"
    ],
    "Domain": [
        "d1"
    ],
    "ImageType": [
        "PNG"
    ],
    "ExtraDims": [
        {
            "Dim": "access",
            "Vals": [
                "4g"
            ]
        }
    ],
    "GroupBy": "OS",
    "StartTime": "2019-06-27T13:00:00+08:00",
    "EndTime": "2019-06-27T15:00:00+08:00",
    "Granularity": "1h"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202306041104200100100232280022D31",
        "Action": "DescribeImageXClientDecodeSuccessRateByTime",
        "Version": "2023-05-01",
        "Service": "ImageX",
        "Region": "cn-north-1"
    },
    "Result": {
        "SuccessRateData": [
            {
                "Type": "Total",
                "Count": 123,
                "Data": [
                    {
                        "Value": 0.98,
                        "Count": 123,
                        "Timestamp": "2023-01-01T00:00:00+08:00"
                    }
                ]
            }
        ]
    }
}

错误码

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

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

服务端 SDK

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