文档

DescribeAppRecordTemplates - 查询录制模版列表

更新时间:

应用录制模版列表

接口说明

QPS 限制

本接口的单用户 QPS 限制为 5 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
rtc:DescribeAppRecordTemplatesnone
  • App
    acs:rtc:*:{#accountId}:app/{#AppId}

请求参数

名称类型必填描述示例值
ClientTokenstring

幂等参数

123e4567-e89b-12d3-a456-42665544****
AppIdstring

应用 ID。通过控制台创建和查询,仅支持传单个 ID。

ac7N****
PageNuminteger

第几页,默认查询第 1 页。

1
PageSizeinteger

每页显示个数,默认为 10。

10
Conditionobject

查询条件。

TemplateIdstring

模版 ID。

ac7N****
Namestring

模版名称。

测试

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

2A7497D0-BEAE-58E7-B13A-751BD8EAE4C6
TotalNumlong

记录数。

10
TotalPagelong

分页数

1
Templatesarray<object>

模版列表

Templateobject
TemplateIdstring

模版 ID。

wv7N****
Namestring

模版名称。

测试
FilePrefixstring

录制文件命名规则。

说明 为确保录制的文件名称唯一,目前录制文件的命名规则为 record/{AppId}/{ChannelId}{TaskId}/{EscapedStartTime}{EscapedEndTime}。
record/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}
FileSplitIntervallong

录制文件切割时长(大于等于 1800)单位:秒。

1800
DelayStopTimelong

延时停止录制的时间单位:秒。

180
CreateTimebyte

创建时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。

2020-09-04T06:22:15Z
MediaEncodeinteger

编码选项。

1
LayoutIdsarray

布局 ID 列表。

Layoutlong

具体布局 ID。

22
Formatsarray

录制文件格式。当前文件格式仅支持:.m3u8、.mp4、.flv。

说明 文件格式仅支持小写。
Formatstring

具体格式。

mp4

示例

正常返回示例

JSON格式

{
  "RequestId": "2A7497D0-BEAE-58E7-B13A-751BD8EAE4C6",
  "TotalNum": 10,
  "TotalPage": 1,
  "Templates": [
    {
      "TemplateId": "wv7N****",
      "Name": "测试",
      "FilePrefix": "record/{AppId}/{ChannelId_TaskId}/{EscapedStartTime}_{EscapedEndTime}",
      "FileSplitInterval": 1800,
      "DelayStopTime": 180,
      "CreateTime": "2020-09-04T06:22:15Z",
      "MediaEncode": 1,
      "LayoutIds": [
        22
      ],
      "Formats": [
        "mp4"
      ]
    }
  ]
}

错误码

HTTP status code错误码错误信息描述
400ParameterError%s.参数错误
404NotFound%s.请求的资源不存在

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