最近更新时间:2023.12.01 19:22:40
首次发布时间:2023.09.25 14:35:35
支持查询用户直播转码时长数据。支持按照域名维度(含删除域名)查询,按天粒度聚合。
下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
Action | String | 是 | DescribeLiveTranscodeData | 接口名称。当前 API 的名称为 DescribeLiveTranscodeData 。 |
Version | String | 是 | 2023-01-01 | 接口版本。当前 API 的版本为 2023-01-01 。 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
DomainList | Array of String | 否 | ["example.com","example2.com"] | 域名列表,缺省情况表示该用户的所有域名。 |
StartTime | String | 是 | 2021-04-13T00:00:00+08:00 | 查询的起始时间,RFC3339 格式的 UTC 时间,精度为 s。 |
EndTime | String | 是 | 2021-04-14T00:00:00+08:00 | 查询的结束时间,RFC3339 格式的 UTC 时间,精度为 s。 |
Aggregation | Integer | 否 | 86400 | 时间粒度,单位为 s,当前仅支持天粒度,默认值为 86400。单次查询时间跨度为 93 天,历史查询时间范围为 366 天。 |
App | String | 否 | test_app | 应用名称。 |
Stream | String | 否 | test_stream | 流名称。 |
下表仅列出本接口特有的返回参数。更多信息请见返回结构。
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
DomainList | Array of String | ["example.com","example2.com"] | 域名列表。 |
StartTime | String | 2021-04-13T00:00:00+08:00 | 查询的起始时间,RFC3339 格式的 UTC 时间,精度为 s。 |
EndTime | String | 2021-04-14T00:00:00+08:00 | 查询的结束时间,RFC3339 格式的 UTC 时间,精度为 s。 |
Aggregation | Integer | 86400 | 时间粒度,单位为 s |
Duration | Float | 12.860403541550001 | 转码总时长,单位为分钟。 |
TranscodeDataList | Array of TranscodeDataList | - | 聚合转码数据。 |
App | String | test_app | 应用名称。 |
Stream | String | test_stream | 流名称。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
TranscodeType | String |
| 视频编码格式,支持的取值和含义如下所示。
|
Resolution | String |
| 分辨率。
|
TimeStamp | String | 2022-03-07T00:00:00+08:00 | 聚合时刻。 |
Duration | Float | 1.4475713543666666 | 当前时间片内的转码时长,单位为分钟。 |
POST https://live.volcengineapi.com?Action=DescribeLiveTranscodeData&Version=2023-01-01 { "DomainList": [ "example.com", "example2.com" ], "StartTime": "2021-04-13T00:00:00+08:00", "EndTime": "2021-04-14T00:00:00+08:00", "Aggregation": 86400 }
{ "ResponseMetadata": { "RequestId": "201806041104200100100232280022D30", "Action": "DescribeLiveTranscodeData", "Version": "2023-01-01", "Service": "live", "Region": "cn-north-1" }, "Result": { "DomainList": [ "example.com" ], "StartTime": "2021-04-13T00:00:00+08:00", "EndTime": "2021-04-14T00:00:00+08:00", "Aggregation": 86400, "Duration": 12.860403541550001, "TranscodeDataList": [ { "Duration": 1.4475713543666666, "Resolution": "720P", "TimeStamp": "2022-03-07T00:00:00+08:00", "TranscodeType": "Normal_H264" }, { "Duration": 11.412832187183334, "Resolution": "720P", "TimeStamp": "2022-03-08T00:00:00+08:00", "TranscodeType": "Normal_H264" } ] } }
下表仅列出本接口特有的错误码。更多信息请参见公共错误码获取详细信息。
状态码 | 错误码 | 错误信息 | 说明 |
---|---|---|---|
200 | CommonErr | - | 未分类错误。建议重试,如果仍返回该错误码,请联系技术支持。 |
400 | InvalidParam | - | 输入的参数无效或不符合要求,请参照请求参数说明进行检查。 |
400 | InvalidParam.BindError | Request parameter error, please check input data | 参数未通过校验,请检查参数类型是否正确。 |
403 | RequestForbidden | - | 请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。 |
403 | RequestForbidden.AccountIDNotAllow | this AccountID does not have permission to access the corresponding resource, please check the request parameters | 请求被拒绝,当前账号下无请求的资源(域名空间、域名、应用、配置模版、证书)。 |
403 | RequestForbidden.BillingStatus | Billing status is not available for the AccountID, please activate the service or recharge. | 未开通视频直播服务或账号欠费,造成账单不可用,请检查服务开通情况和账号欠费情况。 |
404 | ResourceNotFound | - | 未找到资源(域名空间、域名、应用、配置模版、证书)。建议重试,如果仍返回该错误码,请联系技术支持。 |
500 | InternalError | an internal error occurred, please contact the administrator. | 出现内部错误,请联系技术支持。 |
502 | InternalServiceError | an internal error occurred, please contact the administrator. | 服务间出现错误,请联系技术支持。 |
502 | InternalServiceError.BadResponse | an internal error occurred, please contact the administrator. | 服务间出现错误,请联系技术支持。 |
504 | InternalServiceTimeout | Internal Service is timeout. please contact the administrator. | 内部服务超时,请联系技术支持。 |