最近更新时间:2024.04.01 18:01:10
首次发布时间:2023.10.16 10:38:47
此接口用于查询指定时间范围内转码功能的用量。
请求地址:https://vod.volcengineapi.com?Action=DescribeVodSpaceTranscodeData&Version=2023-07-01
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeVodSpaceTranscodeData | 接口名称。当前 API 的名称为 DescribeVodSpaceTranscodeData 。 |
Version | String | 是 | 2023-07-01 | 接口版本。当前 API 的版本为 2023-07-01 。 |
SpaceList | String | 否 |
| 点播空间名列表。多个空间名之间用英文逗号 说明 如果是 POST 请求,此参数类型为 Array of String。 |
StartTime | String | 是 |
| 查询的起始时间。日期格式要求符合 RFC3339 规范。 说明 开始时间最早不早于当前时间的 366 天。 |
EndTime | String | 是 |
| 查询的结束时间。日期格式要求符合 RFC3339 规范。 说明 单次查询的时间跨度不可超过 93 天。 |
TranscodeType | String | 否 |
| 转码类型。默认为全选。取值如下:
|
Specification | String | 否 |
| 封装格式。取值如下:
|
TaskStageList | String | 否 |
| 任务类型。多个任务类型之间用英文逗号
说明 如果是 POST 请求,此参数类型为 Array of String。 |
Aggregation | Long | 否 |
| 聚合的时间粒度。单位为秒。取值如下:
|
DetailFieldList | String | 否 |
| 详细字段列表,是否根据查询条件返回更详细的数据。多个字段之间用英文逗号 , 隔开。取值如下:
说明 如果是 POST 请求,此参数类型为 Array of String。 |
下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
SpaceList | Array of String | ["test"] | 点播空间名列表。 |
StartTime | String | 2022-04-18T20:00:00Z | 查询起始时间。 |
EndTime | String | 2022-04-18T22:00:00Z | 查询结束时间。 |
TranscodeType | String |
| 转码类型。取值如下:
|
Specification | String |
| 封装格式。取值如下:
|
TaskStageList | Array of String |
| 任务类型。取值如下:
|
Aggregation | Long |
| 聚合的时间粒度。单位为秒。取值如下:
|
TotalTranscodeData | Long | 100 | 所选时间段的转码总时长。单位为毫秒。 |
TotalTranscodeDataList | Array of TotalTranscodeDataList | - | 各种封装格式的转码时长。 |
TranscodeDataDetailList | Array of TranscodeDataDetailList | - | 各种任务类型的转码时长。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Name | String |
| 封装格式。取值如下:
|
Value | Long | 100 | 转码时长。单位为毫秒。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Space | String | test | 点播空间名。 |
TaskStage | String |
| 任务类型。取值如下:
|
Total | Long | 11 | 转码时长。单位为毫秒。 |
TranscodeUsageList | Array of TranscodeUsageList | - | 转码用量详细数据。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Time | String | 2022-04-18T20:00:00Z | RFC3339 格式的 UTC 时间,精度为 s,例如:2021-04-13T00:00:00+08:00 。 |
TranscodeItemList | Array of TranscodeItemList | - | 转码项目列表。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Name | String |
| 封装格式。取值如下:
|
Value | Long | 100 | 转码时长。单位为毫秒。 |
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 } ] } ] } ] } }
本接口无特有的错误码。更多信息请见公共错误码。
点播 OpenAPI 提供了配套的服务端 SDK,支持多种编程语言,帮助您实现快速开发。建议使用服务端 SDK 来调用 API。此 API 各语言调用的示例代码,请参考如下: