All Products
Search
Document Center

ApsaraVideo VOD:GetCategories

Last Updated:Mar 03, 2024

Queries the information about the specified category and its subcategories.

Debugging

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

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
vod:GetCategoriesList
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CateIdlongNo

The ID of the category. Default value: -1, which indicates the parent category ID of a level 1 category.

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 method for sorting 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. Valid values:

  • default (default): default category
  • material: material category
default

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

SubTotallong

The total number of subcategories.

3795
RequestIdstring

The ID of the request.

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

The information about the specified category.

Typestring

The type of the category. Valid values:

  • default (default): default category
  • material: material category
default
ParentIdlong

The ID of the parent category. The parent category ID of a level 1 category is -1.

100012****
CateNamestring

The name of the category.

  • The value can be up to 64 bytes in length.
  • The string must be encoded in the UTF-8 format.
film
CateIdlong

The ID of the video category.

100
Levellong

The level of the category. A value of 0 indicates a level 1 category.

0
SubCategoriesobject []

The list of subcategories.

Typestring

The type of the category. Valid values:

  • default (default): default category
  • material: material category
default
CateNamestring

The name of the category.

  • The value can be up to 64 bytes in length.
  • The string must be encoded in the UTF-8 format.
film
ParentIdlong

The ID of the parent category. The parent category ID of a level 1 category is -1.

10020****
CateIdlong

The ID of the video category.

100
SubTotallong

The total number of subcategories.

1
Levellong

The level of the category. A value of 0 indicates a level 1 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.