jancd/qiniu-developer_ShareGPT huggingface dataset:
human: 如何处理七牛云的视频监控查询设备信息

gpt: [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >查询设备信息

#  查询设备信息

最近更新时间: 2023-04-13 10:25:54

# **描述**

本接口用于查询设备。

  * 接口请求域名：`qvs.qiniuapi.com`
  * 请求方式：GET
  * 接口路径：`/v1/namespaces/{namespaceId}/devices/{deviceId}`

# **请求参数**

**路径参数**

参数名称 | 必填 | 字段类型 | 说明  
---|---|---|---  
namespaceId | 是 | string | 空间ID  
deviceId | 是 | string | 设备Id  
  
# **响应参数**

参数名称 | 类型 | 说明  
---|---|---  
name | string | 设备名称  
desc | string | 设备描述  
type | integer | 类型，1：摄像头、2：平台  
nsId | string | 所属的空间ID  
nsName | string | 所属的空间名称  
gbId | string | 设备国标ID  
state | string | 状态（offline：离线，online：在线，notReg：未注册）  
username | string | 用户名  
password | string | 密码  
pullIfRegister | boolean | 注册成功后启动拉流，默认关闭  
vendor | string | 厂商  
createdAt | integer | 创建时间，Unix时间戳，秒  
updatedAt | integer | 更新时间，Unix时间戳，秒  
lastKeepaliveAt | integer | 最近心跳时间，Unix时间戳，秒  
lastRegisterAt | integer | 最近注册时间，Unix时间戳，秒  
alarmEnable | boolen | 是否开启国标报警  
alarmMethods | string | 接收报警类型列表。 alarmEnable为`True`时，此字段有效。多个报警类型以`,`分隔。  
1为电话报警， 2为设备报警， 3为短信报警， 4为GPS报警， 5为视频报警， 6为设备故障报警，
7其他报警。例如同时接收`短信报警`和`视频报警`，传递参数为`"3,5"`  
localRecordPushEnable | boolean | 本地录像上传开关，默认关闭。如果关闭此开关，本地录像上传云端接口无效  
localRecordTemplate | string | 开启本地录像上传开关后，配置录制模板ID  
deviceId | string | 设备id  
location.enable | boolean | 是否开启地理位置信息  
location.type | int | 0表示地理位置手动录入，1表示自动订阅位置信息，当`location.enable`为`True`时有效  
location.longitude | float | 经度，当`location.type`为`0`时有效  
location.latitude | float | 纬度，当`location.type`为`0`时有效  
location.interval | int | 订阅周期，数据范围为1~60秒，默认为5秒，当`location.type`为`1`时有效  
rtpAudio | boolean | 是否开启音频  
rtpAudioTranscode | boolean | 是否开启音频转码  
onDemandPull | boolean | 是否开启按需拉流  
  
以上内容是否对您有帮助？
human: 如何处理七牛云的视频监控获取设备列表

gpt: [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >获取设备列表

#  获取设备列表

最近更新时间: 2023-04-13 10:26:00

# **描述**

本接口用于查询空间下的设备列表。

  * 接口请求域名：`qvs.qiniuapi.com`
  * 请求方式：GET
  * 接口路径：`/v1/namespaces/{namespaceId}/devices?offset=<offset>&line=<line>&prefix=<prefix>&status=<status>&qtype=<qtype>`
  * Get请求，通过`非SDK`方式调用的客户，http头部Content-Type,`要么设置为application/x-www-form-urlencoded`,`要么置空`, `要么不要携带`; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)

# **请求参数**

**路径参数**

参数名称 | 必填 | 字段类型 | 说明  
---|---|---|---  
namespaceId | 是 | string | 空间ID  
line | 否 | integer | 一次返回多少条,最多1000,当超过1000条时，需要结合offset 循环读取。  
offset | 否 | integer | 偏移量。当数据较多，需要循环读取时使用。例如有2001条数据，初始值offset = 0, 第N次请求时offset = (N -1) * line  
prefix | 否 | string | 可以通过gbid前缀、设备名称或设备描述进行检索查询，支持模糊查询。`默认为""`  
state | 否 | string | 按设备状态查询，offline: 离线, online: 在线, notReg: 未注册  
qtype | 否 | integer | 按设备类型查询，0:全部, 1:摄像头, 2:平台  
  
# **响应参数**

参数名称 | 类型 | 说明  
---|---|---  
items | 设备数组 | 设备数组  
items.gbId | string | 设备国标Id  
items.name | string | 设备名称  
items.state | string | 状态（offline: 离线, online: 在线, notReg: 未注册）  
items.desc | string | 设备描述  
items.status | boolean | false: 未推流状态, true:推流状态  
items.createdAt | integer | 创建时间，Unix时间戳，秒  
items.updatedAt | integer | 更新时间，Unix时间戳，秒  
items.lastKeepaliveAt | integer | 最近心跳时间, Unix时间戳, 秒  
items.lastRegisterAt | integer | 最近注册时间, Unix时间戳, 秒  
items.deviceId | string | 设备id  
items.rtpAudio | boolean | 是否开启音频  
items.rtpAudioTranscode | boolean | 是否开启音频转码  
items.onDemandPull | boolean | 是否开启按需拉流  
  
# **示例**

**请求示例**

    
    
    curl --request GET \
      --url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/devices \
      --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
    

**响应示例**

    
    
    {
      "items": [
        {
          "name": "device1",
          "desc": "gb patch test",
          "nsId": "2akrarvzvyijd",
          "nsName": "gbt",
          "gbId": "31011500991320000028",
          "state": "notReg",
          "username": "username",
          "password": "password",
          "pullIfRegister": false,
          "createdAt": 1596166110,
          "updatedAt": 1596176486,
          "channels": 0,
          "lastRegisterAt": 0,
          "lastKeepaliveAt": 0
        },
        {
          "name": "beijing_test",
          "desc": "gbtest11",
          "nsId": "2akrarvzvyijd",
          "nsName": "gbt",
          "gbId": "31011500991320000020",
          "state": "offline",
          "username": "aaaaa",
          "password": "aaaaa",
          "pullIfRegister": true,
          "createdAt": 1595313745,
          "updatedAt": 1596081446,
          "channels": 0,
          "lastRegisterAt": 1596024977,
          "lastKeepaliveAt": 1596089383,
          "deviceId": "31011500991320000020"
        }
      ],
      "total": 2
    }
    

以上内容是否对您有帮助？
human: 如何处理七牛云的视频监控获取通道列表

gpt: [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >获取通道列表

#  获取通道列表

最近更新时间: 2022-08-10 11:18:01

# **描述**

本接口用于查询通道列表，仅对类型为“平台”的设备有效。

  * 接口请求域名：`qvs.qiniuapi.com`
  * 请求方式：GET
  * 接口路径：`/v1/namespaces/{namespaceId}/devices/{gbId}/channels?prefix=<GBIDPrefix>`
  * Get请求，通过`非SDK`方式调用的客户，http头部Content-Type,`要么设置为application/x-www-form-urlencoded`,`要么置空`, `要么不要携带`; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)

# **请求参数**

**路径参数**

参数名称 | 必填 | 字段类型 | 说明  
---|---|---|---  
namespaceId | 是 | string | 空间ID  
gbId | 是 | string | 国标ID  
prefix | 否 | string | 通道国标ID前缀  
  
# **响应参数**

参数名称 | 类型 | 说明  
---|---|---  
total | int | 通道数  
onlineCount | int | 在线设备数  
offlineCount | int | 离线数数  
items | 通道数组 | 通道数组  
items.name | string | 通道名称  
items.gbId | string | 通道国标ID  
items.state | string | 通道状态（offline: 离线, online: 在线）  
items.vendor | string | 厂家  
items.lastSyncAt | int | 最近一次同步时间  
  
**请求示例**

    
    
    curl --request GET \
      --url http://qvs.qiniuapi.com/v1/namespaces/2akrarxjr6tzn/devices/31011500991180000083/channels \
      --header 'authorization: Qiniu T853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
    

**响应示例**

    
    
    {
      "onlineCount": 5,
      "offlineCount": 0,
      "total": 5,
      "items": [
        {
          "gbId": "34020000001310000001",
          "name": "1F亮秀路车位-左",
          "state": "online",
          "vendor": "Dahua",
          "lastSyncAt": 1598613019
        },
        {
          "gbId": "34020000001310000017",
          "name": "IPC",
          "state": "online",
          "vendor": "Dahua",
          "lastSyncAt": 1598613020
        },
        {
          "gbId": "34020000001310000003",
          "name": "6F西北角",
          "state": "online",
          "vendor": "Dahua",
          "lastSyncAt": 1598613020
        },
        {
          "gbId": "34020000001310000004",
          "name": "2F东南阳台",
          "state": "online",
          "vendor": "Dahua",
          "lastSyncAt": 1598613020
        },
        {
          "gbId": "34020000001310000005",
          "name": "3F通道东北半球",
          "state": "online",
          "vendor": "Dahua",
          "lastSyncAt": 1598613020
        },
      ]
    }
    

以上内容是否对您有帮助？
human: 如何处理七牛云的视频监控删除通道

gpt: [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >删除通道

#  删除通道

最近更新时间: 2021-09-17 17:12:42

# **描述**

本接口用于删除通道。

  * 接口请求域名：`qvs.qiniuapi.com`
  * 请求方式：DELETE
  * 接口路径：`/v1/namespaces/{namespaceId}/devices/{gbId}/channels/{channelId}`
  * 使用姿势：首先在网络录像机上删除对应的通道，再调用本接口彻底删除通道。

# **请求参数**

**路径参数**

参数名称 | 必填 | 字段类型 | 说明  
---|---|---|---  
namespaceId | 是 | string | 空间ID  
gbId | 是 | string | 国标ID  
channelId | 是 | string | 通道国标ID  
  
# **响应参数**

无

# **示例**

**请求示例**

    
    
    curl --request DELETE \
      --url http://qvs.qiniuapi.com/v1/namespaces/2akrarxjr6tzn/devices/31011500991180000083/channels/34020000001310000001 \
      --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
    

**响应示例**

    
    
    {
      "code": 200
    }
    

以上内容是否对您有帮助？
human: 如何处理七牛云的视频监控启动设备拉流

gpt: [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >启动设备拉流

#  启动设备拉流

最近更新时间: 2023-07-07 19:09:38

# **描述**

本接口用于触发设备向七牛云推流。

  * 接口请求域名：`qvs.qiniuapi.com`
  * 请求方式：POST
  * 接口路径：`/v1/namespaces/{namespaceId}/devices/{deviceId}/start`
  * tips1: 天生一对，配套使用[停止设备拉流 __](https://developer.qiniu.com/qvs/6908/stop-device)
  * tips2: 调用间隔需>=5s, 若小于5s，接口会返回错误提示
  * tips3: 流id的拼接方法详见[使用流接口必读 __](https://developer.qiniu.com/qvs/11878/use-the-stream-interface-is-required)

# **请求参数**

**路径参数**

参数名称 | 必填 | 字段类型 | 说明  
---|---|---|---  
namespaceId | 是 | string | 空间ID  
deviceId | 是 | string | 设备Id  
  
**Body**

参数名称 | 必填 | 字段类型 | 说明  
---|---|---|---  
channels | 否 | string数组 | 设备为`平台`类型：指定需要启动的通道ID, 设备为`摄像头`类型，无需指定  
start | 否 | integer | 设备本地录像的开始时间。 默认`拉取设备实时视频流，当start和end都不为空时，该接口用于拉取设备本地录像。`  
end | 否 | integer | 设备本地录像的结束时间  
  
# **响应参数**

200

# **示例**

**请求示例**

    
    
    curl --request POST \
      --url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/devices/31011500991320000028/start \
      --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
      --header 'content-type: application/json'
    

**响应示例**

    
    
    {
      "code": 200
    }
    

以上内容是否对您有帮助？
human: 如何处理七牛云的视频监控停止设备拉流

gpt: [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >停止设备拉流

#  停止设备拉流

最近更新时间: 2022-09-29 15:35:07

# **描述**

本接口用于终止设备向七牛云推流。

  * 接口请求域名：`qvs.qiniuapi.com`
  * 请求方式：POST
  * 接口路径：`/v1/namespaces/{namespaceId}/devices/{deviceId}/stop`

# **请求参数**

**路径参数**

参数名称 | 必填 | 字段类型 | 说明  
---|---|---|---  
namespaceId | 是 | string | 空间ID  
deviceId | 是 | string | 设备国标Id  
  
**Body**

参数名称 | 必填 | 字段类型 | 说明  
---|---|---|---  
channels | 否 | string数组 | 用于终止`平台`类型设备(例如NVR)的`实时流`，需指定通道ID(为空表示停止平台下的所有设备实时流)  
channelId | 否 | string | 用于终止`平台`类型设备(例如NVR)的`本地录像流`，需指定通道ID  
start | 否 | integer | 仅当需要终止设备本地录像流时，需要携带该参数 开始时间(unix时间戳，单位为秒)  
end | 否 | integer | 仅当需要终止设备本地录像流时，需要携带该参数 结束时间(unix时间戳，单位为秒)  
  
# **响应参数**

200

# **示例**

**请求示例**

    
    
    curl --request POST \
      --url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/devices/31011500991320000028/stop \
      --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
      --header 'content-type: application/json'
    

**响应示例**

    
    
    {
      "code": 200
    }
    

以上内容是否对您有帮助？
human: 如何处理七牛云的视频监控停止语音对讲

gpt: [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >停止语音对讲

#  停止语音对讲

最近更新时间: 2022-04-24 16:26:38

# **描述**

本接口用于结束国标设备对讲。

  * 接口请求域名：`qvs.qiniuapi.com`
  * 请求方式：POST
  * 接口路径：`/v1/namespaces/{namespaceId}/devices/{gbId}/talkstop`

# **请求参数**

**路径参数**

参数名称 | 必填 | 字段类型 | 说明  
---|---|---|---  
namespaceId | 是 | string | 空间ID  
gbId | 是 | string | 设备国标Id  
  
**Body**

参数名称 | 必填 | 字段类型 | 说明  
---|---|---|---  
channels | 否 | string数组 | 用于终止`平台`类型设备(例如NVR)的语音对讲，需指定通道ID列表  
  
# **响应参数**

200

# **示例**

**请求示例**

    
    
    curl --request POST \
      --url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/devices/31011500991320000028/talkstop\
      --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
      --header 'content-type: application/json'
    

**响应示例**

    
    
    {
      "code": 200
    }
    

以上内容是否对您有帮助？
human: 如何处理七牛云的视频监控获取设备地理位置

gpt: [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >获取设备地理位置

#  获取设备地理位置

最近更新时间: 2024-06-12 16:22:36

# **描述**

本接口用于获取设备地理位置信息。

  * 接口请求域名：`qvs.qiniuapi.com`
  * 请求方式：GET
  * 接口路径：`/v1/namespaces/{namespaceId}/devices/{gbId}/location`

# **请求参数**

**路径参数**

参数名称 | 必填 | 字段类型 | 说明  
---|---|---|---  
namespaceId | 是 | string | 空间ID  
gbId | 是 | string | 设备国标ID  
  
# **响应参数**

参数名称 | 类型 | 说明  
---|---|---  
longitude | float | 经度  
latitude | float | 维度  
speed | float | 速度(单位：km/h)  
direction | float | 方向(摄像头方向与正北方的顺时针夹角，取值范围0°~360°)  
altitude | integer | 海拔高度(单位：m)  
updatedAt | integer | 地理位置更新时间(单位：秒)  
  
# **示例**

**请求示例**

    
    
    curl --request GET \
      --url 'http://qvs.qiniuapi.com/v1/namespaces/2akras5k6dkgl/devices/31011500991320000036/location' \
      --header 'Authorization: QiniuStub uid=1810757928'
    

**响应示例**

    
    
    {
        "longitude": 20.32,
        "latitude": 32.11,
        "speed": 0,
        "direction": 3,
        "altitude": 0,
        "updatedAt": 1631765837
    }
    

以上内容是否对您有帮助？
human: 如何处理七牛云的视频监控AI模板

gpt: [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口 >AI模板

#  AI模板

最近更新时间: 2022-12-12 12:10:34

AI

以上内容是否对您有帮助？
human: 如何处理七牛云的视频监控获取AI模版结构化数据

gpt: [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[AI模板](https://developer.qiniu.com/qvs/api/12179/ai-template) > 获取AI模版结构化数据

#  获取AI模版结构化数据

最近更新时间: 2022-12-22 11:25:41

# **描述**

本接口用于获取人脸识别结构化数据列表。

  * 接口请求域名：`qvs.qiniuapi.com`
  * 请求方式：GET
  * 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}/aidata/?start=<start>&end=<end>&line=<line>&offset=<offset>&sort=<sort>&algorithm=<algorithm>`
  * Get请求，通过`非SDK`方式调用的客户，http头部Content-Type,`要么设置为application/x-www-form-urlencoded`,`要么置空`, `要么不要携带`; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)

# **请求参数**

**路径参数**

参数名称 | 必填 | 字段类型 | 说明  
---|---|---|---  
namespaceId | 是 | string | 空间ID  
streamId | 是 | string | 流ID  
start | 否 | integer | 开始时间  
end | 否 | integer | 结束时间  
line | 否 | integer | 一次返回多少条，最多1000,当超过1000条时，需要结合offset 循环读取  
offset | 否 | integer | 偏移量，当需要循环读取时,初始值offset = 0, 第N次请求时offset = (N -1) * line  
sort | 否 | string | 默认按创建时间降序排列，sort由"asc/desc"和可参与排序的字段组成，其中 asc 表示升序，desc 表示降序  
algorithm | 是 | string | 算法类型，"1"表示安全帽检测，"2"表示人脸识别  
  
# **响应参数**

参数名称 | 类型 | 说明  
---|---|---  
items | 数组 | 结构化数据数组  
items.timestamp | integer | 截帧的时间,单位为秒,unix时间戳  
items.frameUrl | string | 截帧的url地址  
items.structuredData | string | 结构化数据  
total | integer | 数据总条数  
  
# **示例**

**请求示例**

    
    
    curl --request GET \
      --url http://qvs.qiniuapi.com/namespaces/123/streams/test/aidata?algorithm=1 \
      --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
    

**响应示例**

    
    
    {
      "items": [
        {
          "timestamp": "1586850533",
          "frameUrl": "http://qvs.com/demo.jpg",
          "structuredData": "this is a test",
        }
      ],
      "total": 1
    }
    

**结构化数据格式**

安全帽检测

    
    
    [
        {
            //检测到的目标具体信息
            "details": [
                {
                    "bbox": [874,192,932,260], //检测框在图⽚中的位置[left,top,right,bottom]
                    "label": "helmet",
                    "score": "0.92" //置信度
                },
                {
                    "bbox": [1162,173,1190,208],
                    "label": "helmet",
                    "score": "0.81"
                }
            ],
            //是否通过检测
            "suggestion": "pass"
        }
    ]
    

人脸识别

    
    
    {
        //检测到的目标具体信息
        "details": [
            {
                "bbox": [714,117,916,376], //检测框在图⽚中的位置[left,top,right,bottom]
                "label": "李四",
                "landmark": [761,852,794,767,831,205,208,250,310,314] //面部关键特征点
            },
            {
                "bbox": [773,217,807,261],
                "label": "王二",
                "landmark": [777,788,779,783,790,232,230,241,251,249]
            }
        ],
        //检测到的目标
        "imageLabel": ["李四","王二"]
    }
    

以上内容是否对您有帮助？
human: 如何处理七牛云的视频监控删除AI模板

gpt: [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[AI模板](https://developer.qiniu.com/qvs/api/12179/ai-template) > 删除AI模板

#  删除AI模板

最近更新时间: 2022-12-12 11:46:54

# **描述**

本接口用于删除AI模版

  * 接口请求域名：`qvs.qiniuapi.com`
  * 请求方式：DELETE
  * 接口路径：`/v1/aitemplates/{templateId}`

# **请求参数**

**路径参数**

参数名称 | 必填 | 字段类型 | 说明  
---|---|---|---  
templateId | 是 | string | AI模版ID  
  
# **响应参数**

无

# **示例**

**请求示例**

    
    
    curl --request DELETE \
      --url http://qvs.qiniuapi.com/v1/aitemplates/2akrars59hm2l \
      --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
    

**响应示例**

    
    
    {
      "code": 200
    }
    

以上内容是否对您有帮助？
human: 如何处理七牛云的视频监控按需模式下开启AI分析

gpt: [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[AI模板](https://developer.qiniu.com/qvs/api/12179/ai-template) > 按需模式下开启AI分析

#  按需模式下开启AI分析

最近更新时间: 2022-12-12 11:47:15

# **描述**

本接口用于对指定流启动AI分析。

  * 接口请求域名：`qvs.qiniuapi.com`
  * 请求方式：POST
  * 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}/ai/start`
  * 本接口需要空间绑定运行模式为`按需`类型的AI模板，或者流本身绑定运行模式为`按需`的AI模板。当用户想开启AI分析，可使用本接口。当用户想停止AI分析，可以使用[按需模式下停止AI分析 __](https://developer.qiniu.com/qvs/12356/stop-ai-on-demand)组合使用。

# **请求参数**

**路径参数**

参数名称 | 必填 | 字段类型 | 说明  
---|---|---|---  
namespaceId | 是 | string | 空间ID  
streamId | 是 | string | 流Id  
  
# **响应参数**

200

# **示例**

**请求示例**

    
    
    curl --request POST \
      --url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/streams/31011500991320000028/ai/start \
      --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' 
    

**响应示例**

    
    
    {
      "code": 200
    }
    

以上内容是否对您有帮助？
human: 如何处理七牛云的视频监控按需模式下停止AI分析

gpt: [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[AI模板](https://developer.qiniu.com/qvs/api/12179/ai-template) > 按需模式下停止AI分析

#  按需模式下停止AI分析

最近更新时间: 2022-12-12 11:47:23

# **描述**

本接口用于对指定流停止AI分析。

  * 接口请求域名：`qvs.qiniuapi.com`
  * 请求方式：POST
  * 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}/ai/stop`
  * 本接口需要空间绑定运行模式为`按需`类型的AI模板，或者流本身绑定运行模式为`按需`的AI模板。当用户想停止AI分析，可使用本接口。当用户想开启AI分析，可以使用[按需模式下开启AI __](https://developer.qiniu.com/qvs/12355/start-ai-on-demand)组合使用。

# **请求参数**

**路径参数**

参数名称 | 必填 | 字段类型 | 说明  
---|---|---|---  
namespaceId | 是 | string | 空间ID  
streamId | 是 | string | 流Id  
  
# **响应参数**

200

# **示例**

**请求示例**

    
    
    curl --request POST \
      --url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/streams/31011500991320000028/ai/stop \
      --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' 
    

**响应示例**

    
    
    {
      "code": 200
    }
    

以上内容是否对您有帮助？
human: 如何处理七牛云的视频监控更新AI模板

gpt: [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[AI模板](https://developer.qiniu.com/qvs/api/12179/ai-template) > 更新AI模板

#  更新AI模板

最近更新时间: 2022-12-13 11:44:41

# **描述**

本接口用于更新模版信息。

  * 接口请求域名：`qvs.qiniuapi.com`
  * 请求方式：PATCH
  * 接口路径：`/v1/aitemplates/{templateId}`

# **请求参数**

**路径参数**

参数名称 | 必填 | 字段类型 | 说明  
---|---|---|---  
templateId | 是 | string | 模版ID  
  
**Body**

参数名称 | 必填 | 字段类型 | 说明  
---|---|---|---  
operations | 是 | op数组 | op集合，详见： _表一_  
  
_表一：_ OP集合参数

参数名称 | 必填 | 字段类型 | 说明  
---|---|---|---  
operations.key | 是 | string | 要修改的参数  
operations.op | 是 | string | op操作(目前支持replace和delete)  
operations.value | 是 | object | 要修改的参数对应的value(当op为delete的时候可以忽略)  
  
_表二：_ 可编辑参数说明

参数名称 | 字段类型 | 说明  
---|---|---  
name | string | 模版名称  
algorithms | int数组 | 算法数组。算法可选 1:安全帽识别 2: 人脸识别; 数组{1, 2} 代表同时选择了1和2, 两种算法  
aiFrameInterval | integer | 截帧间隔, 默认为1, 代表每1秒截取1帧进行AI计算。有效范围 500ms~ 3600s  
confidence | integer | 置信度。默认 60, 有效范围是1～100  
runningMode | integer | 运行模式。0:只要视频流在线就开始AI分析 1: 通过API控制AI分析的开始和结束 2: 自定义区间段内开始AI分析  
aiImageLib | stirng | 依赖的基础图像库ID，例如当算法为人脸识别时，需要指定一个基础的图像库。也可以新建一个基础图像库。  
aiTimeRanges | TimeRange数组 | AI工作时间范围, 默认数组为空,代表24小时生效；否则按照实际区间段，支持多个区间段  
timeRange.start | string | AI每天开始时间。形式为00:00:00  
timeRange.end | string | AI每天结束时间。形式为00:00:00  
aiNeedCallback | boolean | 是否回调ai计算结果。默认true  
aiSaveResult | boolean | 是否保存ai识别的结构化数据，默认为false。若不保存，可以通过回调的方式得到结构化数据。  
desc | string | 模版描述  
bucket | string | 模版对应的对象存储的bucket,  
deleteAfterDays | integer | 存储过期时间，默认永久不过期  
fileType | integer | 文件存储类型，取值：0（普通存储），1（低频存储）  
  
# **响应参数**

响应参数与创建模板一致，请参阅**创建模板**[响应参数
__](https://developer.qiniu.io/qvs/api/6721/create-template#3)

# **示例**

**请求示例**

    
    
    curl --request PATCH \
      --url http://qvs.qiniuapi.com/v1/templates/d102sns2mwhd \
      --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
      --header 'content-type: application/json' \
      --data '{"operations":[{"key":"name","op":"replace","value":"123"}]
    }'
    

**响应示例**

    
    
    {
      "id": "d102sns2mwhd",
      "name": "123",
      "desc":"this is a test",
      "algorithms":[1],
      "confidence":60,
      "runningMode":0,
      "aiFrameInterval":5,
      "aiSaveResult":true,
      "bucket":"bucket-test1",
      "deleteAfterDays":7,
      "fileType":0,
      "createdAt": 1586847620,
      "updatedAt": 1586847620
    }
    

以上内容是否对您有帮助？
human: 如何处理七牛云的视频监控查询AI模板

gpt: [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[AI模板](https://developer.qiniu.com/qvs/api/12179/ai-template) > 查询AI模板

#  查询AI模板

最近更新时间: 2022-12-13 11:44:54

# **描述**

本接口用于查询模版。

  * 接口请求域名：`qvs.qiniuapi.com`
  * 请求方式：GET
  * 接口路径：`/v1/aitemplates/{templateId}`

# **请求参数**

**路径参数**

参数名称 | 必填 | 字段类型 | 说明  
---|---|---|---  
templateId | 是 | string | 模版ID  
  
# **响应参数**

参数名称 | 类型 | 说明  
---|---|---  
id | string | 模版id  
name | string | 模版名称  
algorithms | int数组 | 算法数组。算法可选 1:安全帽识别 2: 人脸识别; 数组{1, 2} 代表同时选择了1和2, 两种算法  
aiFrameInterval | integer | 截帧间隔, 默认为1, 代表每1秒截取1帧进行AI计算。有效范围 500ms~ 3600s  
confidence | integer | 置信度。默认 60, 有效范围是1～100  
runningMode | integer | 运行模式。0:只要视频流在线就开始AI分析 1: 通过API控制AI分析的开始和结束 2: 自定义区间段内开始AI分析  
aiImageLib | string | 依赖的基础图像库ID，例如当算法为人脸识别时，需要指定一个基础的图像库。也可以新建一个基础图像库。  
aiTimeRanges | TimeRange数组 | AI工作时间范围, 默认数组为空,代表24小时生效；否则按照实际区间段，支持多个区间段  
timeRange.start | string | AI每天开始时间。形式为00:00:00  
timeRange.end | string | AI每天结束时间。形式为00:00:00  
aiNeedCallback | boolean | 是否回调ai计算结果。默认true  
aiSaveResult | boolean | 是否保存ai识别的结构化数据，默认为false。若不保存，可以通过回调的方式得到结构化数据。  
desc | string | 模版描述  
bucket | string | 模版对应的对象存储的bucket,  
deleteAfterDays | integer | 存储过期时间，默认永久不过期  
fileType | integer | 文件存储类型，取值：0（普通存储），1（低频存储）  
createdAt | integer | 模板创建时间  
updatedAt | integer | 模板更新时间  
  
# **示例**

**请求示例**

    
    
    curl --request GET \
      --url http://qvs.qiniuapi.com/v1/aitemplates/2akrars59hm2l \
      --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
    

**响应示例**

    
    
    {
      "id": "2akrars59hm2l",
      "name": "test0013",
      "desc":"this is a test",
      "algorithms":[1],
      "confidence":60,
      "runningMode":0,
      "aiFrameInterval":5,
      "aiSaveResult":true,
      "bucket":"bucket-test1",
      "deleteAfterDays":7,
      "fileType":0,
      "createdAt": 1586847620,
      "updatedAt": 1586847620
    }
    

以上内容是否对您有帮助？
human: 如何处理七牛云的视频监控图像底库

gpt: [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口 >图像底库

#  图像底库

最近更新时间: 2022-08-17 17:51:04

图像底库

以上内容是否对您有帮助？
human: 如何处理七牛云的视频监控查询实体

gpt: [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 查询实体

#  查询实体

最近更新时间: 2022-12-13 11:45:00

# **描述**

本接口用于查询某个图像底库里的某一个实体信息。

  * 接口请求域名：`qvs.qiniuapi.com`
  * 请求方式：GET
  * 接口路径：`/v1/imagelibs/{libId}/entities/{entityId}`

# **请求参数**

**路径参数**

参数名称 | 必填 | 字段类型 | 说明  
---|---|---|---  
libId | 是 | string | 图像库ID  
entityId | 是 | string | 实体ID  
  
# **响应参数**

参数名称 | 类型 | 说明  
---|---|---  
libId | string | 图像库ID  
id | string | 实体ID  
urls | string数组 | 实体图片数组列表,1个实体可以附加上传多个图片,默认展示第一个  
name | string | 姓名  
gender | string | 性别 male 或 female  
phoneNum | string | 手机号  
certNum | string | 证件号  
addr | string | 地址  
desc | string | 备注描述  
createdAt | integer | 实体创建时间  
  
# **示例**

**请求示例**

    
    
    curl --request GET \
      --url http://qvs.qiniuapi.com/v1/imagelibs/xxx/entities/yyy \
      --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
    

**响应示例**

    
    
    {
        "libId":"xxx",
        "id": "yyy",
        "name":"whoami",
        "urls": ["http://qvs.com/demo", "http://qiniu.com/demo.jpg"],
        "desc": "this is a entity test",
        "createdAt": 1586850533
    }
    

以上内容是否对您有帮助？