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

查询转码用量

最近更新时间2024.01.16 20:28:07

首次发布时间2023.10.16 10:38:47

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

注意事项

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

请求说明

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

调试

请求参数

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

参数类型是否必选示例值描述
ActionStringDescribeVodSpaceTranscodeData接口名称。当前 API 的名称为 DescribeVodSpaceTranscodeData
VersionString2023-07-01接口版本。当前 API 的版本为 2023-07-01

SpaceList

String

test

点播空间名列表。多个空间名之间用英文逗号 , 隔开。

说明

如果是 POST 请求,此参数类型为 Array of String。

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

EndTime

String

2022-04-18T22:00:00Z

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

说明

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

TranscodeType

String

Normal

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

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

Specification

String

Audio

封装格式。取值如下:

  • 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

String

busy

任务类型。多个任务类型之间用英文逗号 , 隔开。取值如下:

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

说明

如果是 POST 请求,此参数类型为 Array of String。

Aggregation

Long

3600

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

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

DetailFieldList

String

TaskStage

详细字段列表,是否根据查询条件返回更详细的数据。多个字段之间用英文逗号 , 隔开。取值如下:

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

说明

如果是 POST 请求,此参数类型为 Array of String。

返回参数

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

参数类型示例值描述
SpaceListArray of String["test"]点播空间名列表。
StartTimeString2022-04-18T20:00:00Z查询起始时间。
EndTimeString2022-04-18T22:00:00Z查询结束时间。

TranscodeType

String

Normal

转码类型。取值如下:

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

Specification

String

Audio

封装格式。取值如下:

  • 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

任务类型。取值如下:

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

Aggregation

Long

3600

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

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

TotalTranscodeDataList

参数类型示例值描述

Name

String

Audio

封装格式。取值如下:

  • 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
ValueLong100转码时长。单位为毫秒。

TranscodeDataDetailList

参数类型示例值描述
SpaceStringtest点播空间名。

TaskStage

String

free

任务类型。取值如下:

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

TranscodeUsageList

参数类型示例值描述
TimeString2022-04-18T20:00:00ZRFC3339 格式的 UTC 时间,精度为 s,例如:2021-04-13T00:00:00+08:00
TranscodeItemListArray of TranscodeItemList-转码项目列表。

TranscodeItemList

参数类型示例值描述

Name

String

Audio

封装格式。取值如下:

  • 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
ValueLong100转码时长。单位为毫秒。

请求示例

https://vod.volcengineapi.com?Action=DescribeVodSpaceTranscodeData&Version=2023-07-01&Aggregation=3600&DetailFieldList=%5B%22TaskStage%22%5D&EndTime=2022-04-18T22%3A00%3A00Z&SpaceList=%5B%22test%22%5D&Specification=Audio&StartTime=2022-04-18T20%3A00%3A00Z&TaskStageList=%5B%22busy%22%2C%22free%22%5D&TranscodeType=

返回示例

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

{
    "ResponseMetadata": {
        "RequestId": "20221123122***0380DAD1333",
        "Action": "DescribeVodSpaceTranscodeData",
        "Version": "2023-07-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 各语言调用的示例代码,请参考如下: