You need to enable JavaScript to run this app.
导航

查询转码用量

最近更新时间2023.07.12 17:56:38

首次发布时间2022.12.06 19:25:08

此接口用于查询指定时间范围内转码功能的用量。

请求说明

  • 接口名称:DescribeVodSpaceTranscodeData
  • 接口地址:http://vod.volcengineapi.com/?Action=DescribeVodSpaceTranscodeData&Version=2020-08-01
  • 请求频率:单用户请求频率限制为 10 次/秒
  • 数据延迟:2 小时

请求参数

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

SpaceList

Array of String

点播空间名列表。

说明

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

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

EndTime

String

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

说明

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

TranscodeType

String

转码类型。默认为全选。取值如下:

  • Slice:倍速转码。
  • Normal:标准转码。
  • LowCost:低成本转码。
  • ByteHD:极智超清。

Specification

String

封装格式。取值如下:

  • Audio:音频。
  • ConvertFormat:原画转封装。
  • H.264_240p
  • H.264_360p
  • H.264_480p
  • H.264_540p
  • H.264_720p
  • H.264_2k
  • H.264_4k
  • H.265_240p
  • H.265_360p
  • H.265_480p
  • H.265_540p
  • H.265_720p
  • H.265_2k
  • H.265_4k
  • H.266_240p
  • H.266_360p
  • H.266_480p
  • H.266_540p
  • H.266_720p
  • H.266_2k
  • H.266_4k

TaskStageList

Array of String

任务类型。取值如下:

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

说明

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

Aggregation

Integer

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

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

DetailFieldList

Array of String

详细字段列表。是否根据查询条件返回更详细的数据,取值如下:

  • TaskStage:任务类型。
  • Space:点播空间名。

说明

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

返回参数

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

ResponseMetadata

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

ResponseError

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

VodDescribeVodSpaceTranscodeData

参数类型描述
SpaceListArray of String点播空间名列表。
StartTimeString查询起始时间。
EndTimeString查询结束时间。

TranscodeType

String

转码类型。取值如下:

  • Slice:倍速转码。
  • Normal:标准转码。
  • LowCost:低成本转码。
  • ByteHD:极智超清。

Specification

String

封装格式。取值如下:

  • Audio:音频。
  • ConvertFormat:原画转封装。
  • H.264_240p
  • H.264_360p
  • H.264_480p
  • H.264_540p
  • H.264_720p
  • H.264_2k
  • H.264_4k
  • H.265_240p
  • H.265_360p
  • H.265_480p
  • H.265_540p
  • H.265_720p
  • H.265_2k
  • H.265_4k
  • H.266_240p
  • H.266_360p
  • H.266_480p
  • H.266_540p
  • H.266_720p
  • H.266_2k
  • H.266_4k

TaskStageList

Array of String

任务类型。取值如下:

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

Aggregation

Integer

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

  • 3600:1 小时
  • 86400:1 天。
TotalTranscodeDataInteger所选时间段的转码总时长。单位为毫秒。
TotalTranscodeDataListArray of TranscodeItem各种封装格式的转码时长。
TranscodeDataDetailListArray of TranscodeUsage各种任务类型的转码时长。

TranscodeItem

参数类型描述

Name

String

封装格式。取值如下:

  • Audio:音频。
  • ConvertFormat:原画转封装。
  • H.264_240p
  • H.264_360p
  • H.264_480p
  • H.264_540p
  • H.264_720p
  • H.264_2k
  • H.264_4k
  • H.265_240p
  • H.265_360p
  • H.265_480p
  • H.265_540p
  • H.265_720p
  • H.265_2k
  • H.265_4k
  • H.266_240p
  • H.266_360p
  • H.266_480p
  • H.266_540p
  • H.266_720p
  • H.266_2k
  • H.266_4k
ValueInteger转码时长。单位为毫秒。

TranscodeUsage

参数类型描述
SpaceString点播空间名。

TaskStage

String

任务类型。取值如下:

  • busy:正常任务。
  • free:闲时任务。
TotalInteger转码时长,单位为毫秒。
TranscodeUsageListArray of TranscodeData转码用量详细数据。

TranscodeData

参数类型描述
TimeStringRFC3339 格式的 UTC 时间,精度为秒,例如:2021-04-13T00:00:00+08:00
TranscodeItemListArray of TranscodeItem转码项目列表。

示例

请求示例

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

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

{
  "SpaceList": ["test"],
  "StartTime":   "2022-04-18T20:00:00Z",
  "EndTime":     "2022-04-18T22:00:00Z",
  "TaskStageList": ["busy", "free"],
  "DetailFieldList": ["TaskStage"]
}

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

GET http://vod.volcengineapi.com/?Action=DescribeVodSpaceTranscodeData&Version=2020-08-01&SpaceList=test&StartTime=2022-04-18T20%3A00%3A00Z&EndTime=2022-04-18T20%3A00%3A00Z&TaskStageList=busy,free&DetailFieldList=TaskStage HTTP/1.1

返回示例

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

{
    "ResponseMetadata": {
        "RequestId": "20221123122***0380DAD1333",
        "Action": "DescribeVodSpaceTranscodeData",
        "Version": "2020-08-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
        "SpaceList": ["test"],
        "StartTime":   "2022-04-18T20:00:00Z",
        "EndTime":     "2022-04-18T22:00:00Z",
        "TotalTranscodeData": 100,
        "TotalTranscodeDataList": [
             {
          "Name": "Audio",
          "Value": 100
             }
        ],
        "TranscodeDataDetailList":[
            {
                "TaskStage": "busy",
                "Total": 11,
                "TranscodeUsageList": [
                {
                    "Time": "2022-04-18T20:00:00Z",
                    "TranscodeItemList": [
                       {
                          "Name": "Audio",
                          "Value": 100
                       }
                    ]
                }
              ]
           },
          {
            "TaskStage": "free",
            "Total": 11,
            "TranscodeUsageList": [
                {
                    "Time": "2022-04-18T20:00:00Z",
                    "TranscodeItemList": [
                       {
                          "Name": "Audio",
                          "Value": 100
                       }
                    ]
                }
            ]
          }
         ]
     }
}

错误码

详见视频点播公共错误码

服务端 SDK

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