Restore Archive and Cold Archive media assets by using RestoreMedia - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Operation description

Make sure that you are familiar with the billing methods and pricing of ApsaraVideo VOD before you call this operation. Restoring media assets incurs storage fees. For more information, see Media asset storage billing.
This operation applies only to Archive and Cold Archive audio and video files. After a file is restored, it can be accessed. The storage class of an audio or video file that is being restored cannot be changed. Restoration generates retrieval traffic. After a Cold Archive audio or video file is restored, a Standard storage copy of the file is generated for access. The file copy incurs Standard storage fees until the restoration period ends.

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

vod:RestoreMedia

update

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
MediaIds	string	Yes	The media IDs, which are audio or video IDs (VideoId). Separate multiple IDs with commas (,). A maximum of 20 IDs are supported. You can obtain the IDs by using the following methods: For audio or video files uploaded in the console, log on to the ApsaraVideo VOD console and choose Media Files > Audio/Video to view the audio or video ID. When you call the CreateUploadVideo operation to obtain the upload URL and credential, the video ID is the value of the VideoId parameter in the response. After the audio or video file is uploaded, you can call the SearchMedia operation to query the video ID, which is the value of the VideoId parameter in the response.	8bc8e94fe4e55abde85718**,eb186180e989dd56**
Scope	string	No	The scope of the change. If this parameter is not specified, the default value All is used. Valid values: All (default): Applies tiered storage to all resources (source files and transcoded streams) of the media asset. SourceFile: Applies tiered storage only to the video source file of the media asset ID. Resources other than the source file use Standard storage.	All
RestoreDays	string	No	The restoration duration. Default value: 1 day. Maximum value for Archive media assets: 7 days. Maximum value for Cold Archive media assets: 365 days.	2
RestoreTier	string	No	The restoration priority. This parameter is required only for Cold Archive media assets. If this parameter is not specified, the default value Standard is used. Valid values: Expedited: High priority. The restoration is completed within 1 hour. Standard (default): Standard priority. The restoration is completed within 2 to 5 hours. Bulk: Batch priority. The restoration is completed within 5 to 12 hours.	Standard

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	8E70E3F8-E2EE-47BC-4677-379D6F28****
Success	boolean	Indicates whether the operation was successful.	true
IgnoredList	object
MediaId	array	The list of media asset IDs that failed to be retrieved.
	string	The media asset ID that failed to be retrieved.	['7f29b8d0c5fa71ed9685e6f7d559****']
ForbiddenList	object
MediaForbiddenReasonDTO	array<object>	The list of media asset IDs that failed to be processed.
	object	The information about the media asset that failed to be processed.
MediaId	string	The ID of the media asset.	fa10ee70898671edb99f6eb3690d****
Reason	string	The reason for the failure.	Forbidden.RestoreMedia

Examples

Success response

JSON format

{
  "RequestId": "8E70E3F8-E2EE-47BC-4677-379D6F28****",
  "Success": true,
  "IgnoredList": {
    "MediaId": [
      "['7f29b8d0c5fa71ed9685e6f7d559****']"
    ]
  },
  "ForbiddenList": {
    "MediaForbiddenReasonDTO": [
      {
        "MediaId": "fa10ee70898671edb99f6eb3690d****",
        "Reason": "Forbidden.RestoreMedia"
      }
    ]
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.