All Products
Search
Document Center

ApsaraVideo VOD:AddCategory

Last Updated:Mar 03, 2024

Creates a video category.

Operation description

A maximum of three category levels can be created. Each category can contain up to 100 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:AddCategoryWrite
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
CateNamestringYes

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.
test
ParentIdlongNo

The ID of the parent category. If you do not set this parameter, a level 1 category is generated by default. The parent category ID of a level 1 category is -1.

Note Level 1 material categories are built in the system and cannot be changed. If you set the Type parameter to material, you must set the ParentId parameter.
100012****
TypestringNo

The type of the category. Valid values:

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

Response parameters

ParameterTypeDescriptionExample
object

The returned data.

RequestIdstring

The ID of the request.

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

The information about the video 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.
test
CateIdlong

The ID of the video category.

10020
Levellong

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