You need to enable JavaScript to run this app.
导航
查询画质增强用量
最近更新时间:2023.07.12 17:56:38首次发布时间:2023.04.21 18:43:59

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

请求说明

  • 接口名称:DescribeVodEnhanceImageData
  • 接口地址:http://vod.volcengineapi.com/?Action=DescribeVodEnhanceImageUsage&Version=2020-08-01
  • 请求频率:单用户请求频率限制为 10 次/秒

请求参数

参数类型是否必选描述
ActionString接口名称。当前接口取值为 DescribeVodEnhanceImageData
VersionString接口版本。当前接口取值为 2020-08-01

SpaceList

Array of String

点播空间名列表。

说明

如果是 GET 请求,此参数类型为 String,多个空间名之间用 , 隔开。

TaskTypeList

Array of String

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

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

说明

如果是 GET 请求,此参数类型为 String,多个功能之间用 , 隔开。

TaskStageList

Array of String

任务类型。取值如下:

  • free:闲时任务
  • busy:正常任务

说明

如果是 GET 请求,此参数类型为 String,多个任务类型之间用 , 隔开。

StartTimeString查询的起始时间。日期格式要求符合 RFC3339 规范。例如:2022-04-18T20:00:00Z

EndTime

String

查询的结束时间。日期格式要求符合 RFC3339 规范。例如:2022-04-18T20:00:00Z

说明

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

Aggregation

Integer

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

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

返回参数

参数类型描述
ResponseMetadataResponseMetadata响应通用信息
ResultVodDescribeVodEnhanceImageData响应结果

ResponseMetadata

参数类型描述
RequestIdString请求 ID
ActionString请求接口
VersionString版本
ServiceString服务
RegionString区域
ErrorResponseError异常信息

ResponseError

参数类型描述
CodeString错误码
MessageString详细错误信息

VodDescribeVodEnhanceImageData

参数类型描述
SpaceListArray of String点播空间名列表。

TaskTypeList

Array of String

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

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

TaskStageList

Array of String

任务类型。取值如下:

  • free:闲时任务
  • busy:正常任务
StartTimeString查询的起始时间。日期格式要求符合 RFC3339 规范。例如:2022-04-18T20:00:00Z
EndTimeString查询的结束时间。日期格式要求符合 RFC3339 规范。例如:2022-04-18T20:00:00Z

Aggregation

Integer

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

  • 3600:1 小时
  • 86400:1 天
TotalEnhanceImagDataInteger所选时间段的画质增强总用量,单位为毫秒。
EnhanceImageListArray of EnhanceImageList画质增强用量详细数据。

EnhanceImageList

参数类型描述
TimeString时间。
SRInteger智能超分功能使用时长,单位为毫秒。
VFIInteger智能插帧功能使用时长,单位为毫秒。
SDREnhanceIntegerSDR 增强功能使用时长,单位为毫秒。
SDR2HDRIntegerSDR2HDR 功能使用时长,单位为毫秒。
AudioDenoseInteger音频降噪功能使用时长,单位毫秒。

示例

请求示例

如果用 POST 方式发起请求,示例如下:

POST https://vod.volcengineapi.com?Action=DescribeVodEnhanceImageData&Version=2020-08-01 HTTP/1.1
Content-Type: application/json

{
  "SpaceList": ["test"],
  "StartTime": "2022-04-12T16:00:00Z",
  "EndTime": "2022-04-13T16:00:00Z",
  "Aggregation": 3600
}

如果用 GET 方式发起请求,示例如下:

GET https://vod.volcengineapi.com?Action=DescribeVodEnhanceImageData&Version=2020-08-01&DomainList=www.test.com&StartTime=2022-04-18T20%3A00%3A00Z&EndTime=2022-04-18T20%3A00%3A00Z&BandwidthType=CDN HTTP/1.1

正常返回示例

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

{
  "ResponseMetadata":{
    "RequestId": "20180604110***0100232280022D30",
    "Action": "DescribeVodEnhanceImageData",
    "Version": "2020-08-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,
      }
    ]
  }
}

异常返回示例

HTTP/1.1 400 Bad Request
Content-Length: 190
Content-Type: application/json

{
  "ResponseMetadata":{
    "RequestId": "20180604110***232280022D30",
    "Action": "DescribeVodEnhanceImageData",
    "Version": "2020-08-01",
    "Service": "vod",
    "Region": "cn-north-1",
    "Error":{
      "Code": "280400",
      "Message": "must have X-Top-Account-Id"
    }
  }
}

错误码

详见视频点播公共错误码