您可通过此接口获取主账号下指定分类名称的信息。
注意事项
- 请求频率：单用户请求频率限制为 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": "20230604110420****100232280022D31",
"Action": "SearchVideoLibraryFolderTree",
"Version": "2023-08-01",
"Service": "livesaas",
"Region": "cn-north-1",
"SystemTime": 1697446406
},
"Result": {
"TotalCount": 1,
"PageNumber": 1,
"PageSize": 10,
"Result": [
{
"FolderId": 1795946685895819,
"FolderName": "默认分类"
}
]
}
}
错误码
访问公共错误码和错误码获取详细信息。