DeleteSnapshotFiles - 删除直播截图文件

删除指定截图文件。

接口说明

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

QPS 限制

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

调试

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

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
live:DeleteSnapshotFilesdelete
*Domain
acs:cdn:*:{#accountId}:domain/{#DomainName}

请求参数

名称类型必填描述示例值
CreateTimestampListarray

需要删除的截图产生的时间戳列表。

long

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

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

1653641526637
DomainNamestring

主播流域名。

example.com
AppNamestring

播流所属应用名称。

liveApp****
StreamNamestring

播流名称。

liveStream****
RemoveFileboolean

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

  • true:同步删除 OSS 文件。

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

说明 同步删除 OSS 文件需要具有 OSS 文件操作权限。
true

返回参数

名称类型描述示例值
object
FailureCountinteger

删除截图失败的数量。

1
RequestIdstring

请求 ID。

90F60327-ABEC-5A93-BF1F-****
SnapshotDeleteInfoListarray<object>

快照删除信息列表。

SnapshotDeleteInfoobject

快照删除信息列表。

CreateTimestamplong

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

1653641526637
Messagestring

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

  • OK:删除成功。

  • FileNotFound:未找到该截图文件。

OK
SuccessCountinteger

删除截图成功的数量。

1

示例

正常返回示例

JSON格式

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

错误码

HTTP status code错误码错误信息
400InvalidParams%s
400Cannot find task%s
400MissingParams%s
403OSSAccessDeniedOSS bucket not authorised
500InternalErrorServer internal error

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

变更历史

变更时间变更内容概要操作
暂无变更历史
HttpCode错误码错误信息描述
400InvalidParamsinvalid JSON无法解析请求。
400Cannot find taskStream not found请检查截图配置对应的 domain app stream 和推流情况。
400InvalidParamsInvalid request: missing缺失必要参数。
403OSSAccessDeniedOSS bucket not authorised文件对应的 OSS bucket 未向视频云账号授权。
500InternalErrorServer internal error请检查截图配置对应的 domain app stream 和推流情况。