You need to enable JavaScript to run this app.
导航
查询截图历史详情
最近更新时间:2023.10.12 17:39:58首次发布时间:2022.04.19 20:40:35

调用接口查询指定 Vhost 下的直播截图历史详情。

说明

该接口属于历史版本 API,我们计划于 2023 年 12 月 25 日停止对其进行维护,并于 2024 年 3 月 25 日下线文档,建议您使用新版查询截图历史详情接口。

注意事项

请求频率:单用户请求频率限制为 10 次/秒

请求说明

  • 请求方式:POST
  • 请求地址:https://live.volcengineapi.com?Action=DescribeCDNSnapshotHistory&Version=2020-08-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数

Query

参数类型是否必选示例值描述
ActionStringDescribeCDNSnapshotHistory接口名称。当前 API 的名称为 DescribeCDNSnapshotHistory
VersionString2020-08-01接口版本。当前 API 的版本为 2020-08-01

Body

参数类型是否必选示例值描述
VhostStringpush.example.com域名空间名称。由 1 到 60 位数字、字母、下划线及"-"和"."组成
AppStringlive应用名称,由 1 到 30 位数字、字母、下划线及"-"和"."组成
StreamStringstream-123流名称,由 1 到 100 位数字、字母、下划线及"-"和"."组成,如果指定 Stream,必须同时指定 App 的值
DateFromString2022-04-01T00:00:00+08:00查询时间范围的开始时间
DateToString2022-04-02T00:00:00+08:00查询时间范围的结束时间
PageNumInteger1分页查询页码
PageSizeInteger30单个分页中,查询的结果数量

Type

String

tos

截图文件保存位置。默认取值为 tos。

  • tos
  • imageX

返回参数

下表仅列出本接口特有的返回参数。更多信息请见返回结构

参数类型示例值描述
DataArray of CDNSnapshotHistory-截图历史列表记录
PaginationObject of Pagination-分页信息

CDNSnapshotHistory

参数类型示例值描述
VhostStringpush.example.com域名空间名称
AppStringlive应用名称
StreamStringstream-123流名称
PathString20210830135051697.jpeg截图文件保存的路径
FileSizeFloat0文件大小
TimeStampString2021-08-30 21:48:25.000截图时间戳
WidthInteger720视频宽度
HeightInteger1280视频高度

Pagination

参数类型示例值描述
PageCurInteger1当前页
PageSizeInteger20当前页的大小
PageTotalInteger231当前页的数据量
TotalCountInteger4613数据总量

示例

请求示例

POST https://live.volcengineapi.com?Action=DescribeCDNSnapshotHistory&Version=2020-08-01
{
  "Vhost": "push.example.com",
  "App": "live",
  "Stream": "stream-123"
}

返回示例

{
    "ResponseMetadata":{
        "RequestId":"201806041104200100100232280022D30",
        "Action":"DescribeCDNSnapshotHistory",
        "Version":"2020-08-01",
        "Service":"live",
        "Region":"cn-north-1"
    }
    "Result":{
        "Data":[
            {
                "App": "live",
                "FileSize": 0,
                "Height": 1280,
                "Path": "20210830135051697.jpeg",
                "Stream": "testStream413",
                "TimeStamp": "2021-08-30 21:48:25.000",
                "Vhost": "example.org",
                "Width": 720
            }
        ]
        "Pagination":{
            "PageCur":1,
            "PageSize":20,
            "PageTotal":231,
            "TotalCount":4613
        }
    }
}

错误码

访问公共错误码获取详细信息。