文档

查询边缘转码模板列表

调用ListEdgeTranscodeTemplate查询边缘转码模板列表。

使用说明

  • 本接口用于查询边缘转码模板列表。
  • 用户需要具有访问边缘转码服务的权限,才能正常调用本接口。

QPS限制

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

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String ListEdgeTranscodeTemplate

系统规定参数。取值:ListEdgeTranscodeTemplate

ClusterId String ******3b-4d18-395c-8106-ff21a6******

机房ID。

Type String nbhd-2

边缘转码类型,枚举:

  • common 通用(普通+窄带高清1.0)。
  • nbhd-2 窄带高清2.0。
  • ultra-hd 超高清。
说明 当该参数不填写时,系统会展示用户拥有的转码类型权限的转码模板。
VideoCodec String H.264

视频编码格式,枚举:

  • H.264。
  • H.265。
说明 当该参数不填写时,系统会展示用户拥有的视频编码格式权限的转码模板。
PageNo Integer 1

当前页码,默认值为1。

PageSize Integer 20

分页大小,每页显示条数。默认值为10,最大值为100。

SortBy String desc

排序规则,按模板创建时间(CreateTime)排序。默认是desc,枚举:

  • desc 降序排序。
  • asc 升序排序。
Keyword String baseline

搜索关键词,枚举:

  • 模板ID,模板ID支持精确匹配。
  • 模板名称,模板名称支持模糊搜索。

返回数据

名称

类型

示例值

描述

RequestId String ******3B-0E1A-586A-AC29-742247******

请求ID。

TemplateList Array of Template

边缘转码模板列表。

Template
Bitrate String 3000

码率配置,有固定码率,码率随源(ws)2种。

Codec String H.264

视频编码格式,枚举:

  • H.264。
  • H.265。
CreateTime String 2023-07-25T02:48:58Z

模板创建时间。

Fps String 30

帧率配置,有固定帧率,帧率随源(ws)2种。

Gop String 2s

关键帧配置,有按帧配置,按秒配置,关键帧随源(ws)3种。

Name String my_template

模版名称。

Resolution String 1920*1080

分辨率配置,有固定分辨率,分辨率随源(ws)2种。

说明 当使用固定分辨率时,width/height取值为-1/-2,则表示宽/高自适应。
TemplateId String 9b1571b513cb44f7a1ba6ae561ff46f7

模板ID。

Type String common

边缘转码类型。

TotalCount Integer 100

总数。

示例

请求示例

http(s)://[live.aliyuncs.com]/?Action=ListEdgeTranscodeTemplate
&ClusterId=******3b-4d18-395c-8106-ff21a6******
&Type=nbhd-2
&VideoCodec=H.264
&PageNo=1
&PageSize=20
&SortBy=desc
&Keyword=baseline
&公共请求参数

正常返回示例

XML格式

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

<ListEdgeTranscodeTemplateResponse>
    <RequestId>******3B-0E1A-586A-AC29-742247******</RequestId>
    <TemplateList>
        <Bitrate>3000</Bitrate>
        <Codec>H.264</Codec>
        <CreateTime>2023-07-25T02:48:58Z</CreateTime>
        <Fps>30</Fps>
        <Gop>2s</Gop>
        <Name>my_template</Name>
        <Resolution>1920*1080</Resolution>
        <TemplateId>9b1571b513cb44f7a1ba6ae561ff46f7</TemplateId>
        <Type>common</Type>
    </TemplateList>
    <TotalCount>100</TotalCount>
</ListEdgeTranscodeTemplateResponse>

JSON格式

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

{
  "RequestId" : "******3B-0E1A-586A-AC29-742247******",
  "TemplateList" : [ {
    "Bitrate" : "3000",
    "Codec" : "H.264",
    "CreateTime" : "2023-07-25T02:48:58Z",
    "Fps" : "30",
    "Gop" : "2s",
    "Name" : "my_template",
    "Resolution" : "1920*1080",
    "TemplateId" : "9b1571b513cb44f7a1ba6ae561ff46f7",
    "Type" : "common"
  } ],
  "TotalCount" : 100
}

错误码

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