You need to enable JavaScript to run this app.
导航

查看 AI 模板列表

最近更新时间2022.02.08 14:18:34

首次发布时间2022.01.30 14:42:53

查询已创建的 AI 模板列表。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段
位置
类型
必填
说明
ActionQueryString公共参数,OpenAPI 接口名称ListAITemplates
VersionQueryString公共参数,OpenAPI 接口版本2021-01-01

Order

Query

Integer

查询结果排序方式

可选枚举值:

  • 1(正序)
  • -1(倒序,默认)

返回结果

返回参数说明

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

Result 字段包含以下参数:

字段
类型
说明
TemplatesArray of objects查询到的录制模板列表,参考以下 List<Templates> 结构说明

List<Templates> 结构说明

字段
类型
说明
TemplateNameString模板名称
TemplateIDString模板 ID
TemplateTypeString模板类型
CreatedAtString创建时间
UpdatedAtString更新时间
AIMap查询到的 AI 模板列表,参考以下 模板配置结构说明

模板配置结构说明

字段
类型
说明

CapabilitySet

String[]

AI 能力类型:

  • vehicle(车辆检测能力类型)

TemplateItems

Map

AI 能力类型配置信息:

  • vehicle:车辆检测能力类型,参考以下 Vehicle 配置结构说明
ImageTTLInteger图片存储周期,单位:天

Vehicle 配置结构说明

字段
类型
说明
CapabilityTypeStringAI 能力类型(vehicle)
ConfidenceThresholdFloat置信阈值
FrameIntervalInteger截帧间隔

GrabStrategy

String

图片抓取方式:

  • timing(定时)
  • best(最优)
  • fastest(最快)
StatusBoolean模板是否启用
ExtraArray of objects自定义信息

EnableTimes

Array of objects

模板生效时间:

  • EnableFrom(模板生效起始时间)
  • EnableTo(模板生效结束时间)

示例

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022012516443201020405722019002762",
        "Action": "ListAITemplates",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 1,
        "Templates": [
            {
                "TemplateID": "1c443146-8d6a-44d5-baf8-5efafc0e7275",
                "TemplateName": "car0121",
                "TemplateType": "ai",
                "AI": {
                    "CapabilitySet": [
                        "vehicle"
                    ],
                    "TemplateItems": {
                        "vehicle": {
                            "CapabilityType": "vehicle",
                            "ConfidenceThreshold": 20,
                            "FrameInterval": 100,
                            "Extra": null,
                            "Status": true,
                            "GrabStrategy": "timing",
                            "EnableTimes": [
                                {
                                    "EnableFrom": "00:00:00",
                                    "EnableTo": "23:59:59"
                                }
                            ]
                        }
                    },
                    "ImageTTL": 7
                },
                "CreatedAt": "2022-01-21T16:55:42+08:00",
                "UpdatedAt": "2022-01-25T16:44:27+08:00"
            }
        ]
    }
}