All Products
Search
Document Center

ApsaraVideo VOD:GetCategories

更新時間:Jul 19, 2024

Queries the information about a specific category and its subcategories based on the ID or type of the category.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Authorization information

There is currently no authorization information disclosed in the API.

Request parameters

ParameterTypeRequiredDescriptionExample
CateIdlongNo

The ID of the category. If you specify this parameter, the system queries the category based on the ID. You can specify only one category ID. You can use one of the following methods to obtain the ID:

  • Log on to the ApsaraVideo VOD console. Choose Configuration Management > Media Management > Categories. On the Audio and Video / Image Category or Short Video Material Category tab, view the category ID.
  • Obtain the category ID from the response to the AddCategory operation.
49339****
PageNolongNo

The number of the page where the subcategories to be returned are listed. Default value: 1.

1
PageSizelongNo

The number of entries to return on each page of the subcategory list. Default value: 10. Maximum value: 100.

10
SortBystringNo

The sorting method of the results. Valid values:

  • CreationTime:Desc (default): The results are sorted in reverse chronological order based on the creation time.
  • CreationTime:Asc: The results are sorted in chronological order based on the creation time.
CreationTime:Desc
TypestringNo

The type of the category. If you specify this parameter, the system queries the category based on the type. Valid values:

  • default (default): audio, video, and image files
  • material: short video materials
default

Response parameters

ParameterTypeDescriptionExample
object

The response parameters.

SubTotallong

The total number of subcategories.

3795
RequestIdstring

The ID of the request.

25818875-5F78-4AF6-D7393642CA58****
Categoryobject

The information about the category.

Typestring

The type of the category. Valid values:

  • default: audio, video, and image files
  • material: short video materials
default
ParentIdlong

The ID of the parent category.

100012****
CateNamestring

The name of the category.

film
CateIdlong

The ID of the category.

100
Levellong

The level of the category. Valid values:

  • 0: level 1 category
  • 1: level 2 category
  • 2: level 3 category
0
SubCategoriesarray<object>

The details of the subcategory.

object

The list of subcategories.

Typestring

The type of the subcategory. Valid values:

  • default: audio, video, and image files
  • material: short video materials
default
CateNamestring

The name of the category.

film
ParentIdlong

The ID of the parent category.

10020****
CateIdlong

The ID of the category.

100
SubTotallong

The total number of subcategories.

1
Levellong

The level of the category. Valid values:

  • 0: level 1 category
  • 1: level 2 category
  • 2: level 3 category
1

Examples

Sample success responses

JSONformat

{
  "SubTotal": 3795,
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "Category": {
    "Type": "default",
    "ParentId": 0,
    "CateName": "film",
    "CateId": 100,
    "Level": 0
  },
  "SubCategories": {
    "Category": [
      {
        "Type": "default",
        "CateName": "film",
        "ParentId": 0,
        "CateId": 100,
        "SubTotal": 1,
        "Level": 1
      }
    ]
  }
}

Error codes

For a list of error codes, visit the Service error codes.

Common errors

The following table describes the common errors that this operation can return.

Error codeError messageHTTP status codeDescription
InvalidCateId.NotFoundThe CateId not exist.404The error message returned because the specified category ID does not exist.