查询转码用量--视频点播-火山引擎

文档中心

立即注册

导航

查询转码用量

最近更新时间：2024.11.06 17:54:55首次发布时间：2023.10.16 10:38:47

此接口用于在指定空间维度下，查询一定时间范围内转码功能的用量。

注意事项

计费说明：转码计费价格请参见按量计费。
数据延迟：2 小时。
时间范围：查询的时间跨度不超过 93 天。
权限说明：当使用子账号请求接口时，接口会按照子账号进行权限校验，只返回该子账号有权限的数据。详见给子账号添加项目权限说明。

请求说明

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

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必选	示例值	描述
Action	String	是	`DescribeVodSpaceTranscodeData`	接口名称。当前 API 的名称为 `DescribeVodSpaceTranscodeData`。
Version	String	是	`2023-07-01`	接口版本。当前 API 的版本为 `2023-07-01`。
SpaceList	String	否	`test`	点播空间名列表。多个空间名之间用英文逗号 `,` 隔开。说明如果是 POST 请求，此参数类型为 Array of String。
StartTime	String	是	`2022-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。
RegionList	String	否	`cn-north-1`	区域列表。默认全选，多个用英文逗号 `,` 连接。取值如下： `cn-north-1`：华北 `ap-southeast-1`：亚太东南（柔佛）说明如果是 POST 请求类型为 Array of String 。视频点播亚太东南（柔佛）地域邀测中，仅针对企业用户开放。如您有相关需求，请联系您的商务经理申请开通。

返回参数

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

参数	类型	示例值	描述
SpaceList	String[]	`["test"]`	点播空间名列表。
StartTime	String	`2022-04-18T20:00:00Z`	查询起始时间。
EndTime	String	`2022-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	String[]	`busy`	任务类型。取值如下： `busy`：正常任务。 `free`：闲时任务。
Aggregation	Long	`3600`	聚合的时间粒度。单位为秒。取值如下： `3600`：1 小时 `86400`：1 天
TotalTranscodeData	Long	`100`	所选时间段的转码总时长。单位为毫秒。
TotalTranscodeDataList	Object[]	`-`	各种封装格式的转码时长。
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`
Value	Long	`100`	转码时长。单位为毫秒。
TranscodeDataDetailList	Object[]	`-`	各种任务类型的转码时长。
Space	String	`test`	点播空间名。
TaskStage	String	`free`	任务类型。取值如下： `busy`：正常任务。 `free`：闲时任务。
Total	Long	`11`	转码时长。单位为毫秒。
TranscodeUsageList	Object[]	`-`	转码用量详细数据。
Time	String	`2022-04-18T20:00:00Z`	RFC3339 格式的 UTC 时间，精度为 s，例如：`2021-04-13T00:00:00+08:00`。
TranscodeItemList	Object[]	`-`	转码项目列表。
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`
Value	Long	`100`	转码时长。单位为毫秒。
RegionList	String[]		地区列表
DetailFieldList	String[]		展示详细信息的维度，取值：TaskStage、Space

请求示例

https://vod.volcengineapi.com?Action=DescribeVodSpaceTranscodeData&Version=2023-07-01&Aggregation=3600&DetailFieldList=TaskStage&EndTime=2022-04-18T22:00:00Z&SpaceList=test&Specification=Audio&StartTime=2022-04-18T20:00:00Z&TaskStageList=busy,free&TranscodeType=Normal&RegionList=cn-north-1

返回示例

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",
        "Aggredation": 3600,
        "Specification": "Audio",
        "TranscodeType": "Normal",
        "TaskStageList": ["busy", "free"],
        "DetailFieldList": ["TaskStage"],
        "RegionList": ["cn-north-1"],
        "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 各语言调用的示例代码，请参考如下：