Help Center/ Video On Demand/ API Reference/ Media Asset Storage Class Management/ Modifying the Cold Storage Scope of a Media Asset
Updated on 2025-11-26 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Modifying the Cold Storage Scope of a Media Asset

Function

This API is used to modify the cold storage scope of a media asset.

By default, cold storage applies to the source and output media files. You can also apply cold storage only to the source media file.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

URI

PUT /v1/{project_id}/asset/storage-mode-type

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token. This parameter is mandatory when token authentication is used.

It can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when a request is sent. This parameter is mandatory for AK/SK authentication.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

storage_mode_type

No

String

Cold storage mode.

The options include:

  • WHOLE: Cold storage applies to both the source and transcoded media files.

  • ORIGIN: Cold storage applies only to the source media file.

Response Parameters

Status code: 204

Returned when the request succeeded.

Status code: 400

Table 4 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

This example modifies the cold storage scope of a media asset.

PUT https://{endpoint}/v1/{project_id}/asset/storage-mode-type

Content-Type: application/json
{
  "storage_mode_type": "ORIGIN"
}

Example Responses

Status code: 400

Returned when the request failed.

{
  "error_code" : "VOD.10053",
  "error_msg" : "The request parameter is illegal, illegal field: {xx}."
}

Status Codes

Status Code

Description

204

Returned when the request succeeded.

400

Returned when the request failed.

Error Codes

See Error Codes.