Help Center/ Video On Demand/ API Reference/ Media Asset Storage Class Management/ Querying Cold Storage Settings of a Media Asset
Updated on 2026-02-27 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying Cold Storage Settings of a Media Asset

Function

This API is used to query the cold storage settings of a media asset.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    vod:storageModeType:get

    Read

    -

    -

    -

    -

URI

GET /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.

Response Parameters

Status code: 200

Table 3 Response body parameters

Parameter

Type

Description

storage_mode_type

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.

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 queries the cold storage scope of a media asset.

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

Example Responses

Status code: 200

Returned when the request succeeded.

{
  "storage_mode_type" : "ORIGIN"
}

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

200

Returned when the request succeeded.

400

Returned when the request failed.

Error Codes

See Error Codes.