查询某一段时间内截图内容。
接口说明
调用本接口仅支持查询一年内的截图数据。
QPS 限制
本接口的单用户 QPS 限制为 100 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
|
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
|
live:DescribeLiveStreamSnapshotInfo |
get |
*全部资源
|
无 | 无 |
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| DomainName |
string |
是 |
主播流域名。 |
example.com |
| AppName |
string |
是 |
播流所属应用名称。 |
liveApp**** |
| StreamName |
string |
是 |
播流名称。 |
liveStream**** |
| StartTime |
string |
是 |
开始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
2017-12-21T08:00:00Z |
| EndTime |
string |
是 |
结束时间。EndTime 和 StartTime 之间的间隔不能超过 1 天。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
2017-12-22T08:00:00Z |
| Limit |
integer |
否 |
一次调用获取的数量。取值范围:1~100, 默认值:10。 |
10 |
| Order |
string |
否 |
排序。取值:
|
asc |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
|||
| NextStartTime |
string |
下一个起始时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 说明
当此时间范围内的内容超出了 Limit 的取值范围,则返回此参数,为下一个文件的创建时间。可以将此时间当做 StartTime,重新调用此接口获取下一段内容,不传则表示未超出 Limit 取值范围。 |
2015-12-01T17:36:00Z |
| RequestId |
string |
请求 ID。 |
62136AE6-7793-45ED-B14A-60D19A9486D3 |
| LiveStreamSnapshotInfoList |
object |
||
| LiveStreamSnapshotInfo |
array<object> |
截图内容列表。 |
|
|
object |
|||
| OssObject |
string |
OSS 存储的文件名。 |
{liveApp****}/{liveStream****}.jpg |
| OssBucket |
string |
OSS 存储 Bucket 名称。 |
liveBucket**** |
| CreateTime |
string |
截图产生时间。格式为:yyyy-MM-ddTHH:mm:ssZ(UTC 时间)。 |
2015-12-01T17:36:00Z |
| OssEndpoint |
string |
OSS 存储的 Endpoint 名称。 |
cn-oss-****.aliyuncs.com |
| IsOverlay |
boolean |
截图方式。取值:
|
false |
| CreateTimestamp |
integer |
截图文件创建的毫秒级时间戳。 |
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 |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidStartTime.Malformed | Specified parameter StartTime is not valid. | |
| 400 | InvalidEndTime.Malformed | Specified parameter EndTime is not valid. | |
| 400 | InvalidEndTime.Mismatch | Specified end time does not math the specified start time. | 结束时间与开始时间不匹配,请您确认时间的匹配度。 |
| 400 | InvalidStream.NotFound | Speicified stream does not exist. |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。