本接口支持通过指定查询维度,来获取 HEIF 编码监控的编码成功率时序数据。
说明
单次查询的时间跨度不能超过 90 天。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeImageXHeifEncodeSuccessRateByTime | 接口名称。当前 API 的名称为 DescribeImageXHeifEncodeSuccessRateByTime 。 |
Version | String | 是 | 2023-05-01 | 接口版本。当前 API 的版本为 2023-05-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Appid | String | 否 |
| 应用 ID。默认为空,不传则匹配账号下的所有的 App ID。 说明 您可以通过调用获取应用列表的方式获取所需的 AppID。 |
AppVer | Array of String | 否 | ["1.2.0"] | 需要匹配的 App 版本,不传则匹配 App 的所有版本。 |
OS | String | 否 |
| 需要匹配的系统类型,不传则匹配所有系统。取值如下所示:
|
SdkVer | Array of String | 否 | ["1.2.0"] | 需要匹配的 SDK 版本,不传则匹配所有版本。 |
ImageType | Array of String | 否 | ["PNG"] | 需要匹配的图片类型,不传则匹配所有图片类型。 |
ImageResolution | Array of String | 否 | ["0-360p(含)"] | 需要匹配的图片分辨率,不传则匹配所有图片分辨率。 |
ExtraDims | Array of ExtraDims | 否 | - | 需要匹配的自定义维度项 。 |
GroupBy | String | 否 |
| 拆分维度。默认为空,标识不拆分。支持取值:
|
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 | 是 |
| 返回数据的时间粒度。
|
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Dim | String | 是 |
| 自定义维度名称。 说明 您可以通过调用获取自定义维度列表来获取。 |
Vals | Array of String | 是 |
| 需要匹配的对应维度值 说明 您可以通过调用获取自定义维度值来获取。 |
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
SuccessRateData | Array of SuccessRateData | - | 编码成功率数据。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Type | String |
| 数据类型。
|
Count | Integer | 333 | 数据上报总量。 |
Data | Array of Data | - | 对应的编码成功率数据列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Value | Float | 0.95 | 编码成功率。 |
Count | Integer | 333 | 数据上报量。 |
Timestamp | String | 2023-01-01T00:00:00+08:00 | 数据对应时间点。日期格式按照ISO8601 表示法,格式为:YYYY-MM-DDThh:mm:ss±hh:mm 。 |
POST https://imagex.volcengineapi.com/?Action=DescribeImageXHeifEncodeSuccessRateByTime&Version=2023-05-01 { "Appid": "123", "AppVer": [ "1.2.0" ], "OS": "WEB", "ImageType": [ "PNG" ], "ExtraDims": [ { "Dim": "has_alpha", "Vals": [ "4g" ] } ], "GroupBy": "OS", "StartTime": "2019-06-27T13:00:00+08:00", "EndTime": "2019-06-27T15:00:00+08:00", "Granularity": "1h", "SdkVer": [ "1.2.0" ], "ImageResolution": [ "0-360p(含)" ] }
{ "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "DescribeImageXHeifEncodeSuccessRateByTime", "Version": "2023-05-01", "Service": "ImageX", "Region": "cn-north-1" }, "Result": { "SuccessRateData": [ { "Type": "Total", "Count": 333, "Data": [ { "Value": 0.95, "Count": 333, "Timestamp": "2023-01-01T00:00:00+08:00" } ] } ] } }
下表为您列举了该接口与业务逻辑相关的错误码。更多信息请见公共错误码和 veImageX 错误码。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | InvalidParameter | Missing Parameter. | 请求参数错误,请检查您的请求参数是否正确。 |
401 | ParamAccountMismatch | Param {} did not belong to your account. | 请求参数不属于账号,请检查您的请求参数是否正确。 |
500 | InternalError | Internal Error. | 内部错误,请提交工单联系技术支持。 |