CreateClass

Last updated: 2021-09-24 11:45:05

    1. API Description

    Domain name for API request: vod.tencentcloudapi.com.

    • This API is used to categorize media assets for management;
    • It does not affect the categories of existing media assets. If you want to modify the category of a media asset, call the ModifyMediaInfo API.
    • There can be up to 4 levels of categories.
    • One category can have up to 500 subcategories under it.

    A maximum of 100 requests can be initiated per second for this API.

    We recommend you to use API Explorer
    Try it
    API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

    2. Input Parameters

    The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

    Parameter Name Required Type Description
    Action Yes String Common parameter. The value used for this API: CreateClass.
    Version Yes String Common parameter. The value used for this API: 2018-07-17.
    Region No String Common parameter. This parameter is not required for this API.
    ParentId Yes Integer Parent category ID. For a first-level category, enter -1.
    ClassName Yes String Category name. Length limit: 1-64 characters.
    SubAppId No Integer Subapplication ID in VOD. If you need to access a resource in a subapplication, enter the subapplication ID in this field; otherwise, leave it empty.

    3. Output Parameters

    Parameter Name Type Description
    ClassId Integer Category ID
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating a video category

    Input Example

    https://vod.tencentcloudapi.com/?Action=CreateClass
    &ParentId=-1
    &ClassName=First-level category 1
    &SubAppId=1
    &<Common request parameters>
    

    Output Example

    {
    "Response": {
      "ClassId": 1,
      "RequestId": "38bac707-7f64-42fa-9369-cdddcc36550d"
    }
    }
    

    5. Developer Resources

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    FailedOperation Operation failed.
    FailedOperation.ClassLevelLimitExceeded Operation failed: the number of category levels exceeds the limit.
    FailedOperation.ClassNameDuplicate Operation failed: the category name already exists.
    FailedOperation.InvalidVodUser The VOD service is not activated.
    FailedOperation.ParentIdNoFound Operation failed: the parent category ID does not exist.
    FailedOperation.SubclassLimitExceeded Operation failed: the number of subcategories exceeds the limit.
    InternalError Internal error.
    InvalidParameterValue.ClassName Incorrect parameter value: invalid ClassName
    InvalidParameterValue.ParentId Incorrect parameter value: invalid ParentId
    UnauthorizedOperation Unauthorized operation.