文档

DescribeTemplate - 查询模板

更新时间:

查询模板信息。

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

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

模板 ID。

323*****998-cn-qingdao

返回参数

名称类型描述示例值
object
Typestring

模板类型。取值:

  • record(录制)
  • snapshot(截图)
  • transcode(转码)
  • timeshift(时移)
record
Triggerstring

模板触发类型。取值:

  • auto(自动)
  • ondemand(按需)
说明 仅限录制模板。
auto
HlsTsstring

HLS 的存储路径,ts 文件。

说明 仅限录制模板。
osspath/record/{StreamName}/{UnixTimestamp}_{Sequence}
Mp4string

MP4 的存储路径。

说明 仅限录制模板。
osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}
JpgOverwritestring

JPG 的存储路径,用于覆盖截图。

说明 仅限截图模板。
osspath/snapshot/{AppName}/{StreamName}.jpg
Callbackstring

模板执行后的回调。

http://example.com/callback
RequestIdstring

请求 ID。

BEA5625F-8FCF-48F4-851B-CA63946DA664
Descriptionstring

模板描述。

录制模板
Regionstring

OSS 所属区域,即服务中心。

cn-qingdao
Retentionlong

时移保存周期,单位:天

说明 仅限时移模板。
3
HlsM3u8string

HLS 的存储路径,m3u8 文件。

说明 仅限录制模板。
osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}
Namestring

模板名称。

录制模板
Flvstring

FLV 的存储路径。

说明 仅限录制模板。
osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}
CreatedTimestring

模板创建时间。

2020-12-10T10:00:00Z
OssEndpointstring

OSS 的域名。

oss-cn-qingdao.aliyuncs.com
OssFilePrefixstring

OSS 文件前缀

oss-prefix
JpgOnDemandstring

JPG 的存储路径,用于按需截图。

说明 仅限截图模板。
osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg
OssBucketstring

OSS 的 Bucket。

my_oss_bucket
FileFormatstring

存储文件格式,多值用逗号分隔。取值:mp4,flv,hls,jpg

hls
JpgSequencestring

JPG 的存储路径,用于序列截图。

说明 仅限截图模板。
osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg
Intervallong

操作周期,单位:秒。

3600
Idstring

模板 ID。

323*****998-cn-qingdao
TransConfigsobject []

转码配置列表。

说明 仅限转码模板。
Goplong

视频 Gop,单位:帧

50
Widthlong

视频宽度

1280
VideoBitratelong

视频比特率,单位:kbps

800
Heightlong

视频高度

720
VideoCodecstring

视频编码

h264
Fpslong

视频帧率,单位:fps

25
Namestring

转码规则名称,转码规则名称将作为转码流后缀,建议按使用习惯设置为 sd,200k 等易辨识后缀,只支持数字和字母

sd
Idstring

转码配置 ID。

399*****430-cn-qingdao

示例

正常返回示例

JSON格式

{
  "Type": "record",
  "Trigger": "auto",
  "HlsTs": "osspath/record/{StreamName}/{UnixTimestamp}_{Sequence}",
  "Mp4": "osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}",
  "JpgOverwrite": "osspath/snapshot/{AppName}/{StreamName}.jpg",
  "Callback": "http://example.com/callback",
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "Description": "录制模板",
  "Region": "cn-qingdao",
  "Retention": 3,
  "HlsM3u8": "osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}",
  "Name": "录制模板",
  "Flv": "osspath/record/{StreamName}/{EscapedStartTime}_{EscapedEndTime}",
  "CreatedTime": "2020-12-10T10:00:00Z",
  "OssEndpoint": "oss-cn-qingdao.aliyuncs.com",
  "OssFilePrefix": "oss-prefix",
  "JpgOnDemand": "osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}_ondemand.jpg",
  "OssBucket": "my_oss_bucket",
  "FileFormat": "hls",
  "JpgSequence": "osspath/snapshot/{AppName}/{StreamName}/{UnixTimestamp}.jpg",
  "Interval": 3600,
  "Id": "323*****998-cn-qingdao",
  "TransConfigs": [
    {
      "Gop": 50,
      "Width": 1280,
      "VideoBitrate": 800,
      "Height": 720,
      "VideoCodec": "h264",
      "Fps": 25,
      "Name": "sd",
      "Id": "399*****430-cn-qingdao"
    }
  ]
}

错误码

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

  • 本页导读 (0)
文档反馈