You need to enable JavaScript to run this app.
导航
获取智能应用列表
最近更新时间:2022.02.08 14:18:44首次发布时间:2022.01.30 15:24:41

查询已创建的智能应用列表。

请求方式

使用 GET 方式发起请求。

请求参数

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

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

Type

Query

String

筛选条件,布控目标类型

可选枚举值:

  • Vehicle(车辆布控应用)

Order

Query

Integer

查询结果排序方式

可选枚举值:

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

返回结果

返回参数说明

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

Result 字段包含以下参数:

字段
类型
说明
AIAppsArray of objects查询到的车辆布控应用列表,参考以下 List<AIApps> 结构说明

List<AIApps> 结构说明

字段
类型
说明
AppIDString应用 ID
AppNameString应用名称
BindSpacesString[]关联空间 ID 列表
AppLibsString[]布控目标 ID 列表
ConfidenceThresholdFloat置信阈值
FrameIntervalInteger截帧间隔,单位:毫秒

status

String

应用的状态:

  • created(已创建)
  • running(运行中)
  • stopped(已停用)

EnableTimes

Array of objects

应用的生效时间:

  • EnableFrom(应用生效起始时间)
  • EnableTo(应用生效结束时间)
ImageTTLInteger图片存储周期,单位:天
CallbackUrlString回调地址

示例

请求示例

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

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202201271515320102120352271A00A77A",
        "Action": "ListAIApp",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "PageNumber": 1,
        "PageSize": 20,
        "TotalCount": 2,
        "AIApps": [
            {
                "AppID": "eadc17d0-37de-4282-9d5b-11b57f0ae0c7",
                "AppName": "rtsp",
                "BindSpaces": [
                    "1d02923f-d5ce-40f2-ac90-fea4a55e04f5"
                ],
                "AppLibs": [
                    "0-1642754961198599-1579"
                ],
                "FrameInterval": 1000,
                "EnableTimes": [
                    {
                        "EnableFrom": "00:00:00",
                        "EnableTo": "23:59:59"
                    }
                ],
                "ImageTTL": 7456789,
                "ConfidenceThreshold": 20,
                "CallbackUrl": "",
                "Status": "running"
            },
            {
                "AppID": "8a6edfa6-4905-4bc9-9aef-dd527bff17ae",
                "AppName": "rtmp",
                "BindSpaces": [
                    "a0c97103-f019-42b4-b60a-f0976744d546"
                ],
                "AppLibs": [
                    "0-1642754961198599-1579"
                ],
                "FrameInterval": 1000,
                "EnableTimes": [
                    {
                        "EnableFrom": "00:00:00",
                        "EnableTo": "23:59:59"
                    }
                ],
                "ImageTTL": 7,
                "ConfidenceThreshold": 20,
                "CallbackUrl": "",
                "Status": "running"
            }
        ]
    }
}