查询视频分类--视频点播-火山引擎

文档中心

立即注册

导航

查询视频分类

最近更新时间：2024.06.27 19:34:05首次发布时间：2022.03.15 11:15:05

此接口用于在指定空间下，根据分类 ID，查询视频分类。查询结果会以树状结构返回。

请求说明

请求地址：https://vod.volcengineapi.com?Action=ListVideoClassifications&Version=2021-01-01

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共请求参数。

参数	类型	是否必选	示例值	描述
Action	String	是	`ListVideoClassifications`	接口名称。当前 API 的名称为 `ListVideoClassifications`。
Version	String	是	`2021-01-01`	接口版本。当前 API 的版本为 `2021-01-01`。
SpaceName	String	是	`test`	点播空间名称。可通过以下方式获取空间名称：在视频点播控制台空间管理页面查看当前账号下所有空间的名称。调用 ListSpace 接口获取当前账号下所有空间的名称。
ClassificationId	Long	是	`0`	分类 ID。传 `0` 表述获取指定空间下全部分类。

返回参数

下表仅列出本接口特有的返回参数。更多信息请见公共返回参数。

参数	类型	示例值	描述
ClassificationTrees	Object[]	`-`	分类列表。
SpaceName	String	`test`	点播空间名称。
ClassificationId	Long	`1643`	分类 ID。
Level	Integer	`1`	分类级别： `1`：一级分类 `2`：二级分类 `3`：三级分类
Classification	String	`01`	分类名称。
ParentClassificationId	Long	`1345`	父分类 ID。
SubClassification	Object	`-`	子分类信息。
SubClassificationTrees	Object[]	`-`	子分类列表。
CreatedAt	String	`2022-02-18T15:08:07+08:00`	创建时间。

请求示例

https://vod.volcengineapi.com?Action=ListVideoClassifications&Version=2021-01-01&SpaceName=test&ClassificationId=0

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2023122210***3D4B0A84F46130B6",
        "Action": "ListVideoClassifications",
        "Version": "2021-01-01",
        "Service": "vod",
        "Region": "cn-north-1"
    },
    "Result": {
        "ClassificationTrees": [
            {
                "SpaceName": "test",
                "ClassificationId": "1702994923",
                "Level": 1,
                "Classification": "一级-新建分类",
                "ParentClassificationId": "0",
                "SubClassification": null,
                "SubClassificationTrees": [],
                "CreatedAt": "2023-12-22T10:29:57+08:00"
            }
        ]
    }
}

错误码

本接口无特有的错误码。更多信息请见公共错误码。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API，此 API 各语言调用的示例代码，请参考如下：