DescribeAllClass

Last updated: 2020-08-14 09:41:34

1. API Description

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

  • This API is used to get the information of all categories.

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: DescribeAllClass.
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.
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
ClassInfoSet Array of MediaClassInfo Category information set
Note: this field may return null, indicating that no valid values can be obtained.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting video category hierarchy

Input Example

https://vod.tencentcloudapi.com/?Action=DescribeAllClass
&<Common request parameters>

Output Example

{
  "Response": {
    "ClassInfoSet": [
      {
        "ClassId": 0,
        "Level": 0,
        "ClassName": "Other",
        "ParentId": -1,
        "SubClassIdSet": null
      },
      {
        "ClassId": 1,
        "Level": 0,
        "ClassName": "Custom first-level category",
        "ParentId": -1,
        "SubClassIdSet": [
          2,
          3
        ]
      },
      {
        "ClassId": 2,
        "Level": 2,
        "ClassName": "Custom second-level category",
        "ParentId": 1,
        "SubClassIdSet": [
          4,
          5
        ]
      },
      {
        "ClassId": 3,
        "Level": 2,
        "ClassName": "Custom second-level category",
        "ParentId": 1,
        "SubClassIdSet": null
      },
      {
        "ClassId": 4,
        "Level": 3,
        "ClassName": "Custom third-level category",
        "ParentId": 2,
        "SubClassIdSet": null
      },
      {
        "ClassId": 5,
        "Level": 3,
        "ClassName": "Custom third-level category",
        "ParentId": 2,
        "SubClassIdSet": null
      }
    ],
    "RequestId": "requestId"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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.InvalidVodUser The VOD service is not activated.
InternalError Internal error.
UnauthorizedOperation Unauthorized operation.

Was this page helpful?

Was this page helpful?

  • Not at all
  • Not very helpful
  • Somewhat helpful
  • Very helpful
  • Extremely helpful
Send Feedback
Help