Help Center> Video On Demand> API Reference> Media file category> Creates a media asset category
Updated on 2022-10-24 GMT+08:00

Creates a media asset category

Function

Creates a media asset category

Constraints

You can create up to three categories, each of which supports 128 subcategories.

URI

POST /v1.0/{project_id}/asset/category

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 a token.

Authorization

No

String

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

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

name

Yes

String

Media asset category name, which contains a maximum of 64 characters

parent_id

No

Integer

Parent category ID

If this parameter is not specified, a level-1 category is generated by default.

The category ID of the root node is 0.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

name

String

Media asset category name

parent_id

Integer

Parent category ID The parent ID of the level-1 category is 0.

id

Integer

Media asset category ID

level

Integer

Media file category level

Possible values are:

  • 1: level-1 category

  • 2: level-2 category

  • 3: level-3 category

projectId

String

Project ID

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

POST https://{endpoint}/v1.0/{project_id}/asset/category

{
  "name" : "Movie"
}

Example Responses

Status code: 200

The information is returned when the request succeeds.

{
  "id" : 334,
  "name" : "Movie",
  "parent_id" : 0,
  "level" : 1,
  "projectId" : "58411d8df9064*****75d75b54e01358"
}

Status code: 400

The information is returned when the request fails.

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

Status Codes

Status Code

Description

200

The information is returned when the request succeeds.

400

The information is returned when the request fails.

Error Codes

See Error Codes.