文档

DescribeRecords - 查询录制记录列表

更新时间:

查询录制记录列表。

接口说明

说明 截图查询目前不支持分页,仅支持按迭代方式。使用返回结果里的 extStartTime 参数值,作为新请求的 StartTime 可请求下一页。

调试

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

授权信息

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

请求参数

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

按存储记录类型查询。取值范围:

  • record(录制)
  • snapshot(截图)
record
StreamIdstring

按流 ID 查询。

323*****997-cn-qingdao
StartTimestring

按开始时间查询。

2021-11-22T00:00:00Z
EndTimestring

按结束时间查询。

2021-11-24T00:00:00Z
PrivateBucketboolean

是否使用私有 Bucket。

true
SortBystring

按给定字段排序,取值范围:

  • Id(默认)
Id
SortDirectionstring

排序方式。取值范围:

  • asc(升序)(默认)
  • desc(降序)
asc
PageSizelong

分页大小,默认值:20。

20
PageNumlong

第几个分页,默认值:1。

1

返回参数

名称类型描述示例值
object
PageNumlong

第几个分页。

说明 仅限录制查询。
1
RequestIdstring

请求 ID。

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

查询下个记录的开始时间。

说明 仅限截图查询。
2018-12-10T11:00:00Z
PageSizelong

分页大小。

说明 仅限录制查询。
20
TotalCountlong

存储记录总数。

说明 仅限录制查询。
100
PageCountlong

分页总数。

说明 仅限录制查询。
5
Recordsobject []

存储记录列表。

Typestring

存储记录类型。取值范围:

  • record(录制)
  • snapshot(截图)
record
Heightlong

高度。

1080
Urlstring

存储文件的 URL。

http://my_oss_bucket.oss-cn-qingdao.aliyuncs.com/record/live/310*****007/2021-11-23-18-19-38_2021-11-23-18-33-48.m3u8
OssBucketstring

存储文件的 Bucket。

my_oss_bucket
FileFormatstring

存储文件格式。取值范围:

  • mp4
  • flv
  • hls
  • jpg
hls
StreamIdstring

流 ID。

323*****997-cn-qingdao
OssObjectstring

存储文件的 Object。

record/live/310*****007/2021-11-23-18-19-38_2021-11-23-18-33-48.m3u8
EndTimestring

存储记录结束时间。

2021-11-23T18:33:48
StartTimestring

存储记录开始时间。

2021-11-23T18:19:32
Widthlong

宽度。

1920
TemplateIdstring

模板 ID。

388*****204-cn-qingdao
Idstring

存储记录 ID。

说明 仅限录制查询。
2be2a673-6033-4874-b6f2-f2bc0a1*****
OssEndpointstring

OSS 接入点。

oss-cn-qingdao.aliyuncs.com

示例

正常返回示例

JSON格式

{
  "PageNum": 1,
  "RequestId": "BEA5625F-8FCF-48F4-851B-CA63946DA664",
  "NextStartTime": "2018-12-10T11:00:00Z",
  "PageSize": 20,
  "TotalCount": 100,
  "PageCount": 5,
  "Records": [
    {
      "Type": "record",
      "Height": 1080,
      "Url": "http://my_oss_bucket.oss-cn-qingdao.aliyuncs.com/record/live/310*****007/2021-11-23-18-19-38_2021-11-23-18-33-48.m3u8",
      "OssBucket": "my_oss_bucket",
      "FileFormat": "hls",
      "StreamId": "323*****997-cn-qingdao",
      "OssObject": "record/live/310*****007/2021-11-23-18-19-38_2021-11-23-18-33-48.m3u8",
      "EndTime": "2021-11-23T18:33:48",
      "StartTime": "2021-11-23T18:19:32",
      "Width": 1920,
      "TemplateId": "388*****204-cn-qingdao",
      "Id": "2be2a673-6033-4874-b6f2-f2bc0a1*****",
      "OssEndpoint": "oss-cn-qingdao.aliyuncs.com"
    }
  ]
}

错误码

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

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