文档中心

查询画质增强用量

最近更新时间：2024.04.01 18:01:09

首次发布时间：2023.10.16 10:38:46

此接口用于查询指定时间范围内画质增强功能的用量。

注意事项

请求频率：单用户请求频率限制为 10 次/秒。
权限说明：当使用子账号请求接口时，接口会按照子账号进行权限校验，只返回该子账号有权限的数据。详见给子账号添加项目权限说明。

请求说明

请求地址：https://vod.volcengineapi.com?Action=DescribeVodEnhanceImageData&Version=2023-07-01

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeVodEnhanceImageData`	接口名称。当前 API 的名称为 `DescribeVodEnhanceImageData`。
Version	String	是	`2023-07-01`	接口版本。当前 API 的版本为 `2023-07-01`。
SpaceList	String	否	`test`	点播空间名列表。多个空间名之间用英文逗号 `,` 隔开。说明如果是 POST 请求，此参数类型为 Array of String。
TaskTypeList	String	否	`SR`	画质增强功能类型。多个功能之间用 `,` 隔开。取值如下： `SR`：智能超分 `VFI`：插帧 `SDREnhance`：SDR 增强 `SDR2HDR`：SDR 转 HDR `AudioDenoise`：音频降噪说明如果是 POST 请求，此参数类型为 Array of String。
TaskStageList	String	否	`busy`	任务类型。多个任务类型之间用 `,` 隔开。取值如下： `free`：闲时任务 `busy`：正常任务说明如果是 POST 请求，此参数类型为 Array of String。
StartTime	String	是	`2022-04-12T16:00:00Z`	查询的起始时间。日期格式要求符合 RFC3339 规范。说明开始时间最早不早于当前时间的 366 天。
EndTime	String	是	`2022-04-13T16:00:00Z`	查询的结束时间。日期格式要求符合 RFC3339 规范。说明单次查询的时间跨度不可超过 93 天。
Aggregation	Long	是	`3600`	聚合的时间粒度。单位为秒。取值如下： `86400`：（默认）1 天 `3600`：1 小时

返回参数

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

参数	类型	示例值	描述
SpaceList	Array of String	`["test"]`	点播空间名列表。
TaskTypeList	Array of String	`SR`	画质增强功能类型。取值如下： `SR`：智能超分 `VFI`：插帧 `SDREnhance`：SDR 增强 `SDR2HDR`：SDR 转 HDR `AudioDenoise`：音频降噪
TaskStageList	Array of String	`busy`	任务类型。取值如下： `free`：闲时任务 `busy`：正常任务
StartTime	String	`2022-04-12T16:00:00Z`	查询的起始时间。日期格式要求符合 RFC3339 规范。
EndTime	String	`2022-04-13T16:00:00Z`	查询的结束时间。日期格式要求符合 RFC3339 规范。
Aggregation	Integer	`3600`	聚合的时间粒度。单位为秒。取值如下： `3600`：1 小时 `86400`：1 天
TotalEnhanceImagData	Integer	`100`	所选时间段的画质增强总用量，单位为毫秒。
EnhanceImageList	Array of EnhanceImageList	`-`	画质增强用量详细数据。

EnhanceImageList

参数	类型	示例值	描述
Time	String	`2022-04-13T:00:00Z`	时间。
SR	Integer	`20`	智能超分功能使用时长，单位为毫秒。
VFI	Integer	`20`	智能插帧功能使用时长，单位为毫秒。
SDREnhance	Integer	`20`	SDR 增强功能使用时长，单位为毫秒。
SDR2HDR	Integer	`20`	SDR2HDR 功能使用时长，单位为毫秒。
AudioDenose	Integer	`3600`	音频降噪功能使用时长，单位毫秒。

请求示例

https://vod.volcengineapi.com?Action=DescribeVodEnhanceImageData&Version=2023-07-01&SpaceList=["test"]&TaskTypeList=&TaskStageList=&StartTime=2022-04-12T16:00:00Z&EndTime=2022-04-13T16:00:00Z&Aggregation=3600

返回示例

HTTP/1.1 200 OK
Content-Length: 190
Content-Type: application/json

{
  "ResponseMetadata":{
    "RequestId": "20180604110***0100232280022D30",
    "Action": "DescribeVodEnhanceImageData",
    "Version": "2023-07-01",
    "Service": "vod",
    "Region": "cn-north-1"
  },
  "Result":{
    "SpaceList": ["test"],
    "StartTime": "2022-04-12T16:00:00Z",
    "EndTime": "2022-04-13T16:00:00Z",
    "Aggregation": 3600,
    "TotalEnhanceImagData": 100,
    "EnhanceImageList": [
      {
          "Time": "2022-04-13T:00:00Z",
          "SR": 20,
          "VFI": 20,
          "SDREnhance": 20,
          "SDR2HDR": 20,
      },
      {
          "Time": "2022-04-13T:00:00Z",
          "SR": 20,
          "FrameInterpolation": 20,
          "SDREnhance": 20,
          "SDRToHDR": 20,
          "AudioDenose": 3600
      }
    ]
  }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

注意事项

请求说明

调试

请求参数

返回参数

EnhanceImageList

请求示例

返回示例

错误码

视频点播

查询画质增强用量

注意事项

请求说明

调试

请求参数

返回参数

EnhanceImageList

请求示例

返回示例

错误码