All Products
Search
Document Center

Intelligent Media Services:DeleteLiveSnapshotFiles

Last Updated:Dec 16, 2024

Deletes live stream snapshot files. You can choose to delete only the snapshot files or delete both the snapshot files and the original Object Storage Service (OSS) files.

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.

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.
OperationAccess levelResource typeCondition keyAssociated operation
ice:DeleteLiveSnapshotFiles
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
JobIdstringYes

The ID of the snapshot job.

****a046-263c-3560-978a-fb287782****
CreateTimestampListarrayYes

The list of timestamps when the jobs were created. The values are UNIX timestamps representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC. A maximum of 200 jobs can be deleted at a time.

longYes
1660638613798
DeleteOriginalFilebooleanNo

Specifies whether to delete the original files at the same time. Default value: false.

true

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

RequestIdstring

The request ID.

****2876-6263-4B75-8F2C-CD0F7FCF****
DeleteFileResultListarray<object>

The list of deleted files.

DeleteFileResultListobject
Resultstring

The result of deletion. A value of OK indicates that the file is deleted. Other values indicate that the file failed to be deleted.

Valid values:

  • OK: The file was deleted.
  • NotFound: The file was not found.
OK
CreateTimestamplong

The time when the file was created. This value is a UNIX timestamp representing the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1660638613798

Examples

Sample success responses

JSONformat

{
  "RequestId": "****2876-6263-4B75-8F2C-CD0F7FCF****",
  "DeleteFileResultList": [
    {
      "Result": "OK",
      "CreateTimestamp": 1660638613798
    }
  ]
}

Error codes

HTTP status codeError codeError message
400MissingParameter%s
400InvalidParameter%s
400OverlayNotSupportedNot Sopport to remove overlay snapshot, please remove overlay snapshot from OSS console.
403UserDisableUser is disable.
403BucketNotAuthorizedBucket is not authorised.
403ForbiddenUser not authorized to operate on the specified resource.
403OperationDeniedYour account has not enabled the ICE service.
404JobNotFoundNo such job.
404NoValidSnapshotNo snapshots found with given parameters.
500InternalErrorThe request processing has failed due to some unknown error.

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

Change history

Change timeSummary of changesOperation
2024-02-02The Error code has changedView Change Details