You need to enable JavaScript to run this app.
导航
GetVideoLibraryFolderTree - 获取视频库分类信息(包含子分类)
最近更新时间:2025.03.21 19:08:03首次发布时间:2024.04.28 14:37:34
我的收藏
有用
有用
无用
无用

调用 GetVideoLibraryFolderTree 接口,获取当前账号下默认分类或指定分类及其子分类的信息。

说明

使用子账号调用接口时,仅支持获取该子账号可见的视频库分类。有关如何配置子账号的可见范围,详见子账号管理

注意事项

  • 请求频率:单用户请求频率限制为 1 次/秒
  • 前提条件:确保您拥有火山引擎主账号或具备媒资库 > 视频管理 > 视频库 > 仅查看可编辑权限的子账号。有关如何添加子账号,详见子账号管理

请求说明

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

请求参数

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

Query

参数类型是否必选示例值描述
ActionStringGetVideoLibraryFolderTree接口名称。当前 API 的名称为 GetVideoLibraryFolderTree
VersionString2023-08-01接口版本。当前 API 的版本为 2023-08-01
FolderIdLong0分类 ID。默认值为 0,表示查询默认分类下的所有子分类。

返回参数

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

FolderNode

参数类型示例值描述
FolderIdLong0分类 ID。
FolderNameString默认分类分类名称。
ChildrenArray of FolderNode-子分类信息。

FolderTypeForSubAccount

Integer

0

调用接口的子账号对分类的操作权限。取值如下:

  • 0:最高权限,既可以看到该分类和分类下的资源,也可以对分类本身和分类下的资源进行操作,例如删除资源、编辑分类等
  • 1:可以看到分类下的资源并对分类下的资源进行操作,但不可对分类本身进行操作,例如无法编辑分类、新建子分类等
  • 2:仅可以看到该分类,但无法看到分类下的资源,也无法对分类下的资源进行操作

说明

使用主账号调用接口时,该参数取值固定为 0

请求示例

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

返回示例

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

错误码

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