全部产品
Search

搜索本产品

    视频直播：DescribeLiveStreamSnapshotInfo - 查询一段时间内截图内容

    文档中心

    视频直播：DescribeLiveStreamSnapshotInfo - 查询一段时间内截图内容

    更新时间：Dec 05, 2024

    查询某一段时间内截图内容。

    接口说明

    调用本接口仅支持查询一年内的截图数据。

    QPS 限制

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

    调试

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

    授权信息

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

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

    请求参数

    名称类型必填描述示例值
    DomainNamestring是

    主播流域名。

    		example.com
    AppNamestring是

    播流所属应用名称。

    		liveApp****
    StreamNamestring是

    播流名称。

    		liveStream****
    StartTimestring是

    开始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

    		2017-12-21T08:00:00Z
    EndTimestring是

    结束时间。EndTime 和 StartTime 之间的间隔不能超过 1 天。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

    		2017-12-22T08:00:00Z
    Limitinteger否

    一次调用获取的数量。取值范围：1~100， 默认值：10。

    		10
    Orderstring否

    排序。取值：

    • asc（默认值）：升序。
    • desc：降序。
    		asc

    返回参数

    名称类型描述示例值
    object
    NextStartTimestring

    下一个起始时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

    说明 当此时间范围内的内容超出了 Limit 的取值范围，则返回此参数，为下一个文件的创建时间。可以将此时间当做 StartTime，重新调用此接口获取下一段内容，不传则表示未超出 Limit 取值范围。
    		2015-12-01T17:36:00Z
    RequestIdstring

    请求 ID。

    		62136AE6-7793-45ED-B14A-60D19A9486D3
    LiveStreamSnapshotInfoListarray<object>

    截图内容列表。

    LiveStreamSnapshotInfoobject
    OssObjectstring

    OSS 存储的文件名。

    		{liveApp****}/{liveStream****}.jpg
    OssBucketstring

    OSS 存储 Bucket 名称。

    		liveBucket****
    CreateTimestring

    截图产生时间。格式为：yyyy-MM-ddTHH:mm:ssZ（UTC 时间）。

    		2015-12-01T17:36:00Z
    OssEndpointstring

    OSS 存储的 Endpoint 名称。

    		cn-oss-****.aliyuncs.com
    IsOverlayboolean

    截图方式。取值：

    • true：覆盖截图。

    • false：序列截图。

    		false
    CreateTimestamplong

    截图文件创建的毫秒级时间戳。

    		1653641526637

    示例

    正常返回示例

    JSON格式

    {
  "NextStartTime": "2015-12-01T17:36:00Z",
  "RequestId": "62136AE6-7793-45ED-B14A-60D19A9486D3",
  "LiveStreamSnapshotInfoList": {
    "LiveStreamSnapshotInfo": [
      {
        "OssObject": "{liveApp****}/{liveStream****}.jpg",
        "OssBucket": "liveBucket****",
        "CreateTime": "2015-12-01T17:36:00Z",
        "OssEndpoint": "cn-oss-****.aliyuncs.com",
        "IsOverlay": false,
        "CreateTimestamp": 1653641526637
      }
    ]
  }
}

    错误码

    HTTP status code错误码错误信息描述
    400InvalidStartTime.MalformedSpecified parameter StartTime is not valid.StartTime参数错误，请您确认该StartTime参数是否正确。
    400InvalidEndTime.MalformedSpecified parameter EndTime is not valid.结束时间错误，请您确认结束时间是否正确。
    400InvalidEndTime.MismatchSpecified end time does not math the specified start time.结束时间与开始时间不匹配，请您确认时间的匹配度。
    400InvalidStream.NotFoundSpeicified stream does not exist.直播流不存在，请您确认直播流是否正确。

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