Help Center/ Video On Demand/ API Reference/ Media Asset Categorization/ Querying a Media Asset Category
Updated on 2026-02-27 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.

  • 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:category:list

    List

    -

    -

    -

    -

URI

GET /v2/{project_id}/asset/categories

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

Array of integers

Video category ID. A maximum of 10 category IDs can be queried at a time. If the value is 0, all level-1 categories are queried.

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 QueryCategoryInfoRsp objects

Returned category information.
Table 5 QueryCategoryInfoRsp

Parameter

Type

Description

id

Integer

ID of the category to be queried. The value -1 indicates other categories.

name

String

Name of the category to be queried.

sub_categories

Array of CategoryInfo objects

Sub-category information.
Table 6 CategoryInfo

Parameter

Type

Description

id

Integer

ID of the category to be queried.

name

String

Name of the category to be queried.

Status code: 400

Table 7 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}/v2/{project_id}/asset/categories

Example Responses

Status code: 200

Returned when the request succeeded.

[ {
  "id" : 0,
  "name" : "",
  "sub_categories" : [ {
    "id" : 123,
    "name" : ""
  }, {
    "id" : 124,
    "name" : ""
  } ]
}, {
  "id" : 1,
  "name" : "",
  "sub_categories" : [ {
    "id" : 234,
    "name" : ""
  }, {
    "id" : 235,
    "name" : ""
  } ]
} ]

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.