删除指定截图文件。
接口说明
调用本接口仅支持删除一年内的截图文件。
QPS 限制
本接口的单用户 QPS 限制为 30 次/秒。超过限制,API 调用会被限流,这可能会影响您的业务,请合理调用。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息
操作 |
访问级别 |
资源类型 |
条件关键字 |
关联操作 |
live:DeleteSnapshotFiles |
delete |
*Domain
|
无 | 无 |
请求参数
名称 |
类型 |
必填 |
描述 |
示例值 |
RegionId |
string |
否 |
||
CreateTimestampList |
array |
是 |
需要删除的截图产生的时间戳列表。 |
1653641526637 |
integer |
否 |
需要删除的截图产生的毫秒级时间戳。 通过调用 DescribeLiveStreamSnapshotInfo 接口返回的 CreateTimestamp 参数值即为该参数取值。 |
1653641526637 |
|
DomainName |
string |
是 |
主播流域名。 |
example.com |
AppName |
string |
是 |
播流所属应用名称。 |
liveApp**** |
StreamName |
string |
是 |
播流名称。 |
liveStream**** |
RemoveFile |
boolean |
是 |
是否同步删除 OSS 文件,取值:
说明
同步删除 OSS 文件需要具有 OSS 文件操作权限。 |
true |
返回参数
名称 |
类型 |
描述 |
示例值 |
object |
|||
FailureCount |
integer |
删除截图失败的数量。 |
1 |
RequestId |
string |
请求 ID。 |
90F60327-ABEC-5A93-BF1F-**** |
SnapshotDeleteInfoList |
object |
||
SnapshotDeleteInfo |
array |
快照删除信息列表。 |
|
object |
快照删除信息列表。 |
||
CreateTimestamp |
integer |
请求被删除的截图生成毫秒级时间戳。 |
1653641526637 |
Message |
string |
对每个截图的处理结果。取值:
|
OK |
SuccessCount |
integer |
删除截图成功的数量。 |
1 |
示例
正常返回示例
JSON
格式
{
"FailureCount": 1,
"RequestId": "90F60327-ABEC-5A93-BF1F-****",
"SnapshotDeleteInfoList": {
"SnapshotDeleteInfo": [
{
"CreateTimestamp": 1653641526637,
"Message": "OK"
}
]
},
"SuccessCount": 1
}
错误码
HTTP status code |
错误码 |
错误信息 |
描述 |
---|---|---|---|
400 | InvalidParams | %s | |
400 | Cannot find task | %s | |
400 | MissingParams | %s | |
500 | InternalError | Server internal error | |
403 | OSSAccessDenied | OSS bucket not authorised |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。