Create a category to classify media assets by using AddCategory - ApsaraVideo VOD - Alibaba Cloud - ApsaraVideo VOD

Operation description

Audio/video/image categories (Type set to default) support up to three levels, with a maximum of 100 subcategories per level. Short video material categories (Type set to material) support up to two levels, with a maximum of 100 subcategories per level.
After creating a category, you can assign it to media assets during upload or to already uploaded media assets. For more information, see Media asset 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:AddCategory

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
CateName	string	Yes	The category name. Maximum length: 64 bytes. UTF-8 encoded.	Comedy
ParentId	integer	No	The parent category ID. Log on to the ApsaraVideo VOD console and choose Configuration Management > Media Management Configuration > Category Management > Audio/Video/Image Categories or Short Video Material Categories to view category IDs. Note If you specify this parameter, a subcategory is created under the specified parent category. If you do not specify this parameter, a level-0 category is created. Because all level-0 categories for short video materials are built-in and cannot be modified, added, or deleted, only subcategories can be created under level-0 categories. Therefore, this parameter is required when `Type` is set to `material`.	100012****
Type	string	No	The category type. Valid values: default (default): audio/video/image category. material: short video material category.	default

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	25818875-5F78-4AF6-D7393642CA58****
Category	object	The media asset category information.
Type	string	The category type. Valid values: default: audio/video/image category. material: short video material category.	default
ParentId	integer	The parent category ID.	100012
CateName	string	The category name.	Comedy
CateId	integer	The category ID. This ID can be used as a request parameter for the UpdateCategory, DeleteCategory, and GetCategories operations.	10020
Level	integer	The category level. Valid values: 0: level-0 category. 1: level-1 category. 2: level-2 category.	1

Examples

Success response

JSON format

{
  "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
  "Category": {
    "Type": "default",
    "ParentId": 100012,
    "CateName": "Comedy",
    "CateId": 10020,
    "Level": 1
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.