You need to enable JavaScript to run this app.
导航
查询画质增强用量
最近更新时间:2024.06.14 17:20:13首次发布时间:2023.10.16 10:38:46

此接口用于在指定空间维度下,查询一定时间范围内画质增强功能的用量。

注意事项

  • 计费说明:画质增强计费价格请参见按量计费
  • 请求频率:单用户请求频率限制为 10 次/秒
  • 数据延迟:4 小时
  • 时间范围:查询的时间跨度不超过 93 天
  • 权限说明:当使用子账号请求接口时,接口会按照子账号进行权限校验,只返回该子账号有权限的数据。详见给子账号添加项目权限说明。

请求说明

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

调试

请求参数

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

参数
类型
是否必选
示例值
描述
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 规范。
EndTime
String
2022-04-13T16:00:00Z

查询的结束时间。日期格式要求符合 RFC3339 规范。

说明

单次查询的时间跨度不可超过 93 天。

Aggregation
Long
3600

聚合的时间粒度。单位为秒。取值如下:

  • 86400:(默认)1 天
  • 3600:1 小时

返回参数

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

参数
类型
示例值
描述
SpaceList
String[]
["test"]
点播空间名列表。
TaskTypeList
String[]
SR

画质增强功能类型。取值如下:

  • SR:智能超分
  • VFI:插帧
  • SDREnhance:SDR 增强
  • SDR2HDR:SDR 转 HDR
  • AudioDenoise:音频降噪
TaskStageList
String[]
busy

任务类型。取值如下:

  • free:闲时任务
  • busy:正常任务
StartTime
String
2022-04-12T16:00:00Z
查询的起始时间。日期格式要求符合 RFC3339 规范。
EndTime
String
2022-04-13T16:00:00Z
查询的结束时间。日期格式要求符合 RFC3339 规范。
Aggregation
Long
3600

聚合的时间粒度。单位为秒。取值如下:

  • 3600:1 小时
  • 86400:1 天
TotalEnhanceImagData
Long
100
所选时间段的画质增强总用量,单位为毫秒。
EnhanceImageList
Object[]
-
画质增强用量详细数据。
Time
String
2022-04-13T:00:00Z
时间。
SR
Long
20
智能超分功能使用时长,单位为毫秒。
VFI
Long
20
智能插帧功能使用时长,单位为毫秒。
SDREnhance
Long
20
SDR 增强功能使用时长,单位为毫秒。
SDR2HDR
Long
20
SDR2HDR 功能使用时长,单位为毫秒。
AudioDenose
Long
3600
音频降噪功能使用时长,单位毫秒。
RegionList
String[]

请求示例

https://vod.volcengineapi.com?Action=DescribeVodEnhanceImageData&Version=2023-07-01&SpaceList=test&TaskTypeList=&TaskStageList=&StartTime=2022-04-12T16%3A00%3A00Z&EndTime=2022-04-13T16%3A00%3A00Z&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
      }
    ]
  }
}

错误码

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

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK,支持多种编程语言,帮助您实现快速开发。建议使用服务端 SDK 来调用 API。此 API 各语言调用的示例代码,请参考如下: