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

文档中心

立即注册

导航

企业直播

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

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

您可通过此接口获取主账号下指定分类名称的信息。

注意事项

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

请求说明

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

请求参数

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

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`SearchVideoLibraryFolderTree`	接口名称。当前 API 的名称为 `SearchVideoLibraryFolderTree`。
Version	String	是	`2023-08-01`	接口版本。当前 API 的版本为 `2023-08-01`。
SearchName	String	是	`默认分类`	根据分类名称进行模糊筛选。最多支持输入 100 个字符。
PageNumber	Integer	否	`1`	分页查询页码，默认值为 `1`。
PageSize	Integer	否	`10`	分页查询数量。取值范围为 [1,100]，默认值为 `10`。

返回参数

参数	类型	示例值	描述
TotalCount	Integer	`1`	查询结果总数。
PageNumber	Integer	`1`	分页查询页码。
PageSize	Integer	`10`	分页查询数量。
Result	Array of Result	`-`	分类信息。

Result

参数	类型	示例值	描述
FolderId	Long	`1795946685895819`	分类 ID。
FolderName	String	`默认分类`	分类名称。

请求示例

GET https://livesaas.volcengineapi.com/?Action=SearchVideoLibraryFolderTree&Version=2023-08-01&SearchName=默认分类&PageNumber=1&PageSize=10

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2024041711163644076A719E4A2C15E485",
        "Action": "SearchVideoLibraryFolderTree",
        "Version": "2023-08-01",
        "Service": "livesaas",
        "Region": "cn-north-1",
        "SystemTime": 1713323797
    },
    "Result": {
        "Result": [
            {
                "FolderId": 1795946685895819,
                "FolderName": "默认分类"
            }
        ],
        "TotalCount": 1,
        "PageNumber": 1,
        "PageSize": 10
    }
}

错误码

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