Query category and subcategory information using GetCategories - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Invokes this operation to perform a filtered query for specified categorization information by ID or type, and retrieves the list of its subcategories (next-level categories).

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

vod:GetCategories

list

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CateId	integer	No	The category ID. If you specify this parameter, the information about the specified category is returned. Only a single category ID is supported. You can obtain the category ID by using the following methods: Log on to the ApsaraVideo VOD console and choose Configuration Management > Media Asset Management Configuration > Category Management to view the category ID. Obtain the category ID from the response of the AddCategory operation when you create a category.	49339****
PageNo	integer	No	The page number of the subcategory list. Default value: 1.	1
PageSize	integer	No	The number of entries per page of the subcategory list. Default value: 10. Maximum value: 100.	10
SortBy	string	No	The method for sorting the query results. Valid values: CreationTime:Desc (default): sorts the results by creation time in descending order. CreationTime:Asc: sorts the results by creation time in ascending order.	CreationTime:Desc
Type	string	No	The categorization type. If you specify this parameter, a filtered query is performed to return categories of the specified type. Valid values: default: audio, video, and image categorization. material: short video material categorization.	default

Response elements

Element	Type	Description	Example
	object	The response parameters.
SubTotal	integer	The total number of subcategories.	2
RequestId	string	The request ID.	25818875-5F78-4AF6-D7393642CA58****
Category	object	The details of the category.
Type	string	The category type. Valid values: default: audio, video, and image category. material: short video material category.	default
ParentId	integer	The ID of the parent category.	100012****
CateName	string	The category name.	Movie
CateId	integer	The category ID.	100
Level	integer	The category level. Valid values: 0: level-1 category. 1: level-2 category. 2: level-3 category.	0
SubCategories	object
Category	array<object>	The details of the subcategory.
	object
Type	string	The type of the subcategory. Valid values: default: audio, video, and image files material: short video materials	default
CateName	string	The name of the category.	电影
ParentId	integer	The ID of the parent category.	10020****
CateId	integer	The ID of the category.	100
SubTotal	integer	The total number of subcategories.	1
Level	integer	The level of the category. Valid values: 0: level 1 category 1: level 2 category 2: level 3 category	1

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.