获取视频库分类信息（包含子分类）--企业直播-火山引擎

文档中心

立即注册

导航

企业直播

获取视频库分类信息（包含子分类）

最近更新时间：2024.06.25 12:10:43首次发布时间：2024.04.28 14:37:34

您可通过此接口获取主账号下默认分类或指定分类及其子分类的信息。

注意事项

请求频率：单用户请求频率限制为 1 次/秒。

请求说明

请求方式：GET
请求地址：https://livesaas.volcengineapi.com/?Action=GetVideoLibraryFolderTree&Version=2023-08-01

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`GetVideoLibraryFolderTree`	接口名称。当前 API 的名称为 `GetVideoLibraryFolderTree`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
FolderId	Long	否	`0`	分类 ID。默认取值为 `0`，表示查询默认分类下的所有子分类。

返回参数

参数	类型	示例值	描述
FolderNode	Object of FolderNode	`-`	分类信息。

FolderNode

参数	类型	示例值	描述
FolderId	Long	`0`	分类 ID。
FolderName	String	`默认分类`	分类名称。
Children	Array of FolderNode	`-`	子分类信息。

请求示例

GET https://livesaas.volcengineapi.com/?Action=GetVideoLibraryFolderTree&Version=2023-08-01&FolderId=0

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202404151254007138CAB922F9EC1CBF91",
        "Action": "GetVideoLibraryFolderTree",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1713156841
    },
    "Result": {
        "FolderNode": {
            "FolderId": 0,
            "FolderName": "默认分类",
            "Children": [
                {
                    "FolderId": 17959466895819,
                    "FolderName": "子分类名称1",
                    "Children": [
                        {
                            "FolderId": 17959465298105,
                            "FolderName": "子分类名称2",
                            "Children": []
                        }
                    ]
                }
            ]
        }
    }
}

错误码

访问公共错误码和错误码获取详细信息。