DeleteSnapshotFiles - ApsaraVideo Live - Alibaba Cloud Documentation Center

Deletes snapshot files.

Operation description

You can delete only snapshots that were captured in the last year.

QPS limit

You can call this operation up to 30 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
live:DeleteSnapshotFiles	delete	Domain `acs:cdn::{#accountId}:domain/{#DomainName}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
CreateTimestampList	array	Yes	A list of timestamps indicating the screenshots to be deleted.
	long	Yes	The timestamp when the snapshot that you want to delete was captured. Unit: milliseconds. You can obtain the timestamp of a snapshot from the CreateTimestamp parameter in the response of the DescribeLiveStreamSnapshotInfo operation.	1653641526637
DomainName	string	Yes	The main streaming domain.	example.com
AppName	string	Yes	The name of the application to which the live stream belongs.	liveApp****
StreamName	string	Yes	The name of the live stream.	liveStream****
RemoveFile	boolean	Yes	Specifies whether to also delete the corresponding file in Object Storage Service (OSS) at the same time. Value values: true: deletes the corresponding file in OSS. false: does not delete the corresponding file in OSS. Note To delete the corresponding file in OSS, you must have the permissions on the OSS bucket.	true

Response parameters

Parameter	Type	Description	Example
	object
FailureCount	integer	The number of snapshots that failed to be deleted.	1
RequestId	string	The request ID.	90F60327-ABEC-5A93-BF1F-****
SnapshotDeleteInfoList	array<object>	The information about the snapshots.
SnapshotDeleteInfo	object	The information about the snapshot.
CreateTimestamp	long	The timestamp when the snapshot was captured. Unit: milliseconds.	1653641526637
Message	string	The processing result of the snapshot. Valid values: OK: The snapshot was deleted. FileNotFound: The snapshot was not found.	OK
SuccessCount	integer	The number of successful screenshot deletions.	1

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status code	Error code	Error message
400	InvalidParams	%s
400	Cannot find task	%s
400	MissingParams	%s
403	OSSAccessDenied	OSS bucket not authorised
500	InternalError	Server internal error

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history

HttpCode	Error code	Error message	Description
400	InvalidParams	invalid JSON	The request failed to be parsed.
400	Cannot find task	Stream not found	The stream was not found. Check the snapshot settings such as the domain name and application name and the stream ingest status.
400	InvalidParams	Invalid request: missing	The required parameters are missing.
403	OSSAccessDenied	OSS bucket not authorised	You do not have the permissions on the OSS bucket where the snapshot files are stored.
500	InternalError	Server internal error	An internal error occurred. Check the snapshot settings such as the domain name and application name and the stream ingest status.