刪除直播截圖文件
調(diào)用DeleteSnapshotFiles刪除指定截圖文件。
使用說明
調(diào)用本接口僅支持刪除一年內(nèi)的截圖文件。
QPS限制
本接口的單用戶QPS限制為30次/秒。超過限制,API調(diào)用會被限流,這可能會影響您的業(yè)務,請合理調(diào)用。更多信息,請參見QPS限制。
調(diào)試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
請求參數(shù)
名稱 |
類型 |
是否必選 |
示例值 |
描述 |
Action | String | 是 | DeleteSnapshotFiles | 系統(tǒng)規(guī)定參數(shù)。取值:DeleteSnapshotFiles。 |
CreateTimestampList.N | Long | 否 | 1653641526637 | 需要刪除的截圖產(chǎn)生的毫秒級時間戳。 通過調(diào)用DescribeLiveStreamSnapshotInfo接口返回的CreateTimestamp參數(shù)值即為該參數(shù)取值。 |
DomainName | String | 是 | example.com | 主播流域名。 |
AppName | String | 是 | liveApp**** | 播流所屬應用名稱。 |
StreamName | String | 是 | liveStream**** | 播流名稱。 |
RemoveFile | Boolean | 是 | true | 是否同步刪除OSS文件,取值:
|
返回數(shù)據(jù)
名稱 |
類型 |
示例值 |
描述 |
FailureCount | Integer | 1 | 刪除截圖失敗的數(shù)量。 |
RequestId | String | 90F60327-ABEC-5A93-BF1F-**** | 請求ID。 |
SnapshotDeleteInfoList | Array of SnapshotDeleteInfo | 快照刪除信息列表。 |
|
SnapshotDeleteInfo | |||
CreateTimestamp | Long | 1653641526637 | 請求被刪除的截圖生成毫秒級時間戳。 |
Message | String | OK | 對每個截圖的處理結(jié)果。取值:
|
SuccessCount | Integer | 1 | 刪除截圖成功的數(shù)量。 |
示例
請求示例
http(s)://live.aliyuncs.com/?Action=DeleteSnapshotFiles
&AppName=liveApp****
&CreateTimestampList.1=1653641526637
&DomainName=example.com
&RemoveFile=true
&StreamName=liveStream****
&<公共請求參數(shù)>
正常返回示例
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 |
缺失必要參數(shù)。 |
403 |
OSSAccessDenied |
OSS bucket not authorised |
文件對應的OSS bucket未向視頻云賬號授權(quán)。 |
500 |
InternalError |
Server internal error |
請檢查截圖配置對應的domain app stream和推流情況。 |