All Products
Search
Document Center

ApsaraVideo VOD:AddCategory

Last Updated:Dec 06, 2024

Creates a video category. You can call this operation to categorize media assets including audio or video files, images, and short video materials in ApsaraVideo VOD. This simplifies the query and management of media assets.

Operation description

  • You can create a maximum of 3 levels of categories for audio, video, and image files and 2 levels of categories for short video materials. Each category level can contain a maximum of 100 subcategories. To create categories for audio and video files, set Type to default. To create categories for short video materials, set Type to material.
  • After you create a category, you can categorize media resources during upload or categorize the uploaded media resources. For more information, see Manage video categories.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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:AddCategory
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CateNamestringYes

The name of the category.

  • The value can be up to 64 bytes in length.
  • The value must be encoded in UTF-8.
test
ParentIdlongNo

The ID of the parent category.

To obtain the category ID, perform the following steps: 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.

Note
  • If you specify this parameter, the system creates a subcategory under the parent category. If you leave this parameter empty, the system creates a level 1 category.
  • You cannot modify, add, or delete level 1 categories of short video materials. You can create only subcategories under level 1 categories for short video materials. This parameter is required when you set Type to material.
  • 100012****
    TypestringNo

    The type of the category. Valid values:

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

    Response parameters

    ParameterTypeDescriptionExample
    object

    The response parameters.

    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.

    test
    CateIdlong

    The ID of the category. You can use the value of this parameter when you call the UpdateCategory , DeleteCategory , and GetCategories operations.

    10020
    Levellong

    The level of the category. Valid values:

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

    Examples

    Sample success responses

    JSONformat

    {
      "RequestId": "25818875-5F78-4AF6-D7393642CA58****",
      "Category": {
        "Type": "default",
        "ParentId": 100012,
        "CateName": "test",
        "CateId": 10020,
        "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
    LevelExceededMaxThe level of categories exceeded maximum.400The error message returned because the number of category levels exceeds the upper limit.
    SubTotalExceededMaxThe total of sub categories exceeded maximum.400The error message returned because the number of subcategories exceeds the upper limit.
    InvalidCateId.NotFoundThe CateId not exist.404The error message returned because the specified ID of the parent category does not exist.