Help Center/ Video On Demand/ API Reference/ Media file category/ Queries a specified category
Updated on 2024-12-04 GMT+08:00
Online Debugging
CLI Examples
View PDF
Share

Queries a specified category

Function

Queries a specified category and its subcategories

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.

If the value is set to 0 or null, 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 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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

[items]

Array<Array<QueryCategoryRsp>>

The information is returned when the request succeeds.
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

Queries a specified category.

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

Example Responses

Status code: 200

The information is returned when the request succeeds.

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

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.

Parent topic: Media file category