DeleteSnapshotFiles - ApsaraVideo Live - Alibaba Cloud Documentation Center

Operation description

This operation deletes snapshot files generated within the last year.

QPS limit

The queries per second (QPS) limit for this operation is 30 for each user. If you exceed this limit, API calls are throttled, which may affect your business. Call this operation at a reasonable rate.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

live:DeleteSnapshotFiles

delete

*Domain

acs:cdn:*:{#accountId}:domain/{#DomainName}

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	No	The region ID.	cn-shanghai
CreateTimestampList	array	Yes	A list of timestamps of the snapshots to delete.	1653641526637
	integer	No	The timestamp, in milliseconds, when the snapshot to delete was generated. You can obtain this value from the CreateTimestamp parameter in the response of the DescribeLiveStreamSnapshotInfo operation.	1653641526637
DomainName	string	Yes	The streaming domain.	example.com
AppName	string	Yes	The application name.	liveApp****
StreamName	string	Yes	The stream name.	liveStream****
RemoveFile	boolean	Yes	Specifies whether to also delete the snapshot files from OSS. Valid values: true: Deletes the snapshot files from OSS. false: Does not delete the snapshot files from OSS. Note To delete files from OSS, you must have the required permissions for OSS file operations.	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	object
SnapshotDeleteInfo	array<object>	The list of snapshot deletion details.
	object	The list of snapshot deletion details.
CreateTimestamp	integer	The timestamp, in milliseconds, of the snapshot that you requested to delete.	1653641526637
Message	string	The result of the deletion operation for each snapshot. Valid values: OK: The snapshot was deleted. FileNotFound: The snapshot file was not found.	OK
SuccessCount	integer	The number of snapshots that were successfully deleted.	1

Examples

Success response

JSON format

{
  "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
500	InternalError	Server internal error
403	OSSAccessDenied	OSS bucket not authorised

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.