文档

删除直播截图文件

调用DeleteSnapshotFiles删除指定截图文件。

使用说明

调用本接口仅支持删除一年内的截图文件。

QPS限制

本接口的单用户QPS限制为30次/秒。超过限制,API调用会被限流,这可能会影响您的业务,请合理调用。更多信息,请参见QPS限制

调试

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

请求参数

名称

类型

是否必选

示例值

描述

Action String DeleteSnapshotFiles

系统规定参数。取值:DeleteSnapshotFiles

CreateTimestampList.N Long 1653641526637

需要删除的截图产生的毫秒级时间戳。

通过调用DescribeLiveStreamSnapshotInfo接口返回的CreateTimestamp参数值即为该参数取值。

DomainName String example.com

主播流域名。

AppName String liveApp****

播流所属应用名称。

StreamName String liveStream****

播流名称。

RemoveFile Boolean true

是否同步删除OSS文件,取值:

  • true:同步删除OSS文件。
  • false:不同步删除OSS文件。

返回数据

名称

类型

示例值

描述

FailureCount Integer 1

删除截图失败的数量。

RequestId String 90F60327-ABEC-5A93-BF1F-****

请求ID。

SnapshotDeleteInfoList Array of SnapshotDeleteInfo

快照删除信息列表。

SnapshotDeleteInfo
CreateTimestamp Long 1653641526637

请求被删除的截图生成毫秒级时间戳。

Message String OK

对每个截图的处理结果。取值:

  • OK:删除成功。
  • FileNotFound:未找到该截图文件。
SuccessCount Integer 1

删除截图成功的数量。

示例

请求示例

http(s)://live.aliyuncs.com/?Action=DeleteSnapshotFiles
&AppName=liveApp****
&CreateTimestampList.1=1653641526637
&DomainName=example.com
&RemoveFile=true
&StreamName=liveStream****
&<公共请求参数>

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<DeleteSnapshotFilesResponse>
<FailureCount>1</FailureCount>
<SnapshotDeleteInfoList>
    <SnapshotDeleteInfo>
        <Message>OK</Message>
        <CreateTimestamp>1653641526637</CreateTimestamp>
    </SnapshotDeleteInfo>
    <SnapshotDeleteInfo>
        <Message>Not Found</Message>
        <CreateTimestamp>1656936778524</CreateTimestamp>
    </SnapshotDeleteInfo>
</SnapshotDeleteInfoList>
<RequestId>90F60327-ABEC-5A93-BF1F-****</RequestId>
<SuccessCount>1</SuccessCount>
</DeleteSnapshotFilesResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "FailureCount" : 1,
  "SnapshotDeleteInfoList" : {
    "SnapshotDeleteInfo" : [ {
      "Message" : "OK",
      "CreateTimestamp" : 1653641526637
    }, {
      "Message" : "Not Found",
      "CreateTimestamp" : 1656936778524
    } ]
  },
  "RequestId" : "90F60327-ABEC-5A93-BF1F-****",
  "SuccessCount" : 1
}

错误码

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

HttpCode

错误码

错误信息

描述

400

InvalidParams

invalid JSON

无法解析请求。

400

Cannot find task

Stream not found

请检查截图配置对应的domain app stream和推流情况。

400

InvalidParams

Invalid request: missing

缺失必要参数。

403

OSSAccessDenied

OSS bucket not authorised

文件对应的OSS bucket未向视频云账号授权。

500

InternalError

Server internal error

请检查截图配置对应的domain app stream和推流情况。