视频截图--慢直播-火山引擎

文档中心

立即注册

导航

视频截图

最近更新时间：2023.07.21 14:23:53首次发布时间：2021.11.25 17:21:46

查询指定设备在云端保存的截图列表。

请求方式

使用 GET 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考「公共参数」。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	ListDeviceScreenshots
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
SpaceID	Query	String	是	空间 ID	可通过调用 ListSpaces 接口获取
StreamID	Query	String	是	视频流 ID	可通过调用 ListStreams 接口获取
StartTs	Query	String	是	查询的起始时间	例如：2023-07-06T17:49:30+08:00
EndTs	Query	String	是	查询的结束时间	例如：2023-07-08T17:49:30+08:00

返回结果

返回参数说明

通用返回参数，请参考 ResponseMetadata 结构体说明。

Result 字段包含以下参数：

字段	类型	说明
Type	String	查询对象的类型： screenshot：截图
Path	String	路径
Screenshot	Object	截图信息，参考以下 Screenshot 数据结构说明

字段

类型

说明

Type

String

查询对象的类型：

screenshot：截图

Path

String

路径

Screenshot

Object

截图信息，参考以下 Screenshot 数据结构说明

Screenshot 数据结构说明

字段	类型	说明
BornTs	String	图片生成时间

示例

请求示例

GET https://open.volcengineapi.com?Action=ListDeviceScreenshots
&Version=2021-01-01
&SpaceID=cd9fa8a7-12a2-405b-a5f1-faaddfxxxxxx
&StreamID=b7a20edd-8e60-4f46-b4a9-6ae079xxxxxx
&StartTs= 2023-07-06T17:49:30+08:00
&EndTs= 2023-07-08T16:20:00+08:00
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "20211208184347010212070103050017A3",
        "Action": "ListDeviceScreenshots",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": [
        {
            "Type": "screenshot",
            "Path": "https://xxx.xxx.com/api/top/aiotvideo/PlayStreamRes/2021-01-01/?PlayUrl=UmVzUGF0aD1MM0IxYzJndGNuUnRjQzB5TVRBd01EVXpNVFF6TFdKdllpMW5ZaTB4TURJMkxuQjFjMmd1WW1aalpHNWlaaTVqYjIwdk1qRXdNREExTXpFME15MWliMkl0WjJJdE1UQXlOaTh6TkRBeU1EQTRORGs1TVRNeU1EVTBOVEF6T1Y4ek5EQXlNREE0TkRrNU1UTXlNRFUwTlRBek9TOHlNREl4TVRJd09ERXdNamsxT0RBek5pNXFjR1ZuJlJlcVR5cGU9c2NyZWVuc2hvdCZSZXNPd25lcj1iN2EyMGVkZC04ZTYwLTRmNDYtYjRhOS02YWUwNzkxNzQyZmU=",
            "Screenshot": {
                "BornTs":"2023-07-07T13:58:32+08:00"
            }
        },
        {
            "Type": "screenshot",
            "Path": "https://xxx.xxx.com/api/top/aiotvideo/PlayStreamRes/2021-01-01/?PlayUrl=UmVzUGF0aD1MM0IxYzJndGNuUnRjQzB5TVRBd01EVXpNVFF6TFdKdllpMW5ZaTB4TURJMkxuQjFjMmd1WW1aalpHNWlaaTVqYjIwdk1qRXdNREExTXpFME15MWliMkl0WjJJdE1UQXlOaTh6TkRBeU1EQTRORGs1TVRNeU1EVTBOVEF6T1Y4ek5EQXlNREE0TkRrNU1UTXlNRFUwTlRBek9TOHlNREl4TVRJd09ERXdNamswTnprNE5DNXFjR1ZuJlJlcVR5cGU9c2NyZWVuc2hvdCZSZXNPd25lcj1iN2EyMGVkZC04ZTYwLTRmNDYtYjRhOS02YWUwNzkxNzQyZmU=",
            "Screenshot": {
                "BornTs":"2023-07-07T13:59:32+08:00"
            }
        },
        ...
        ...
    ]
}