获取智能应用信息--慢直播-火山引擎

文档中心

立即注册

导航

获取智能应用信息

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

查询指定智能应用的详细信息。

请求方式

使用 GET 方式发起请求。

请求参数

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

字段	位置	类型	必填	说明	值
Action	Query	String	是	公共参数，OpenAPI 接口名称	GetAIApp
Version	Query	String	是	公共参数，OpenAPI 接口版本	2021-01-01
Type	Query	String	是	筛选条件，布控目标类型	可选枚举值： Vehicle（车辆布控应用）
AppID	Query	String	是	筛选条件，应用 ID	可通过调用 ListAIApp 接口获取

返回结果

返回参数说明

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

Result 字段包含以下参数：

字段	类型	说明
AppID	String	应用 ID
AppName	String	应用名称
BindSpaces	String[]	关联空间 ID 列表
AppLibs	String[]	布控目标 ID 列表
ConfidenceThreshold	Float	置信阈值
FrameInterval	Integer	截帧间隔，单位：毫秒
status	String	应用的状态： created（已创建） running（运行中） stopped（已停用）
EnableTimes	Array of objects	应用的生效时间： EnableFrom（应用生效起始时间） EnableTo（应用生效结束时间）
ImageTTL	Integer	图片存储周期，单位：天
CallbackUrl	String	回调地址

示例

请求示例

GET https://open.volcengineapi.com?Action=GetAIApp
&Version=2021-01-01
&Type=Vehicle
&AppID=8a6edfa6-4905-4bc9-9aef-dd527bff17ae
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202201271533070102121620310600AD37",
        "Action": "GetAIApp",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "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"
    }
}