更新时间:2022-04-11 GMT+08:00
分享

查询转码用量接口

功能介绍

查询直播域名每小时的转码时长数据。

最大查询跨度31天,最大查询周期90天。

接口约束

该接口暂只支持查询部署在新版视频直播服务上的域名的相关数据(不包含“华北-北京一”)。此约束条件仅适用于中国站。

调试

您可以在API Explorer中调试该接口。

URI

GET /v2/{project_id}/stats/transcode

表1 路径参数

参数

是否必选

参数类型

描述

project_id

String

项目ID,获取方法请参考获取项目ID

表2 Query参数

参数

是否必选

参数类型

描述

publish_domain

String

推流域名。

stream

String

流名。

start_time

String

起始时间。日期格式按照ISO8601表示法,并使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。

非整点时间按小时取整,若start_time为2020-08-18T07:20:40Z,则实际查询起始时间为2020-08-18T07:00:00Z。

若start_time为空,则默认查询最近24小时数据。

end_time

String

结束时间。日期格式按照ISO8601表示法,并使用UTC时间。格式为:YYYY-MM-DDThh:mm:ssZ。

非整点时间按小时取整,若end_time为2020-08-18T08:20:40Z,则实际查询起始时间为2020-08-18T08:00:00Z。

若参数为空,默认为当前时间。结束时间需大于起始时间。

请求参数

表3 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

String

用户Token。使用Token鉴权方式时必选。 通过调用IAM服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。

Authorization

String

使用AK/SK方式认证时必选,携带的鉴权信息。

X-Sdk-Date

String

使用AK/SK方式认证时必选,请求的发生时间。

X-Project-Id

String

使用AK/SK方式认证时必选,携带项目ID信息, 与路径参数中的项目ID相同。

响应参数

状态码: 200

表4 响应Header参数

参数

参数类型

描述

X-request-id

String

请求的唯一标识。

表5 响应Body参数

参数

参数类型

描述

transcode_data_list

Array of TranscodeData objects

采样数据列表。

summary_list

Array of TranscodeSummary objects

指定时间区间内各转码规格转码时长总和。

表6 TranscodeData

参数

参数类型

描述

spec_list

Array of TranscodeSpec objects

每个采样时间中的转码时长信息。

time

String

采样时间。日期格式按照ISO8601表示法,并使用UTC时间。 格式为:YYYY-MM-DDThh:mm:ssZ 。

表7 TranscodeSpec

参数

参数类型

描述

type

String

转码规格,格式是“编码格式_分辨率档位”(未开启高清低码)和“编码格式_PVC_分辨率档位”(开启高清低码)。

其中编码格式包括H264、H265,分辨率档位包括:

4K(3840 x 2160)及以下,2K(2560 x 1440)及以下,FHD(1920 x 1080)及以下,HD(1280 x 720)及以下,SD(640 x 480)及以下。

value

Double

采样时间点转码时长,单位为分钟,保留两位小数。

表8 TranscodeSummary

参数

参数类型

描述

type

String

转码规格,格式是“编码格式_分辨率档位”(未开启高清低码)和“编码格式_PVC_分辨率档位”(开启高清低码)。

其中编码格式包括H264、H265,分辨率档位包括:

4K(3840 x 2160)及以下,2K(2560 x 1440)及以下,FHD(1920 x 1080)及以下,HD(1280 x 720)及以下,SD(640 x 480)及以下。

value

Double

总转码时长,单位为分钟,保留两位小数。

状态码: 400

表9 响应Header参数

参数

参数类型

描述

X-request-id

String

请求的唯一标识。

表10 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误描述。

请求示例

GET /v2/{project_id}/stats/transcode?publish_domain=test.huawei.com&start_time=2020-08-18T07:00:00Z&end_time=2020-08-18T08:00:00Z

响应示例

状态码: 200

处理成功返回。

{
  "transcode_data_list" : [ {
    "time" : "2020-08-18T07:00:00Z",
    "spec_list" : [ {
      "type" : "H265_PVC_SD",
      "value" : 256.23
    }, {
      "type" : "H265_PVC_HD",
      "value" : 128.41
    } ]
  }, {
    "time" : "2020-08-18T08:00:00Z",
    "spec_list" : [ {
      "type" : "H265_PVC_SD",
      "value" : 52.35
    }, {
      "type" : "H265_PVC_HD",
      "value" : 136.32
    } ]
  } ],
  "summary_list" : [ {
    "type" : "H265_PVC_SD",
    "value" : 308.58
  }, {
    "type" : "H265_PVC_HD",
    "value" : 264.73
  } ]
}

状态码: 400

参数错误。

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Invalid request parameter: publish_domain"
}

状态码

状态码

描述

200

处理成功返回。

400

参数错误。

错误码

请参见错误码

分享:

    相关文档

    相关产品

关闭导读