Help Center/ Video On Demand/ API Reference/ Historical APIs/ Media Asset Categorization/ Querying a Media Asset Category
Updated on 2026-01-19 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Querying a Media Asset Category

Function

This API is used to query a specified category and its subcategories.

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

GET /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.
Table 2 Query Parameters

Parameter

Mandatory

Type

Description

id

Yes

Integer

Video category ID.

Setting this parameter to 0 or null will query all level-1 categories under the project ID.

Request Parameters

Table 3 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 4 Response body parameters

Parameter

Type

Description

[items]

Array of QueryCategoryRsp objects

Returned category information
Table 5 QueryCategoryRsp

Parameter

Type

Description

id

String

Category ID.

name

String

Category name.

children

Array of QueryCategoryRsp objects

Subcategory list.

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

error_msg

String

Error description.

Example Requests

This example queries a media asset category.

GET https://{endpoint}/v1.0/{project_id}/asset/category?id={id}

Example Responses

Status code: 200

Returned when the request succeeded.

[ {
  "id" : "334",
  "name" : "Movie",
  "children" : [ {
    "id" : "335",
    "name" : "TV",
    "children" : [ ]
  } ]
} ]

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.