获取对象库列表--慢直播-火山引擎

文档中心

立即注册

导航

获取对象库列表

最近更新时间：2022.02.08 14:18:44首次发布时间：2022.01.30 15:24:41

查询已创建的对象库列表。

请求方式

使用 GET 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考「公共参数」。

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	ListLib
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
Type	Query	String	否	筛选条件，对象库类型	可选枚举值： Vehicle（车辆库）
LibName	Query	String	否	筛选条件，对象库名称，支持模糊查询
Order	Query	Integer	否	查询结果排序方式	可选枚举值： 1（正序） -1（倒序，默认）

返回结果

返回参数说明

通用返回参数，请参考 ResponseMetadata 结构体说明。

Result 字段包含以下参数：

字段	类型	说明
AILibs	Array of objects	查询到的录制模板列表，参考以下 `List<AILibs>` 结构说明

List<AILibs> 结构说明

字段	类型	说明
LibID	String	对象库 ID
LibName	String	对象库名称
Lib	String	对象库类型： Vehicle（车辆库）
CreateTime	String	创建时间
UpdateTime	String	更新时间
Description	String	描述

示例

请求示例

GET https://open.volcengineapi.com?Action=ListLib
&Version=2021-01-01
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022012612105901021214504822006170",
        "Action": "ListLib",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 3,
        "AILibs": [
            {
                "LibName": "test1",
                "Lib": "Vehicle",
                "Description": "test1",
                "LibID": "0-1642753848295752-7116",
                "CreateTime": "2022-01-21T16:30:48+08:00",
                "UpdateTime": "2022-01-21T16:30:48+08:00"
            },
            {
                "LibName": "test2",
                "Lib": "Vehicle",
                "Description": "test2",
                "LibID": "0-1642754961198599-1579",
                "CreateTime": "2022-01-21T16:49:21+08:00",
                "UpdateTime": "2022-01-21T16:49:21+08:00"
            },
            {
                "LibName": "Updated-lib",
                "Lib": "Vehicle",
                "Description": "Updated vehicle lib for car monitoring",
                "LibID": "0-1643165894538875-5418",
                "CreateTime": "2022-01-26T10:58:14+08:00",
                "UpdateTime": "2022-01-26T12:09:39+08:00"
            }
        ]
    }
}