AI 助理
备案控制台
文档
输入文档关键字查找
首页

按流粒度查询视频流的转码用量

更新时间：
产品详情
我的收藏

调用DescribeLiveStreamTranscodeMetricData按流粒度查询视频流的转码用量。

使用说明

  • 最大查询跨度：24小时。
  • 最小查询粒度：5分钟。
  • 最大查询范围：最近31天的数据。

QPS限制

本接口的单用户QPS限制为10次/秒。超过限制，API调用会被限流，这可能会影响您的业务，请合理调用。更多信息，请参见QPS限制。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称

类型

是否必选

示例值

描述
Action String 是 DescribeLiveStreamTranscodeMetricData

系统规定参数。取值：DescribeLiveStreamTranscodeMetricData。
DomainName String 是 example.com

域名名称。仅支持单个域名查询。
StartTime String 是 2023-06-11T02:46:40Z

开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
EndTime String 是 2023-06-11T03:46:40Z

结束时间。需晚于开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
AppName String 否 app

应用名称。
StreamName String 否 stream

流的名称。
NextPageToken String 否 UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=

分页查询token，每次查询最多返回5000行数据，当要查询的数据超过5000行时，响应数据会提供下次查询数据的起始索引。

请求时传入该token，将从上一次查询结束的下一行继续查询未获取的数据。

返回数据

名称

类型

示例值

描述
EndTime String 2023-06-11T02:46:40Z

结束时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
StartTime String 2023-06-11T03:46:40Z

起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC时间）。
RequestId String 16A96B9A-F203-4EC5-8E43-CB92E68F4CD8

请求ID。
NextPageToken String UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=

分页查询token，每次查询最多返回5000行数据，当要查询的数据超过5000行时，响应数据会提供下次查询数据的起始索引。

请求时传入该token，将从上一次查询结束的下一行继续查询未获取的数据。
PageSize Integer 5000

返回数据行数。
DomainName String example.com

域名名称。
StreamDetailData Array of StreamData

返回数据组。
StreamData
AppName String app

应用名称。
StreamName String stream

流名称。
Region String cn-shanghai

地区。
Duration Long 300

时长。单位：秒。
Fps String high

帧率。
TimeStamp String 2023-06-11T02:45:00Z

时间片起始时刻。
TranscodeType String H264STD

转码类型。取值：

  • H264STD：H.264普通转码。
  • H264NBHD：H.264窄带高清转码。
  • H265STD：H.265普通转码。
  • AUDIO：音频转码。
Resolution String 4K

分辨率。取值：

  • 2K：2K。
  • 4K：4K。
  • LD：流畅。
  • SD：标清。
  • HD：高清。
  • def：音频。

示例

请求示例

http(s)://live.aliyuncs.com?Action=DescribeLiveStreamTranscodeMetricData
&DomainName=example.com
&StartTime=2023-06-11T02:46:40Z
&EndTime=2023-06-11T03:46:40Z
&AppName=app
&StreamName=stream
&NextPageToken=UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DescribeLiveStreamTranscodeMetricDataResponse>
    <EndTime>2023-06-11T02:46:40Z</EndTime>
    <StartTime>2023-06-11T03:46:40Z
</StartTime>
    <RequestId>16A96B9A-F203-4EC5-8E43-CB92E68F4CD8</RequestId>
    <NextPageToken>UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=</NextPageToken>
    <PageSize>5000</PageSize>
    <DomainName>example.com</DomainName>
    <StreamDetailData>
        <AppName>app</AppName>
        <StreamName>stream</StreamName>
        <Region>cn-shanghai</Region>
        <Duration>300</Duration>
        <Fps>high</Fps>
        <TimeStamp>2023-06-11T02:45:00Z</TimeStamp>
        <TranscodeType>H264STD</TranscodeType>
        <Resolution>4K</Resolution>
    </StreamDetailData>
</DescribeLiveStreamTranscodeMetricDataResponse>

JSON格式

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

{
  "EndTime" : "2023-06-11T02:46:40Z",
  "StartTime" : "2023-06-11T03:46:40Z\n",
  "RequestId" : "16A96B9A-F203-4EC5-8E43-CB92E68F4CD8",
  "NextPageToken" : "UjsM9x3aVcJi9a0-ArwJUTTC67C***37C0=",
  "PageSize" : 5000,
  "DomainName" : "example.com",
  "StreamDetailData" : [ {
    "AppName" : "app",
    "StreamName" : "stream",
    "Region" : "cn-shanghai",
    "Duration" : 300,
    "Fps" : "high",
    "TimeStamp" : "2023-06-11T02:45:00Z",
    "TranscodeType" : "H264STD",
    "Resolution" : "4K"
  } ]
}

错误码

HttpCode

错误码

错误信息

描述
400 InvalidStartTime.Malformed Specified StartTime is malformed. StartTime参数错误，请您确认该StartTime参数是否正确。
400 InvalidEndTime.Malformed Specified EndTime is malformed. 结束时间错误，请您确认结束时间是否正确。
400 InvalidEndTime.Mismatch Specified end time does not math the specified start time. 结束时间与开始时间不匹配，请您确认时间的匹配度。
400 InvalidTimeSpan The time span exceeds the limit. 时间跨度超过限制，请参照接口文档，配置合理查询跨度。
400 InvalidPageToken The token of page is invalid. 指定的分页token错误，请传入上次查询返回的正确索引，并确认没有修改您的请求参数。
400 InvalidAppName.Mismatch The AppName param must be passed. AppName参数不匹配，请确认传入了正确的AppName参数。
400 InvalidStreamProtocol.NotSupport The specified stream protocol is not support. 指定的流协议不支持，请参照文档查询所需的流协议。
400 InvalidStreamName.LengthTooLong The specified stream name is too long. StreamName的长度超过限制，请传入合法的StreamName。
400 InvalidAppName.LengthTooLong The specified app name is too long. AppName的长度超过限制，请传入合法的AppName。
400 InvalidTime.ValueNotSupported Specified Time is malformed. 开始时间和结束时间不匹配。

访问错误中心查看更多错误码。

文档推荐