question
stringlengths 1
57
| tag
stringclasses 18
values | response
stringlengths 112
68.3k
| content
stringlengths 238
68.5k
| __index_level_0__
int64 0
12k
|
|---|---|---|---|---|
API调用音频审核 | 内容审核 | [内容审核](https://developer.qiniu.com/censor) > API 文档 > API调用音频审核
# API调用音频审核
最近更新时间: 2021-10-25 11:45:38
本文介绍了异步调用音频内容审核 `/v3/audio/censor` 的接口，帮助您正确使用此 API 进行音频内容审核，支持基于API
URL发起HTTP/HTTPS POST请求的方式调用。
# 使用限制
* 音频大小不超过200M。
* 音频格式支持 MP3、WAV、AAC、WMA、OGG、M4A、AMR、AUDIO、M3U8。
* 接口响应时间依赖音频的下载时间。请保证被审核音频所在的存储服务稳定可靠，建议您使用七牛云存储或者CDN缓存等。
# 功能描述
音频内容审核 API 主要用于检测或识别音频中的不良信息，并给出审核结果管控建议。支持的审核类型包括：音频反垃圾。
**审核类型 scenes 与相应的 label**
在提交内容审核任务时，您需要指定审核类型 **scenes** ；而在返回结果中，则包含了您指定的类型对应的 label 结果分类参数。
审核类型 | 说明 | scenes | label
---|---|---|---
音频反垃圾 | 识别音频中是否包含垃圾信息。 | antispam | normal：正常文本politics：涉政porn：色情abuse：辱骂contraband：违禁
# 请求说明
请求方式：POST
请求url：http://ai.qiniuapi.com/v3/audio/censor
**请求Header**
字段 | 取值
---|---
Content-Type | application/json
Authorization | Qiniu < AccessKey> :< Sign>
注意: 用户请根据 AccessKey 和 SecretKey 后生成鉴权，以便进行身份验证， `Sign` 的取值以及 `Authorization`
签名方法请参考[七牛鉴权 __](https://developer.qiniu.com/dora/kb/3702/QiniuToken)。
**请求参数**
字段 | 类型 | 是否必选 | 说明
---|---|---|---
data.uri | string | Y | 音频URL地址，目前支持http、https和[qiniu协议](https://developer.qiniu.com/censor/7299/censor-params#2)的资源。
data.id | string | N | 调用者设置的音频唯一标识，异步处理的返回结果中会带上该信息。
params.scenes | array | Y | 审核类型，必填字段，当前唯一可选项： `antispam` 。
params.hook_url | string | N | 音频检测结束后的回调地址。
params.hook_auth | Boolean | N | true/false，默认为false，设置回调请求中加入请求头authorization，用于回调服务器鉴权
**请求示例**
POST /v3/audio/censor HTTP/1.1
Host: ai.qiniuapi.com
Content-Type: application/json
Authorization: Qiniu YnxrxOSvGotRZpqkZnMzl_euuoqRzOKUd6zwbRju:r6a-o2UpBg6A4puIMnkCExH8lE8=
{
"data": {
"uri": "http://xxx.mp3",
"id": "audio-censor-demo"
},
"params": {
"scenes": [
"antispam"
],
"hook_url":"http://xxx.com"
}
}
注意： 请把 Authorization 换成您的账号七牛鉴权 QiniuToken
## 系统接受到请求后，会立即返回异步任务 id，音频审核结果通过任务 id 获得。
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": <id>
}
参数 | 类型 | 必选 | 说明
---|---|---|---
`id` | string | 是 | 服务器返回的，唯一标识该音频审核任务的ID。
# 通过任务id获取音频审核结果
**请求语法**
GET /v3/jobs/audio/<id> HTTP/1.1
Host: ai.qiniuapi.com
Authorization: Qiniu <AccessKey>:<Sign>
**注意：** 需要在请求的 head 部分添加[七牛鉴权
__](https://developer.qiniu.com/dora/kb/3702/QiniuToken)，以进行用户身份验证。
参数 | 类型 | 必选 | 说明
---|---|---|---
`id` | string | 是 | 服务器返回的，唯一标识该音频任务的ID。
**返回参数说明**
字段 | 取值 | 说明
---|---|---
id | string | 服务器返回的，唯一标识该音频任务的ID。
status | string | 任务状态， `WAITING/DOING/FINISHED/FAILED` 。
request | json结构体 | 音频审核请求中的body。
response | json结构体 | 音频内容审核的返回结果，详情请查看 `*表. 音频内容审核的返回结果*` 。
error | string | 任务错误信息。
created_at | string | 任务创建时间，如：2021-05-18T15:03:04.123Z。
updated_at | string | 任务更新时间，如：2021-05-18T15:03:14.123Z。
_表. 音频内容审核的返回结果_
字段 | 取值 | 说明
---|---|---
code | int | 处理状态：200 调用成功
message | string | 与code对应的状态描述信息
audio_text | string | 音频文本
result.suggestion | string | 音频的审核结果管控建议说明根据内容审核中各种审核类型的返回结果，系统会将审核结果转换成对应的管控建议，取值包括：[“block”, ”review”, ”pass”]。suggestion=block：表示系统确认审核内容违规，建议您将其删除。suggestion=review：表示系统无法确认审核内容是否违规，建议您进行人工复核。suggestion=pass：表示系统确认审核内容正常，建议您忽略该文件。
result.scenes. `<type>` | json结构体 | 审核类型, 目前仅支持 `antispam`
result.scenes. `<type>` .suggestion | string | 该审核类型的结果管控建议，参见result.suggestion
result.scenes. `<type>` .cuts[] | array | 该审核类型的音频段审核结果数组
result.scenes. `<type>` .cuts[].suggestion | string | 该审核类型的音频段审核结果管控建议，参见result.suggestion
result.scenes. `<type>` .cuts[].start_time | int | 该审核类型的音频段在原始音频中的起始位移，单位s
result.scenes. `<type>` .cuts[].end_time | int | 该审核类型的音频段在原始音频中的结束位移，单位s
result.scenes. `<type>` .cuts[].audio_text | string | 该审核类型的音频段文本
result.scenes. `<type>` .cuts[].details[] | array | 该审核类型的音频段审核详细信息数组
result.scenes. `<type>` .cuts[].details[].suggestion | string | 该审核类型的音频段审核结果详细的结果管控建议，参见result.suggestion
result.scenes. `<type>` .cuts[].details[].label | string | 该审核类型的音频段审核结果标签
result.scenes. `<type>` .cuts[].details[].score | string | 该审核类型的音频段审核结果置信度
**返回示例**
{
"id":"5c416b7afb09fe00089e37be",
"request":{
"data":{
"uri":"http://xxx.mp3",
"id":"audio-censor-demo"
},
"params":{
"scenes":[
"antispam"
],
"hook_url":"http://xxx.com"
}
},
"status":"FINISHED",
"result":{
"code":200,
"message":"OK",
"audio_text":"当地时间八月二十八号...当务之急是...",
"result":{
"suggestion":"block",
"scenes":{
"antispam":{
"suggestion":"block",
"cuts":[
{
"suggestion":"block",
"start_time":0,
"end_time":20,
"audio_text":"当地时间八月二十八号...",
"details":[
{
"suggestion":"block",
"label":"politics",
"score":0.9991
}
]
},
{
"suggestion":"block",
"start_time":20,
"end_time":42,
"audio_text":"当务之急是...",
"details":[
{
"suggestion":"block",
"label":"politics",
"score":0.982
}
]
}
]
}
}
}
},
"created_at":"2021-05-18T15:03:04.123Z",
"updated_at":"2021-05-18T15:03:14.123Z"
}
# 音频审核结果回调
## 使用限制须知
* API调用音频审核支持不设置回调
* 若设置了回调，进行了一次API调用音频审核，则触发一次回调
* 若回调失败，会重试三次
## API调用音频审核回调格式
字段 | 取值 | 说明
---|---|---
id | string | 服务器返回的，唯一标识该音频审核任务的ID。
request | json结构体 | 音频审核请求中的body。
status | string | 任务状态， `WAITING/DOING/FINISHED/FAILED` 。
response | json结构体 | 音频审核返回结果，详情请查看 _表. 音频内容审核的返回结果_
error | string | 任务错误信息。
created_at | string | 任务创建时间，如：2021-05-18T15:03:04。
updated_at | string | 任务更新时间，如：2021-05-18T15:03:14。
**返回示例**
{
"id":"5c416b7afb09fe00089e37bf",
"request":{
"data":{
"uri":"http://xxx.mp3",
"id":"audio-censor-demo"
},
"params":{
"scenes":[
"antispam"
],
"hook_url":"http://xxx.com"
}
},
"status":"FINISHED",
"response":{
"code":200,
"message":"OK",
"audio_text":"当地时间八月二十八号...当务之急是...",
"result":{
"suggestion":"block",
"scenes":{
"antispam":{
"suggestion":"block",
"cuts":[
{
"suggestion":"block",
"start_time":0,
"end_time":20,
"audio_text":"当地时间八月二十八号...",
"details":[
{
"suggestion":"block",
"label":"politics",
"score":0.9991
}
]
},
{
"suggestion":"block",
"start_time":20,
"end_time":42,
"audio_text":"当务之急是...",
"details":[
{
"suggestion":"block",
"label":"politics",
"score":0.982
}
]
}
]
}
}
}
},
"created_at":"2021-05-18T15:03:04",
"updated_at":"2021-05-18T15:03:14"
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[内容审核](https://developer.qiniu.com/censor) > API 文档 > API调用音频审核
# API调用音频审核
最近更新时间: 2021-10-25 11:45:38
本文介绍了异步调用音频内容审核 `/v3/audio/censor` 的接口，帮助您正确使用此 API 进行音频内容审核，支持基于API
URL发起HTTP/HTTPS POST请求的方式调用。
# 使用限制
* 音频大小不超过200M。
* 音频格式支持 MP3、WAV、AAC、WMA、OGG、M4A、AMR、AUDIO、M3U8。
* 接口响应时间依赖音频的下载时间。请保证被审核音频所在的存储服务稳定可靠，建议您使用七牛云存储或者CDN缓存等。
# 功能描述
音频内容审核 API 主要用于检测或识别音频中的不良信息，并给出审核结果管控建议。支持的审核类型包括：音频反垃圾。
**审核类型 scenes 与相应的 label**
在提交内容审核任务时，您需要指定审核类型 **scenes** ；而在返回结果中，则包含了您指定的类型对应的 label 结果分类参数。
审核类型 | 说明 | scenes | label
---|---|---|---
音频反垃圾 | 识别音频中是否包含垃圾信息。 | antispam | normal：正常文本politics：涉政porn：色情abuse：辱骂contraband：违禁
# 请求说明
请求方式：POST
请求url：http://ai.qiniuapi.com/v3/audio/censor
**请求Header**
字段 | 取值
---|---
Content-Type | application/json
Authorization | Qiniu < AccessKey> :< Sign>
注意: 用户请根据 AccessKey 和 SecretKey 后生成鉴权，以便进行身份验证， `Sign` 的取值以及 `Authorization`
签名方法请参考[七牛鉴权 __](https://developer.qiniu.com/dora/kb/3702/QiniuToken)。
**请求参数**
字段 | 类型 | 是否必选 | 说明
---|---|---|---
data.uri | string | Y | 音频URL地址，目前支持http、https和[qiniu协议](https://developer.qiniu.com/censor/7299/censor-params#2)的资源。
data.id | string | N | 调用者设置的音频唯一标识，异步处理的返回结果中会带上该信息。
params.scenes | array | Y | 审核类型，必填字段，当前唯一可选项： `antispam` 。
params.hook_url | string | N | 音频检测结束后的回调地址。
params.hook_auth | Boolean | N | true/false，默认为false，设置回调请求中加入请求头authorization，用于回调服务器鉴权
**请求示例**
POST /v3/audio/censor HTTP/1.1
Host: ai.qiniuapi.com
Content-Type: application/json
Authorization: Qiniu YnxrxOSvGotRZpqkZnMzl_euuoqRzOKUd6zwbRju:r6a-o2UpBg6A4puIMnkCExH8lE8=
{
"data": {
"uri": "http://xxx.mp3",
"id": "audio-censor-demo"
},
"params": {
"scenes": [
"antispam"
],
"hook_url":"http://xxx.com"
}
}
注意： 请把 Authorization 换成您的账号七牛鉴权 QiniuToken
## 系统接受到请求后，会立即返回异步任务 id，音频审核结果通过任务 id 获得。
HTTP/1.1 200 OK
Content-Type: application/json
{
"id": <id>
}
参数 | 类型 | 必选 | 说明
---|---|---|---
`id` | string | 是 | 服务器返回的，唯一标识该音频审核任务的ID。
# 通过任务id获取音频审核结果
**请求语法**
GET /v3/jobs/audio/<id> HTTP/1.1
Host: ai.qiniuapi.com
Authorization: Qiniu <AccessKey>:<Sign>
**注意：** 需要在请求的 head 部分添加[七牛鉴权
__](https://developer.qiniu.com/dora/kb/3702/QiniuToken)，以进行用户身份验证。
参数 | 类型 | 必选 | 说明
---|---|---|---
`id` | string | 是 | 服务器返回的，唯一标识该音频任务的ID。
**返回参数说明**
字段 | 取值 | 说明
---|---|---
id | string | 服务器返回的，唯一标识该音频任务的ID。
status | string | 任务状态， `WAITING/DOING/FINISHED/FAILED` 。
request | json结构体 | 音频审核请求中的body。
response | json结构体 | 音频内容审核的返回结果，详情请查看 `*表. 音频内容审核的返回结果*` 。
error | string | 任务错误信息。
created_at | string | 任务创建时间，如：2021-05-18T15:03:04.123Z。
updated_at | string | 任务更新时间，如：2021-05-18T15:03:14.123Z。
_表. 音频内容审核的返回结果_
字段 | 取值 | 说明
---|---|---
code | int | 处理状态：200 调用成功
message | string | 与code对应的状态描述信息
audio_text | string | 音频文本
result.suggestion | string | 音频的审核结果管控建议说明根据内容审核中各种审核类型的返回结果，系统会将审核结果转换成对应的管控建议，取值包括：[“block”, ”review”, ”pass”]。suggestion=block：表示系统确认审核内容违规，建议您将其删除。suggestion=review：表示系统无法确认审核内容是否违规，建议您进行人工复核。suggestion=pass：表示系统确认审核内容正常，建议您忽略该文件。
result.scenes. `<type>` | json结构体 | 审核类型, 目前仅支持 `antispam`
result.scenes. `<type>` .suggestion | string | 该审核类型的结果管控建议，参见result.suggestion
result.scenes. `<type>` .cuts[] | array | 该审核类型的音频段审核结果数组
result.scenes. `<type>` .cuts[].suggestion | string | 该审核类型的音频段审核结果管控建议，参见result.suggestion
result.scenes. `<type>` .cuts[].start_time | int | 该审核类型的音频段在原始音频中的起始位移，单位s
result.scenes. `<type>` .cuts[].end_time | int | 该审核类型的音频段在原始音频中的结束位移，单位s
result.scenes. `<type>` .cuts[].audio_text | string | 该审核类型的音频段文本
result.scenes. `<type>` .cuts[].details[] | array | 该审核类型的音频段审核详细信息数组
result.scenes. `<type>` .cuts[].details[].suggestion | string | 该审核类型的音频段审核结果详细的结果管控建议，参见result.suggestion
result.scenes. `<type>` .cuts[].details[].label | string | 该审核类型的音频段审核结果标签
result.scenes. `<type>` .cuts[].details[].score | string | 该审核类型的音频段审核结果置信度
**返回示例**
{
"id":"5c416b7afb09fe00089e37be",
"request":{
"data":{
"uri":"http://xxx.mp3",
"id":"audio-censor-demo"
},
"params":{
"scenes":[
"antispam"
],
"hook_url":"http://xxx.com"
}
},
"status":"FINISHED",
"result":{
"code":200,
"message":"OK",
"audio_text":"当地时间八月二十八号...当务之急是...",
"result":{
"suggestion":"block",
"scenes":{
"antispam":{
"suggestion":"block",
"cuts":[
{
"suggestion":"block",
"start_time":0,
"end_time":20,
"audio_text":"当地时间八月二十八号...",
"details":[
{
"suggestion":"block",
"label":"politics",
"score":0.9991
}
]
},
{
"suggestion":"block",
"start_time":20,
"end_time":42,
"audio_text":"当务之急是...",
"details":[
{
"suggestion":"block",
"label":"politics",
"score":0.982
}
]
}
]
}
}
}
},
"created_at":"2021-05-18T15:03:04.123Z",
"updated_at":"2021-05-18T15:03:14.123Z"
}
# 音频审核结果回调
## 使用限制须知
* API调用音频审核支持不设置回调
* 若设置了回调，进行了一次API调用音频审核，则触发一次回调
* 若回调失败，会重试三次
## API调用音频审核回调格式
字段 | 取值 | 说明
---|---|---
id | string | 服务器返回的，唯一标识该音频审核任务的ID。
request | json结构体 | 音频审核请求中的body。
status | string | 任务状态， `WAITING/DOING/FINISHED/FAILED` 。
response | json结构体 | 音频审核返回结果，详情请查看 _表. 音频内容审核的返回结果_
error | string | 任务错误信息。
created_at | string | 任务创建时间，如：2021-05-18T15:03:04。
updated_at | string | 任务更新时间，如：2021-05-18T15:03:14。
**返回示例**
{
"id":"5c416b7afb09fe00089e37bf",
"request":{
"data":{
"uri":"http://xxx.mp3",
"id":"audio-censor-demo"
},
"params":{
"scenes":[
"antispam"
],
"hook_url":"http://xxx.com"
}
},
"status":"FINISHED",
"response":{
"code":200,
"message":"OK",
"audio_text":"当地时间八月二十八号...当务之急是...",
"result":{
"suggestion":"block",
"scenes":{
"antispam":{
"suggestion":"block",
"cuts":[
{
"suggestion":"block",
"start_time":0,
"end_time":20,
"audio_text":"当地时间八月二十八号...",
"details":[
{
"suggestion":"block",
"label":"politics",
"score":0.9991
}
]
},
{
"suggestion":"block",
"start_time":20,
"end_time":42,
"audio_text":"当务之急是...",
"details":[
{
"suggestion":"block",
"label":"politics",
"score":0.982
}
]
}
]
}
}
}
},
"created_at":"2021-05-18T15:03:04",
"updated_at":"2021-05-18T15:03:14"
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,252 |
产品概述 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 产品简介 >产品概述
# 产品概述
最近更新时间: 2022-05-27 18:43:54
七牛云视频监控（qvs）面向视频监控设备或监控平台提供的音视频流接入、流式存储、分发、录制回放的服务。视频流接入云端后，可与七牛智能多媒体服务等产品集成，快速构建智能视频监控服务。qvs以公有云PaaS服务为立足点，同时也支持`本地化/私有云/专有云`部署。
# **产品能力**
### **视频接入管理**
支持RTMP推流、GB/T28181, RTSP, HLS, Http-
Flv,RTMP拉流等标准协议的摄像头、NVR、智能硬件设备、视频监控平台的接入与管理。
### **视频实时分发播放**
视频流接入QVS后，可以实现三种标准播放协议 RTMP、HLS、HTTP-FLV, WEBRTC实时播放，并具备视频CDN全网加速,负载均衡和超低延迟能力。
### **流式存储与录制**
云端高可靠持久化存储与生命周期管理，可实现流式存储，视频录制、管理、快速回看，内容全网高质量分发。
### **平台开放融合**
丰富的功能以及OpenAPI ，可与智能多媒体等产品集成，覆盖更多的AI应用场景。
# **使用方式**
视频监控产品可以将摄像头、网络存储平台（NVR）、视频监控管理平台和有摄像推拉流功能的设备接入视频管理云平台。详细使用方法可查看[**快速入门**
__](https://developer.qiniu.com/qvs/6763/qvs-quick-start)和[**使用指南**
__](https://developer.qiniu.com/qvs/6784/namespace-management)。
* 通过[**控制台** __](https://portal.qiniu.com/qvs)直接管理和浏览您的监控设备的监控视频流。
* 通过[**视频监控API** __](https://developer.qiniu.com/qvs/6706/summary-of-the-api)把视频监控能力与您自己的应用和服务集成。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 产品简介 >产品概述
# 产品概述
最近更新时间: 2022-05-27 18:43:54
七牛云视频监控（qvs）面向视频监控设备或监控平台提供的音视频流接入、流式存储、分发、录制回放的服务。视频流接入云端后，可与七牛智能多媒体服务等产品集成，快速构建智能视频监控服务。qvs以公有云PaaS服务为立足点，同时也支持`本地化/私有云/专有云`部署。
# **产品能力**
### **视频接入管理**
支持RTMP推流、GB/T28181, RTSP, HLS, Http-
Flv,RTMP拉流等标准协议的摄像头、NVR、智能硬件设备、视频监控平台的接入与管理。
### **视频实时分发播放**
视频流接入QVS后，可以实现三种标准播放协议 RTMP、HLS、HTTP-FLV, WEBRTC实时播放，并具备视频CDN全网加速,负载均衡和超低延迟能力。
### **流式存储与录制**
云端高可靠持久化存储与生命周期管理，可实现流式存储，视频录制、管理、快速回看，内容全网高质量分发。
### **平台开放融合**
丰富的功能以及OpenAPI ，可与智能多媒体等产品集成，覆盖更多的AI应用场景。
# **使用方式**
视频监控产品可以将摄像头、网络存储平台（NVR）、视频监控管理平台和有摄像推拉流功能的设备接入视频管理云平台。详细使用方法可查看[**快速入门**
__](https://developer.qiniu.com/qvs/6763/qvs-quick-start)和[**使用指南**
__](https://developer.qiniu.com/qvs/6784/namespace-management)。
* 通过[**控制台** __](https://portal.qiniu.com/qvs)直接管理和浏览您的监控设备的监控视频流。
* 通过[**视频监控API** __](https://developer.qiniu.com/qvs/6706/summary-of-the-api)把视频监控能力与您自己的应用和服务集成。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,263 |
功能概述 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 产品简介 >功能概述
# 功能概述
最近更新时间: 2022-01-17 17:28:11
本文主要对产品的主要功能模块进行介绍，便于您更好地理解视频监控提供的功能。
主要功能如下：
功能 | 功能描述 | 操作
---|---|---
空间管理 | 空间是一个监控业务的集合，集中对业务进行设置与管理 |
* 创建、修改、删除、启用/停用空间
* 配置视频接入的方式及协议等信息
* 国标接入按需拉流设置
* 接入域名的管理
* 绑定空间级别的录制、截图模板
* [使用状态回调服务 __](https://developer.qiniu.com/qvs/api/7341/Callback)
视频流管理 | 接入云平台的视频流的管理 |
* 创建、查询、删除、禁推/启用视频。
* 绑定录制、截图模板
* 监控实时流码率帧率信息
* 查询流状态及推流记录
* 实时预览、云端录制回放、查询视频截图
设备管理 | 通过国标GB/T28181协议进行设备注册接入管理 |
* 创建、修改、删除设备
* 启动、停止设备拉流
* 设备状态查询
* 设备级的实时预览、云端录制回放、查询视频截图
* 设备本地录像的回放
* [PTZ管理 __](https://developer.qiniu.com/qvs/manual/7406/ptz-management)
* 报警事件通知
* 语音对讲
* 获取设备地理位置信息
模板管理 | 录制、截图模板的管理 | 创建、修改、删除、查询模板
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 产品简介 >功能概述
# 功能概述
最近更新时间: 2022-01-17 17:28:11
本文主要对产品的主要功能模块进行介绍，便于您更好地理解视频监控提供的功能。
主要功能如下：
功能 | 功能描述 | 操作
---|---|---
空间管理 | 空间是一个监控业务的集合，集中对业务进行设置与管理 |
* 创建、修改、删除、启用/停用空间
* 配置视频接入的方式及协议等信息
* 国标接入按需拉流设置
* 接入域名的管理
* 绑定空间级别的录制、截图模板
* [使用状态回调服务 __](https://developer.qiniu.com/qvs/api/7341/Callback)
视频流管理 | 接入云平台的视频流的管理 |
* 创建、查询、删除、禁推/启用视频。
* 绑定录制、截图模板
* 监控实时流码率帧率信息
* 查询流状态及推流记录
* 实时预览、云端录制回放、查询视频截图
设备管理 | 通过国标GB/T28181协议进行设备注册接入管理 |
* 创建、修改、删除设备
* 启动、停止设备拉流
* 设备状态查询
* 设备级的实时预览、云端录制回放、查询视频截图
* 设备本地录像的回放
* [PTZ管理 __](https://developer.qiniu.com/qvs/manual/7406/ptz-management)
* 报警事件通知
* 语音对讲
* 获取设备地理位置信息
模板管理 | 录制、截图模板的管理 | 创建、修改、删除、查询模板
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,265 |
产品优势 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 产品简介 >产品优势
# 产品优势
最近更新时间: 2022-02-24 15:06:36
视频监控服务（qvs）采用云化架构，致力于解决摄像头监控视频快速上云的问题。
# **成本低，周期短**
* 设备接入成本低，无需集成SDK，适配主流的GB/T28181、RTMP等视频协议对接，现有设备零改造，快速完成视频监控设备上云。
* 无需投入资源和人力，减少本地建设、集成和运维。
* 云端API SDK 方便业务集成和二次开发。
# **稳定、安全、可靠**
* 广泛设备接入，提供大容量、高并发的视频连接，并发容量可达百万；服务资源弹性扩展，提供高稳定性高并发的平台能力，提供秒级的视频首开与播放延迟。
* 视频接入、播放支持鉴权，视频数据传输通道加密，云端存储与访问按照租户加密和隔离，并支持 HTTPS 安全协议，保障用户数据安全可靠接入、存储和播放。
# **按需使用**
* 流接入路数、设备接入数量、存储时间完全按需配置。
* 灵活根据业务进行资源伸缩。
# **多场景支持**
* 集视频流接入、实时视频、云端存储与回放等功能，满足不同场景下的视频监控的上云需求。
* 灵活的流处理转换机制，观看存储按需转换。
* 可与智能多媒体数据处理产品结合，实现图片处理、音视频转码、视频截图、人脸识别、人形检测等视频AI能力快速实现视频智能场景搭建。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 产品简介 >产品优势
# 产品优势
最近更新时间: 2022-02-24 15:06:36
视频监控服务（qvs）采用云化架构，致力于解决摄像头监控视频快速上云的问题。
# **成本低，周期短**
* 设备接入成本低，无需集成SDK，适配主流的GB/T28181、RTMP等视频协议对接，现有设备零改造，快速完成视频监控设备上云。
* 无需投入资源和人力，减少本地建设、集成和运维。
* 云端API SDK 方便业务集成和二次开发。
# **稳定、安全、可靠**
* 广泛设备接入，提供大容量、高并发的视频连接，并发容量可达百万；服务资源弹性扩展，提供高稳定性高并发的平台能力，提供秒级的视频首开与播放延迟。
* 视频接入、播放支持鉴权，视频数据传输通道加密，云端存储与访问按照租户加密和隔离，并支持 HTTPS 安全协议，保障用户数据安全可靠接入、存储和播放。
# **按需使用**
* 流接入路数、设备接入数量、存储时间完全按需配置。
* 灵活根据业务进行资源伸缩。
# **多场景支持**
* 集视频流接入、实时视频、云端存储与回放等功能，满足不同场景下的视频监控的上云需求。
* 灵活的流处理转换机制，观看存储按需转换。
* 可与智能多媒体数据处理产品结合，实现图片处理、音视频转码、视频截图、人脸识别、人形检测等视频AI能力快速实现视频智能场景搭建。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,267 |
计费方式 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 产品简介 >计费方式
# 计费方式
最近更新时间: 2022-12-13 16:57:42
本文主要讲述视频监控（QVS)产品的计费方式，当您使用视频监控服务后，会默认根据使用量付费。
# 计费方式
计费方式为后付费的按量计费。
按量计费：即按实际使用量 * 单价的方式计费，按计费周期统计实际用量并从账户余额中扣除实际消费金额。
具体计费价格请参见：**[视频监控价格详情 __](https://www.qiniu.com/prices/qvs)**
# 计费项说明
## **1.流量/带宽**
使用视频监控服务会产生流量费用，包括上行接入带宽或流量费，下行播放带宽或流量费。上行接入和下行播放默认使用**带宽日峰值**
计费，如购买了流量包需切换为按流量计费，否则资源包无法抵扣。**[去切换
__](https://portal.qiniu.com/financial/price?product=qvs)**
备注：
（1）上行：指设备端视频监控流接入QVS产生的带宽或流量。
（2）下行：指的是用户实时播放产生的带宽或流量。
**计费说明：**
计费说明 | 计费方式 | 计费周期
---|---|---
带宽日峰值 | 每日计算一次，每5分钟统计一个带宽数据，每日得到288个值，取其中的最大值作为计费值，乘以对应的阶梯价格，为最终结算标准。 | 按月出账，具体出账时间以系统为准
带宽月95峰值 | 在一个自然月内，取每 5 分钟有效带宽值进行降序排列，然后把带宽数值最高的 5% 的点去掉，剩下的最高带宽就是 95 带宽峰值计费值，乘以对应的阶梯价格，为最终结算标准。
以一月 30 天为例，默认均为有效取值点：每5分钟1个带宽取值点，每小时 12 个取值点，每月取值点数为 12 x 24 x 30 = 8640 个；将所有的点按带宽数值降序排列，去掉前5%的点 8640 x 5% = 432 个点，即第 433 个点为计费点。 | 按月出账，具体出账时间以系统为准
流量计费 | 按月到达阶梯计费，统计一个自然月内的流量累计值乘以对应的阶梯价格，为最终结算标准。 | 按月出账，具体出账时间以系统为准
## **2.设备管理费**
如果您使用国标GB/T28181或者ONVIF协议进行设备接入，将会产生设备管理服务费用。
**计费方式：**
设备管理费以每天接入qvs平台的国标设备的台数为计费值，乘以对应的阶梯价格，为最终结算标准。
**计费周期：**
按月出账，具体出账时间以系统为准。
备注：
（1）仅对国标或ONVIF设备计费，RTMP接入无设备管理费。
（2）设备成功注册且处于在线保活状态会被计费，与设备流是否在线无关。
（3）通过NVR接入的摄像头会按摄像头数目（通道数）收设备管理费。
**注：平台将于2021年7月1日零时起，结束设备管理费的限免活动，开始正式计费，具体计费价格请参见：[视频监控价格详情
__](https://www.qiniu.com/prices/qvs)**
## **3.录制管理费**
如果您配置应用了录制模版，监控流产生录制存储将会产生录制管理费。
**计费方式：**
录制管理费以每月监控流产生录制并发峰值路数为计费值，乘以对应的阶梯价格，为最终结算标准。
**计费周期：**
按月出账，具体出账时间以系统为准。
**注：目前录制管理费处于限免阶段，正式计费前会提前通知。**
## **4.AI分析费**
如果您配置应用了AI模版，对视频流配置AI算法进行AI分析将会产生AI调用收费。
**计费方式：**
AI分析费以每月监控流产生调用AI算法的总次数为计费值，乘以对应的阶梯价格，为最终结算标准，价格详情请见下方计费规则。
**计费周期：**
按月出账，具体出账时间以系统为准。
**计费规则：**
算法名称 | 价格（计费单位：元/千次计算） | 备注
---|---|---
安全帽检测 | 0.5 |
人脸识别 | 1 |
# **费用预估**
案例：1个720P摄像头，24小时推流，按照1Mbps推流码率基准；并有1个观众24小时观看的场景中，1天的费用预估。
以下仅仅是预估，请以实际的账单为准。可在七牛云控制台，“费用”菜单中查看实际消费。[费用清单
__](https://portal.qiniu.com/financial/overview)
费用构成 | 说明
---|---
基础服务费-流量或带宽 | 使用按带宽日峰值计费 | 上行0.31/日/1Mbps + 下行单个播放数1 * 0.7元/日/1Mbps = 1.06元/日.该项费用由七牛视频监控产品(qvs)计。[切换计费方式](https://developer.qiniu.com//portal.qiniu.com/financial/price?product=qvs)
使用按流量计费 | 1Mbps码率流量为10GB/天，上行流量0.15元/GB * 10GB + 下行单个播放1 * 0.4元/GB * 10GB = 5.5元/日.该项费用由七牛视频监控产品(qvs)计。[切换计费方式](https://developer.qiniu.com//portal.qiniu.com/financial/price?product=qvs)
基础服务费-设备管理费 | 只有空间类型为“GBT 28181”或者"ONVIF"类型，才会收取该项费用。0.05元/日/个设备。该项费用由七牛视频监控产品(qvs)计费。
增值服务费-截图计费 | 只有配置了截图模板，并生成了实际的截图文件，才会收取该项费用，截图文件存入七牛的对象存储(kodo)中。0.1 元/千次。计费周期为月，每月重置，该项费用由七牛智能多媒体产品(dora)计费。
增值服务费-存储计费 | 只有配置了录制模板，并在云端生成了实际的视频片段，才会收取该项费用；视频存储到七牛的对象存储(kodo)中，0-10 GB不收费；存储量10 GB以上时，平均0.09元/GB/月(0.003元/GB/日)，计费周期为月，每月重置；该项费用由七牛对象存储产品(kodo)计费。
增值服务费-录制转码费 | 录制模板默认的视频格式为m3u8，不收费；当录制模板的视频格式包含flv或mp4时，720P 0.0189元/分钟； 1080P 0.0324元/分钟；计费周期为月，每月重置，该项费用由七牛智能多媒体产品(dora)计费。
增值服务费-存储回看流量费 | 当需要查看历史录制的视频，并离线观看时，会产生该项费用。0-10 GB不收费，超出10GB以上，0.15 元/GB。 计费周期为月，每月重置，该项费用由七牛对象存储产品(kodo)计费。
增值服务费-AI分析费 | 当配置了AI模板，需要对视频流进行AI分析，并实际产生了基于视频流的AI分析调用，会产生该项费用。安全帽检测 0.5元/千次；人脸识别 1元/千次；计费周期为月，每月重置。
## **费用模式比较**
费用模式比较 | 说明
---|---
带宽日峰值计费 | 费用只跟摄像头的峰值码率有关，跟时长无关。也就是说在码率稳定的情况下，选择该计费模式，摄像头推流1分钟和推流24小时费用是一样的，比较适合长时间推流的场景。
流量计费 | 上行推流或者下行实时的播放，随着时间的流逝，流量越来越多，费用也越来越多。适合短时间频繁推流，观看的场景，用户可以控制自己的流量和时长，减少该计费模式下的费用。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 产品简介 >计费方式
# 计费方式
最近更新时间: 2022-12-13 16:57:42
本文主要讲述视频监控（QVS)产品的计费方式，当您使用视频监控服务后，会默认根据使用量付费。
# 计费方式
计费方式为后付费的按量计费。
按量计费：即按实际使用量 * 单价的方式计费，按计费周期统计实际用量并从账户余额中扣除实际消费金额。
具体计费价格请参见：**[视频监控价格详情 __](https://www.qiniu.com/prices/qvs)**
# 计费项说明
## **1.流量/带宽**
使用视频监控服务会产生流量费用，包括上行接入带宽或流量费，下行播放带宽或流量费。上行接入和下行播放默认使用**带宽日峰值**
计费，如购买了流量包需切换为按流量计费，否则资源包无法抵扣。**[去切换
__](https://portal.qiniu.com/financial/price?product=qvs)**
备注：
（1）上行：指设备端视频监控流接入QVS产生的带宽或流量。
（2）下行：指的是用户实时播放产生的带宽或流量。
**计费说明：**
计费说明 | 计费方式 | 计费周期
---|---|---
带宽日峰值 | 每日计算一次，每5分钟统计一个带宽数据，每日得到288个值，取其中的最大值作为计费值，乘以对应的阶梯价格，为最终结算标准。 | 按月出账，具体出账时间以系统为准
带宽月95峰值 | 在一个自然月内，取每 5 分钟有效带宽值进行降序排列，然后把带宽数值最高的 5% 的点去掉，剩下的最高带宽就是 95 带宽峰值计费值，乘以对应的阶梯价格，为最终结算标准。
以一月 30 天为例，默认均为有效取值点：每5分钟1个带宽取值点，每小时 12 个取值点，每月取值点数为 12 x 24 x 30 = 8640 个；将所有的点按带宽数值降序排列，去掉前5%的点 8640 x 5% = 432 个点，即第 433 个点为计费点。 | 按月出账，具体出账时间以系统为准
流量计费 | 按月到达阶梯计费，统计一个自然月内的流量累计值乘以对应的阶梯价格，为最终结算标准。 | 按月出账，具体出账时间以系统为准
## **2.设备管理费**
如果您使用国标GB/T28181或者ONVIF协议进行设备接入，将会产生设备管理服务费用。
**计费方式：**
设备管理费以每天接入qvs平台的国标设备的台数为计费值，乘以对应的阶梯价格，为最终结算标准。
**计费周期：**
按月出账，具体出账时间以系统为准。
备注：
（1）仅对国标或ONVIF设备计费，RTMP接入无设备管理费。
（2）设备成功注册且处于在线保活状态会被计费，与设备流是否在线无关。
（3）通过NVR接入的摄像头会按摄像头数目（通道数）收设备管理费。
**注：平台将于2021年7月1日零时起，结束设备管理费的限免活动，开始正式计费，具体计费价格请参见：[视频监控价格详情
__](https://www.qiniu.com/prices/qvs)**
## **3.录制管理费**
如果您配置应用了录制模版，监控流产生录制存储将会产生录制管理费。
**计费方式：**
录制管理费以每月监控流产生录制并发峰值路数为计费值，乘以对应的阶梯价格，为最终结算标准。
**计费周期：**
按月出账，具体出账时间以系统为准。
**注：目前录制管理费处于限免阶段，正式计费前会提前通知。**
## **4.AI分析费**
如果您配置应用了AI模版，对视频流配置AI算法进行AI分析将会产生AI调用收费。
**计费方式：**
AI分析费以每月监控流产生调用AI算法的总次数为计费值，乘以对应的阶梯价格，为最终结算标准，价格详情请见下方计费规则。
**计费周期：**
按月出账，具体出账时间以系统为准。
**计费规则：**
算法名称 | 价格（计费单位：元/千次计算） | 备注
---|---|---
安全帽检测 | 0.5 |
人脸识别 | 1 |
# **费用预估**
案例：1个720P摄像头，24小时推流，按照1Mbps推流码率基准；并有1个观众24小时观看的场景中，1天的费用预估。
以下仅仅是预估，请以实际的账单为准。可在七牛云控制台，“费用”菜单中查看实际消费。[费用清单
__](https://portal.qiniu.com/financial/overview)
费用构成 | 说明
---|---
基础服务费-流量或带宽 | 使用按带宽日峰值计费 | 上行0.31/日/1Mbps + 下行单个播放数1 * 0.7元/日/1Mbps = 1.06元/日.该项费用由七牛视频监控产品(qvs)计。[切换计费方式](https://developer.qiniu.com//portal.qiniu.com/financial/price?product=qvs)
使用按流量计费 | 1Mbps码率流量为10GB/天，上行流量0.15元/GB * 10GB + 下行单个播放1 * 0.4元/GB * 10GB = 5.5元/日.该项费用由七牛视频监控产品(qvs)计。[切换计费方式](https://developer.qiniu.com//portal.qiniu.com/financial/price?product=qvs)
基础服务费-设备管理费 | 只有空间类型为“GBT 28181”或者"ONVIF"类型，才会收取该项费用。0.05元/日/个设备。该项费用由七牛视频监控产品(qvs)计费。
增值服务费-截图计费 | 只有配置了截图模板，并生成了实际的截图文件，才会收取该项费用，截图文件存入七牛的对象存储(kodo)中。0.1 元/千次。计费周期为月，每月重置，该项费用由七牛智能多媒体产品(dora)计费。
增值服务费-存储计费 | 只有配置了录制模板，并在云端生成了实际的视频片段，才会收取该项费用；视频存储到七牛的对象存储(kodo)中，0-10 GB不收费；存储量10 GB以上时，平均0.09元/GB/月(0.003元/GB/日)，计费周期为月，每月重置；该项费用由七牛对象存储产品(kodo)计费。
增值服务费-录制转码费 | 录制模板默认的视频格式为m3u8，不收费；当录制模板的视频格式包含flv或mp4时，720P 0.0189元/分钟； 1080P 0.0324元/分钟；计费周期为月，每月重置，该项费用由七牛智能多媒体产品(dora)计费。
增值服务费-存储回看流量费 | 当需要查看历史录制的视频，并离线观看时，会产生该项费用。0-10 GB不收费，超出10GB以上，0.15 元/GB。 计费周期为月，每月重置，该项费用由七牛对象存储产品(kodo)计费。
增值服务费-AI分析费 | 当配置了AI模板，需要对视频流进行AI分析，并实际产生了基于视频流的AI分析调用，会产生该项费用。安全帽检测 0.5元/千次；人脸识别 1元/千次；计费周期为月，每月重置。
## **费用模式比较**
费用模式比较 | 说明
---|---
带宽日峰值计费 | 费用只跟摄像头的峰值码率有关，跟时长无关。也就是说在码率稳定的情况下，选择该计费模式，摄像头推流1分钟和推流24小时费用是一样的，比较适合长时间推流的场景。
流量计费 | 上行推流或者下行实时的播放，随着时间的流逝，流量越来越多，费用也越来越多。适合短时间频繁推流，观看的场景，用户可以控制自己的流量和时长，减少该计费模式下的费用。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,269 |
名词解释 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 产品简介 >名词解释
# 名词解释
最近更新时间: 2021-09-02 14:43:41
名称 | 解释
---|---
IPC | IPC是网络摄像机（Internet Protocol Camera）的缩写。
NVR | NVR是网络硬盘录像机（Network Video Recorder）的缩写。
RTMP | RTMP是Real Time Messaging Protocol（实时消息传输协议）的首字母缩写。该协议基于TCP，是一个协议族，包括RTMP基本协议及RTMPT/RTMPS/RTMPE等多种变种。RTMP是一种设计用来进行实时数据通信的网络协议，主要用来在Flash/AIR平台和支持RTMP协议的流媒体/交互服务器之间进行音视频和数据通信。
GB/T28181 | GB/T28181《安全防范视频监控联网系统信息传输、交换、控制技术要求》是由公安部科技信息化局提出，由全国安全防范报警系统标准化技术委员会、公安部一所等多家单位共同起草的一部国家标准。标准规定了城市监控报警联网系统中信息传输、交换、控制的互联结构、通信协议结构，传输、交换、控制的基本要求和安全性要求，以及控制、传输流程和协议接口等技术要求。该标准适用于安全防范监控报警联网系统的方案设计、系统检测、验收以及与之相关的设备研发、生产，其他信息系统可参考采用。联网系统应对前端设备、监控中心设备、用户终端ID进行统一编码,该编码具有全局唯一性。
HLS | HLS (HTTP Live Streaming)是Apple的动态码率自适应技术。主要用于PC和Apple终端的音视频服务。包括一个m3u8的索引文件，TS媒体分片文件和key加密串文件。
TS | TS的全称则是Transport Stream，TS流文件，是一种DVD的文件格式，MPEG2-TS格式的特点就是要求从视频流的任一片段开始都是可以独立解码的。
FLV | FLV 是FLASH VIDEO的简称，FLV流媒体格式是随着Flash MX的推出发展而来的视频格式。由于它形成的文件极小、加载速度极快，使得网络观看视频文件成为可能，它的出现有效地解决了视频文件导入Flash后，使导出的SWF文件体积庞大，不能在网络上很好的使用等问题。
QVS | QVS是七牛视频监控的缩写,全称为Qiniu Video Surveillance。
流 | QVS是面向音视频流的paas平台，每一个流都有自己的一个id，在同空间下是唯一的。1>设备采用rmtp推流接入的情况下，流id是可以自助添加或自动创建(在推流成功的情况下,会自动产生,推流地址rtmp://xxx/{客户在qvs创建的空间id}/{流id}). 2> 设备以GB28181接入时,流id分为两种情况 1.当接入的设备类型是摄像头,流id等同于设备id;当设备类型为平台类型(网络录像机NVR),流id=nvr的设备id_视频通道id,例31011500991180003166_34020000001310000002. 无论是采用哪种协议接入,都可以通过点击控制台界面中"视频流管理"中查看流的信息，该界面反馈的是音视频流媒体的状态。"设备管理"选项卡是接入类型为GB28181专有的界面,反馈的是GB28181设备与平台之间的信令通道状态,即设备状态。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 产品简介 >名词解释
# 名词解释
最近更新时间: 2021-09-02 14:43:41
名称 | 解释
---|---
IPC | IPC是网络摄像机（Internet Protocol Camera）的缩写。
NVR | NVR是网络硬盘录像机（Network Video Recorder）的缩写。
RTMP | RTMP是Real Time Messaging Protocol（实时消息传输协议）的首字母缩写。该协议基于TCP，是一个协议族，包括RTMP基本协议及RTMPT/RTMPS/RTMPE等多种变种。RTMP是一种设计用来进行实时数据通信的网络协议，主要用来在Flash/AIR平台和支持RTMP协议的流媒体/交互服务器之间进行音视频和数据通信。
GB/T28181 | GB/T28181《安全防范视频监控联网系统信息传输、交换、控制技术要求》是由公安部科技信息化局提出，由全国安全防范报警系统标准化技术委员会、公安部一所等多家单位共同起草的一部国家标准。标准规定了城市监控报警联网系统中信息传输、交换、控制的互联结构、通信协议结构，传输、交换、控制的基本要求和安全性要求，以及控制、传输流程和协议接口等技术要求。该标准适用于安全防范监控报警联网系统的方案设计、系统检测、验收以及与之相关的设备研发、生产，其他信息系统可参考采用。联网系统应对前端设备、监控中心设备、用户终端ID进行统一编码,该编码具有全局唯一性。
HLS | HLS (HTTP Live Streaming)是Apple的动态码率自适应技术。主要用于PC和Apple终端的音视频服务。包括一个m3u8的索引文件，TS媒体分片文件和key加密串文件。
TS | TS的全称则是Transport Stream，TS流文件，是一种DVD的文件格式，MPEG2-TS格式的特点就是要求从视频流的任一片段开始都是可以独立解码的。
FLV | FLV 是FLASH VIDEO的简称，FLV流媒体格式是随着Flash MX的推出发展而来的视频格式。由于它形成的文件极小、加载速度极快，使得网络观看视频文件成为可能，它的出现有效地解决了视频文件导入Flash后，使导出的SWF文件体积庞大，不能在网络上很好的使用等问题。
QVS | QVS是七牛视频监控的缩写,全称为Qiniu Video Surveillance。
流 | QVS是面向音视频流的paas平台，每一个流都有自己的一个id，在同空间下是唯一的。1>设备采用rmtp推流接入的情况下，流id是可以自助添加或自动创建(在推流成功的情况下,会自动产生,推流地址rtmp://xxx/{客户在qvs创建的空间id}/{流id}). 2> 设备以GB28181接入时,流id分为两种情况 1.当接入的设备类型是摄像头,流id等同于设备id;当设备类型为平台类型(网络录像机NVR),流id=nvr的设备id_视频通道id,例31011500991180003166_34020000001310000002. 无论是采用哪种协议接入,都可以通过点击控制台界面中"视频流管理"中查看流的信息，该界面反馈的是音视频流媒体的状态。"设备管理"选项卡是接入类型为GB28181专有的界面,反馈的是GB28181设备与平台之间的信令通道状态,即设备状态。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,275 |
快速入门 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 快速入门
# 快速入门
最近更新时间: 2022-11-28 17:12:38
本篇文档，阐述如何将摄像头,网络录像机,或者下级监控平台上云。
# **接入准备**
**注册七牛开发者平台**
若尚无七牛开发者平台账号，需要先进行注册；访问[七牛官网 __](https://www.qiniu.com/)，点击右上角的[注册
__](https://portal.qiniu.com/signup)，进行七牛帐号注册。
**直播域名**
在qvs创建空间时，如果选择`静态地址`模式，则需准备好备案过的域名，详情请参见 [ICP 备案
__](https://developer.qiniu.com/fusion/kb/6000/the-icp-registration-
process)，如果选择`动态地址`模式，则不用域名即可快速体验本产品，两种模式的区别见下文。
**开通存储服务**
如果需要对实时视频流进行录制或者截图，用于点播回看等, 则需要先在七牛`云存储`服务中创建存储bucket,否则跳过本步骤。详情请参照[创建存储空间
__](https://developer.qiniu.com/kodo/manual/1233/console-quickstart#step1)
# **使用流程**
* 步骤一：创建空间
* 步骤二：设备接入
* RTMP主动推流接入
* GB/T 28181接入
* `主动拉流`(rtsp/hls/flv/rtmp主动拉流)接入
* ONVIF接入
* 步骤三：实时预览、云端录制回放、查看截图
## **步骤一：创建空间**
**操作说明：**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**空间管理** ，[创建空间
__](https://developer.qiniu.io/qvs/manual/6784/namespace-
management#1)，完成空间配置。注：创建空间时的模式选择,`动态地址和静态地址的区别`
模式 | 说明
---|---
静态地址 | 通过配置域名的方式接入, 默认情况下`地址是固定的`,[流地址格式 __](https://developer.qiniu.com/qvs/6740/obtain-flow-address)
1.`必须`为域名配置cname解析,[如何配置cname?__](https://developer.qiniu.com/qvs/8746/configure-
cname)
2.`如果`在`https`环境播放, 则`必须`配置https
ssl证书。[如何配置https证书?__](https://developer.qiniu.com/qvs/6925/qvs-https-
configuration)
3.看不到域名配置管理入口或者流地址ip不固定? 因为新建空间时,`模式`选择了动态地址,重建一个新空间，选择`静态地址`即可。
动态地址 | 无需配置域名，流地址全部为IP形式，需通过API获取实时的流地址。
适用场景：
1.测试阶段，快速验证。
2.不想配置域名，能接受流地址通过API获取。
3\. 只能用在http的播放环境。如果是`https`环境,必须新建空间,模式选择`静态地址`
**动态地址`不支持https`环境中播放, IP`不能`固定，必须通过[API
__](https://developer.qiniu.com/qvs/6801/dynamic-model)获取最新流地址**
3.如果创建空间时，选择`静态地址`（直播域名）的接入模式，需要进入[域名管理
__](https://developer.qiniu.io/qvs/manual/6784/namespace-
management#2)完成域名的解析配置。[如何CNAME解析配置
__](https://developer.qiniu.com/qvs/8746/configure-cname)。如果空间模式为`动态地址`可跳过此步。
4.如果需要对监控视频流进行录制或者截图，需要先创建 [录制模板
__](https://developer.qiniu.io/qvs/manual/6789/recording-the-template)、[截图模板
__](https://developer.qiniu.io/qvs/manual/6790/screenshot-of-the-
template)，然后绑定到对应的空间或流。
## **步骤二：设备接入**
### **（1）RTMP接入**
**获取推拉流地址**
* 方式一：
完成空间的配置后，进入流管理模块，进行[添加流 __](https://developer.qiniu.com/qvs/api/6734/create-
flow)操作，创建完成之后点击【实时预览】查询推拉流地址。
* 方式二：
完成空间的配置后，可以通过portal中的**辅助工具** 生成推流地址进行测试。
**设备端配置**
设备端推流地址配置可参考[设备端配置说明 __](https://developer.qiniu.com/qvs/7452/rtmp-access-
process)。
### **（2）GB/T 28181接入**
**创建设备**
完成空间配置后，进入设备管理模块，进行[添加设备
__](https://developer.qiniu.io/qvs/manual/7026/equipment-control#1)操作。
**获取设备国标接入信息**
设备列表中检索出需要接入的设备，点击**查看** ，获取设备国标接入信息。
**设备端配置**
设备端接入配置可参考[设备端配置说明 __](https://developer.qiniu.com/qvs/7448/gb-access-
process)。
### **（3）主动拉流接入**
1. 第一步
2. 第二步
### **（4）ONVIF接入**
注意：`onvif接入要求设备有公网ip(内网设备可以使用内网映射工具，比如花生壳)`
1. 在摄像头web页面添加onvif用户名密码。
2. 在七牛控制台创建onvif设备。输入设备的`公网ip`和添加的onvif用户名密码。
## **步骤三：实时预览、云端录制回放、查看截图**
选择**视频流管理** ，找到对应的流名，可以进行[实时预览
__](https://developer.qiniu.io/qvs/manual/6785/video-streaming-
management#2)、查询流状态、[云端录制回放
__](https://developer.qiniu.io/qvs/manual/6785/video-streaming-
management#3)、查询[视频截图 __](https://developer.qiniu.io/qvs/manual/6785/video-
streaming-management#4)等操作。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 快速入门
# 快速入门
最近更新时间: 2022-11-28 17:12:38
本篇文档，阐述如何将摄像头,网络录像机,或者下级监控平台上云。
# **接入准备**
**注册七牛开发者平台**
若尚无七牛开发者平台账号，需要先进行注册；访问[七牛官网 __](https://www.qiniu.com/)，点击右上角的[注册
__](https://portal.qiniu.com/signup)，进行七牛帐号注册。
**直播域名**
在qvs创建空间时，如果选择`静态地址`模式，则需准备好备案过的域名，详情请参见 [ICP 备案
__](https://developer.qiniu.com/fusion/kb/6000/the-icp-registration-
process)，如果选择`动态地址`模式，则不用域名即可快速体验本产品，两种模式的区别见下文。
**开通存储服务**
如果需要对实时视频流进行录制或者截图，用于点播回看等, 则需要先在七牛`云存储`服务中创建存储bucket,否则跳过本步骤。详情请参照[创建存储空间
__](https://developer.qiniu.com/kodo/manual/1233/console-quickstart#step1)
# **使用流程**
* 步骤一：创建空间
* 步骤二：设备接入
* RTMP主动推流接入
* GB/T 28181接入
* `主动拉流`(rtsp/hls/flv/rtmp主动拉流)接入
* ONVIF接入
* 步骤三：实时预览、云端录制回放、查看截图
## **步骤一：创建空间**
**操作说明：**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**空间管理** ，[创建空间
__](https://developer.qiniu.io/qvs/manual/6784/namespace-
management#1)，完成空间配置。注：创建空间时的模式选择,`动态地址和静态地址的区别`
模式 | 说明
---|---
静态地址 | 通过配置域名的方式接入, 默认情况下`地址是固定的`,[流地址格式 __](https://developer.qiniu.com/qvs/6740/obtain-flow-address)
1.`必须`为域名配置cname解析,[如何配置cname?__](https://developer.qiniu.com/qvs/8746/configure-
cname)
2.`如果`在`https`环境播放, 则`必须`配置https
ssl证书。[如何配置https证书?__](https://developer.qiniu.com/qvs/6925/qvs-https-
configuration)
3.看不到域名配置管理入口或者流地址ip不固定? 因为新建空间时,`模式`选择了动态地址,重建一个新空间，选择`静态地址`即可。
动态地址 | 无需配置域名，流地址全部为IP形式，需通过API获取实时的流地址。
适用场景：
1.测试阶段，快速验证。
2.不想配置域名，能接受流地址通过API获取。
3\. 只能用在http的播放环境。如果是`https`环境,必须新建空间,模式选择`静态地址`
**动态地址`不支持https`环境中播放, IP`不能`固定，必须通过[API
__](https://developer.qiniu.com/qvs/6801/dynamic-model)获取最新流地址**
3.如果创建空间时，选择`静态地址`（直播域名）的接入模式，需要进入[域名管理
__](https://developer.qiniu.io/qvs/manual/6784/namespace-
management#2)完成域名的解析配置。[如何CNAME解析配置
__](https://developer.qiniu.com/qvs/8746/configure-cname)。如果空间模式为`动态地址`可跳过此步。
4.如果需要对监控视频流进行录制或者截图，需要先创建 [录制模板
__](https://developer.qiniu.io/qvs/manual/6789/recording-the-template)、[截图模板
__](https://developer.qiniu.io/qvs/manual/6790/screenshot-of-the-
template)，然后绑定到对应的空间或流。
## **步骤二：设备接入**
### **（1）RTMP接入**
**获取推拉流地址**
* 方式一：
完成空间的配置后，进入流管理模块，进行[添加流 __](https://developer.qiniu.com/qvs/api/6734/create-
flow)操作，创建完成之后点击【实时预览】查询推拉流地址。
* 方式二：
完成空间的配置后，可以通过portal中的**辅助工具** 生成推流地址进行测试。
**设备端配置**
设备端推流地址配置可参考[设备端配置说明 __](https://developer.qiniu.com/qvs/7452/rtmp-access-
process)。
### **（2）GB/T 28181接入**
**创建设备**
完成空间配置后，进入设备管理模块，进行[添加设备
__](https://developer.qiniu.io/qvs/manual/7026/equipment-control#1)操作。
**获取设备国标接入信息**
设备列表中检索出需要接入的设备，点击**查看** ，获取设备国标接入信息。
**设备端配置**
设备端接入配置可参考[设备端配置说明 __](https://developer.qiniu.com/qvs/7448/gb-access-
process)。
### **（3）主动拉流接入**
1. 第一步
2. 第二步
### **（4）ONVIF接入**
注意：`onvif接入要求设备有公网ip(内网设备可以使用内网映射工具，比如花生壳)`
1. 在摄像头web页面添加onvif用户名密码。
2. 在七牛控制台创建onvif设备。输入设备的`公网ip`和添加的onvif用户名密码。
## **步骤三：实时预览、云端录制回放、查看截图**
选择**视频流管理** ，找到对应的流名，可以进行[实时预览
__](https://developer.qiniu.io/qvs/manual/6785/video-streaming-
management#2)、查询流状态、[云端录制回放
__](https://developer.qiniu.io/qvs/manual/6785/video-streaming-
management#3)、查询[视频截图 __](https://developer.qiniu.io/qvs/manual/6785/video-
streaming-management#4)等操作。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,278 |
空间管理 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 使用指南 >空间管理
# 空间管理
最近更新时间: 2022-12-13 10:49:38
空间是一个视频监控业务的集合，集中对业务进行设置与管理。在使用七牛云视频监控产品前需要先创建一个空间。
# **创建空间**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**空间管理** ，进入空间管理页面，选择**创建空间** 。
3.进入创建空间配置页面后开始设置空间配置信息。
**配置项说明**
配置项 | 说明
---|---
空间名称 | 空间名称uid下唯一，名称格式为 1 ~ 100 个字符，可包含小写字母、数字、中划线。
描述 | 可以添加一些对空间的描述信息。
服务区域 | 请选择服务区域，此空间下使用的视频录制、截图模板中设置的存储bucket的区域需要保持一致，创建后不可修改。
接入类型 | RTMP推流接入
GB/T28181协议接入
主动拉流（RTSP拉流、RTMP拉流、FLV拉流、HLS拉流）接入
ONVIF协议接入
模式 | 静态模式：通过域名生成对应的推拉流地址接入qvs服务进行存储、分发。
动态模式：通过API动态获取推拉流地址进行接入存储、分发。
域名 | 静态模式下需要输入域名，域名需要在中国大陆地区完成 ICP 备案和公安部备案。
按需拉流 | 国标或主动拉流接入支持开启“按需拉流”配置，开启后，当有播放请求时才进行拉流操作，播放结束后60秒自动停止拉流。
**特别提示：**
_如果启动按需拉流，而绑定的模板是**非按需** 类型的模版，此时只要流在线，就会进行录制、截图。
如果是按需录制，按需截图的场景，请配置按需录制和按需截图模板。_
回调地址 | 添加您的后台服务器回调URL，可实时接收设备在线/离线状态、流启/停状态、视频录制/截图成功的反馈信息。[回调格式 __](https://developer.qiniu.com/qvs/10240/the-message-callback)
# **空间管理**
### **操作说明**
1.空间创建完成后，可在空间管理页面中，点击**配置** ，查看空间详细配置信息。
2.空间基本信息中点击**编辑** 可以修改空间的基本信息。
**配置项说明**
配置项 | 说明
---|---
空间名称 | 空间名称uid下唯一，名称格式为 1 ~ 100 个字符，可包含小写字母、数字、中划线。
描述 | 可以添加一些对空间的描述信息。
HLS低延时 | 开启 HLS 低延迟，可以极大降低首开时间和延迟，适合对延迟敏感的用户。
按需拉流 | 国标或主动拉流接入支持开启“按需拉流”配置，开启后，当有播放时启动时才开始拉流，播放结束后60秒自动停止拉流。
回调地址 | 添加您的后台服务器回调URL，可实时接收设备在线/离线状态、流启/停状态、视频录制/截图成功的反馈信息。[回调格式 __](https://developer.qiniu.com/qvs/10240/the-message-callback)
3.在空间管理页面中，可对空间进行停用、删除和启用操作。
# **域名管理**
### **操作说明**
1.**空间管理** 中，点击**配置** ，进入空间配置页面。
2.选择**域名管理** ，进入域名管理页面。
3.在**域名管理** 页面中可以进行添加、删除、配置域名相关操作，查询域名对应的CNAME信息。
**域名配置**
域名列表中点击**配置** 可以对域名进行相关配置。
进入域名配置页面后可以配置时间戳防盗链，点击**修改** 进行配置页面。
开启时间防盗链开关，设置key即可，可自动生成亦可手动输入。
**注：** 开启时间防盗链后URL中的鉴权参数如何构造，请参考[时间防盗链token签算说明
__](https://developer.qiniu.io/qvs/kb/6819/preventing-hotlinking)
# **模板配置**
### **操作说明**
1.**空间管理** 中，点击**配置** ，进入空间配置页面。
2.选择**模板配置** ，进入模板配置页面。
3.在**模板配置** 页面中，点击**编辑** 按钮，进入模板配置页面。
4.选择需要绑定的模板即可，还可同时选择是否应用到所有流，如果选择那么此变更将对所有流生效。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 使用指南 >空间管理
# 空间管理
最近更新时间: 2022-12-13 10:49:38
空间是一个视频监控业务的集合，集中对业务进行设置与管理。在使用七牛云视频监控产品前需要先创建一个空间。
# **创建空间**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**空间管理** ，进入空间管理页面，选择**创建空间** 。
3.进入创建空间配置页面后开始设置空间配置信息。
**配置项说明**
配置项 | 说明
---|---
空间名称 | 空间名称uid下唯一，名称格式为 1 ~ 100 个字符，可包含小写字母、数字、中划线。
描述 | 可以添加一些对空间的描述信息。
服务区域 | 请选择服务区域，此空间下使用的视频录制、截图模板中设置的存储bucket的区域需要保持一致，创建后不可修改。
接入类型 | RTMP推流接入
GB/T28181协议接入
主动拉流（RTSP拉流、RTMP拉流、FLV拉流、HLS拉流）接入
ONVIF协议接入
模式 | 静态模式：通过域名生成对应的推拉流地址接入qvs服务进行存储、分发。
动态模式：通过API动态获取推拉流地址进行接入存储、分发。
域名 | 静态模式下需要输入域名，域名需要在中国大陆地区完成 ICP 备案和公安部备案。
按需拉流 | 国标或主动拉流接入支持开启“按需拉流”配置，开启后，当有播放请求时才进行拉流操作，播放结束后60秒自动停止拉流。
**特别提示：**
_如果启动按需拉流，而绑定的模板是**非按需** 类型的模版，此时只要流在线，就会进行录制、截图。
如果是按需录制，按需截图的场景，请配置按需录制和按需截图模板。_
回调地址 | 添加您的后台服务器回调URL，可实时接收设备在线/离线状态、流启/停状态、视频录制/截图成功的反馈信息。[回调格式 __](https://developer.qiniu.com/qvs/10240/the-message-callback)
# **空间管理**
### **操作说明**
1.空间创建完成后，可在空间管理页面中，点击**配置** ，查看空间详细配置信息。
2.空间基本信息中点击**编辑** 可以修改空间的基本信息。
**配置项说明**
配置项 | 说明
---|---
空间名称 | 空间名称uid下唯一，名称格式为 1 ~ 100 个字符，可包含小写字母、数字、中划线。
描述 | 可以添加一些对空间的描述信息。
HLS低延时 | 开启 HLS 低延迟，可以极大降低首开时间和延迟，适合对延迟敏感的用户。
按需拉流 | 国标或主动拉流接入支持开启“按需拉流”配置，开启后，当有播放时启动时才开始拉流，播放结束后60秒自动停止拉流。
回调地址 | 添加您的后台服务器回调URL，可实时接收设备在线/离线状态、流启/停状态、视频录制/截图成功的反馈信息。[回调格式 __](https://developer.qiniu.com/qvs/10240/the-message-callback)
3.在空间管理页面中，可对空间进行停用、删除和启用操作。
# **域名管理**
### **操作说明**
1.**空间管理** 中，点击**配置** ，进入空间配置页面。
2.选择**域名管理** ，进入域名管理页面。
3.在**域名管理** 页面中可以进行添加、删除、配置域名相关操作，查询域名对应的CNAME信息。
**域名配置**
域名列表中点击**配置** 可以对域名进行相关配置。
进入域名配置页面后可以配置时间戳防盗链，点击**修改** 进行配置页面。
开启时间防盗链开关，设置key即可，可自动生成亦可手动输入。
**注：** 开启时间防盗链后URL中的鉴权参数如何构造，请参考[时间防盗链token签算说明
__](https://developer.qiniu.io/qvs/kb/6819/preventing-hotlinking)
# **模板配置**
### **操作说明**
1.**空间管理** 中，点击**配置** ，进入空间配置页面。
2.选择**模板配置** ，进入模板配置页面。
3.在**模板配置** 页面中，点击**编辑** 按钮，进入模板配置页面。
4.选择需要绑定的模板即可，还可同时选择是否应用到所有流，如果选择那么此变更将对所有流生效。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,285 |
视频流管理 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 使用指南 >视频流管理
# 视频流管理
最近更新时间: 2022-02-24 15:07:33
视频流管理主要是针对接入云平台的视频流进行管理，查询流状态等信息，同时支持实时预览、云端录制回放、截图查询等功能。
# **流管理**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**视频流管理**
，进入视频流管理页面。可以查询指定空间下的流数量、在线流数量、禁用流数量，管理视频流，对指定流进行禁用/启用、绑定模板相关操作。
3.添加流
**RTMP推流模式下添加流**
RTMP推流模式下的空间点击**添加流**
，进行创建视频流的操作，选择静态接入时，可以直接在推流地址中指定流名，如：rtmp://域名:2045/空间ID/流名，视频流接入平台后系统会自动添加。
配置项 | 说明
---|---
流名称 | 流名称在空间中唯一，可包含 字母、数字、中划线、下划线；1 ~ 100 个字符长；创建后将不可修改
描述 | 可以添加关于视频流的描述信息
**主动拉流模式下添加流**
主动拉流模式下的空间点击**添加流** ，进行创建视频流的操作。
添加RTSP拉流：
配置项 | 说明
---|---
流名称 | 流名称在空间中唯一，可包含 字母、数字、中划线、下划线；1 ~ 100 个字符长；创建后将不可修改
接入方式 | 选择RTSP
拉流地址 | 输入可以在公网上进行拉流的RTSP地址
传输协议 | 选择视频的传输协议，默认为UDP
描述 | 可以添加关于视频流的描述信息
添加RTMP拉流、FLV拉流、HLS拉流
配置项 | 说明
---|---
流名称 | 流名称在空间中唯一，可包含 字母、数字、中划线、下划线；1 ~ 100 个字符长；创建后将不可修改
接入方式 | 可以选择RTMP拉流、FLV拉流或者HLS拉流
拉流地址 | 输入对应接入方式的可以在公网上进行拉流的地址
视频源 | 选择拉流地址对应的视频源是直播或点播
描述 | 可以添加关于视频流的描述信息
**注：通过国标接入时无需进行添加流操作**
4.编辑流
点击**管理** 进入流详情页面，选择基本信息，点击**编辑** 可以对流进行绑定模板和修改描述信息相关操作。
# **实时预览**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**视频流管理** ，进入视频流管理页面，查询指定空间下的视频流。
3.选择指定的视频流点击快捷入口**实时观看** 进入实时观看页面，进行视频流的实时预览。
# **云端录制回放**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**视频流管理** ，进入视频流管理页面，查询指定空间下的视频流。
3.选择指定的视频流点击快捷入口**云端录制回放** 进入云端录制回放页面，查询录制的视频片段。
点击**播放** 可以预览该片段。
# **视频截图**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**视频流管理** ，进入视频流管理页面，查询指定空间下的视频流。
3.选择指定的视频流，点击**管理** 进入视频流详情页
4.选择视频截图模块，查询视频截图信息
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 使用指南 >视频流管理
# 视频流管理
最近更新时间: 2022-02-24 15:07:33
视频流管理主要是针对接入云平台的视频流进行管理，查询流状态等信息，同时支持实时预览、云端录制回放、截图查询等功能。
# **流管理**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**视频流管理**
，进入视频流管理页面。可以查询指定空间下的流数量、在线流数量、禁用流数量，管理视频流，对指定流进行禁用/启用、绑定模板相关操作。
3.添加流
**RTMP推流模式下添加流**
RTMP推流模式下的空间点击**添加流**
，进行创建视频流的操作，选择静态接入时，可以直接在推流地址中指定流名，如：rtmp://域名:2045/空间ID/流名，视频流接入平台后系统会自动添加。
配置项 | 说明
---|---
流名称 | 流名称在空间中唯一，可包含 字母、数字、中划线、下划线；1 ~ 100 个字符长；创建后将不可修改
描述 | 可以添加关于视频流的描述信息
**主动拉流模式下添加流**
主动拉流模式下的空间点击**添加流** ，进行创建视频流的操作。
添加RTSP拉流：
配置项 | 说明
---|---
流名称 | 流名称在空间中唯一，可包含 字母、数字、中划线、下划线；1 ~ 100 个字符长；创建后将不可修改
接入方式 | 选择RTSP
拉流地址 | 输入可以在公网上进行拉流的RTSP地址
传输协议 | 选择视频的传输协议，默认为UDP
描述 | 可以添加关于视频流的描述信息
添加RTMP拉流、FLV拉流、HLS拉流
配置项 | 说明
---|---
流名称 | 流名称在空间中唯一，可包含 字母、数字、中划线、下划线；1 ~ 100 个字符长；创建后将不可修改
接入方式 | 可以选择RTMP拉流、FLV拉流或者HLS拉流
拉流地址 | 输入对应接入方式的可以在公网上进行拉流的地址
视频源 | 选择拉流地址对应的视频源是直播或点播
描述 | 可以添加关于视频流的描述信息
**注：通过国标接入时无需进行添加流操作**
4.编辑流
点击**管理** 进入流详情页面，选择基本信息，点击**编辑** 可以对流进行绑定模板和修改描述信息相关操作。
# **实时预览**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**视频流管理** ，进入视频流管理页面，查询指定空间下的视频流。
3.选择指定的视频流点击快捷入口**实时观看** 进入实时观看页面，进行视频流的实时预览。
# **云端录制回放**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**视频流管理** ，进入视频流管理页面，查询指定空间下的视频流。
3.选择指定的视频流点击快捷入口**云端录制回放** 进入云端录制回放页面，查询录制的视频片段。
点击**播放** 可以预览该片段。
# **视频截图**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**视频流管理** ，进入视频流管理页面，查询指定空间下的视频流。
3.选择指定的视频流，点击**管理** 进入视频流详情页
4.选择视频截图模块，查询视频截图信息
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,290 |
设备管理 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 使用指南 >设备管理
# 设备管理
最近更新时间: 2021-11-24 15:02:50
设备管理主要是用于通过国标GB/T28181协议接入设备的管理，可以添加、删除设备，进行设备状态查询，设置设备的启停拉流、实时预览、录制回放、截图查询等。
# **添加设备**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**设备管理** ，进入设备管理页面，选择**添加设备** 。
3.进入添加设备配置页面后开始设置设备配置信息。
**配置项说明**
配置项 | 说明
---|---
类型 | 接入设备的类型，可选项为摄像头和平台两种类型；NVR、视频监控平台接入时选择平台类型
设备名称 | 接入设备的设备名称
设备国标ID | 设置设备的国标ID，需要遵循[国标ID的命名规则 __](https://developer.qiniu.io/qvs/kb/7027/gb-id-naming-conventions)
手动输入：用户自定义输入国标ID
自动生成：选择自动生成系统将为设备自动分配一个国标ID
用户名 | 设备接入的用户名，4~40位，可包含大写字母、小写字母、数字、中划线；因部分摄像头注册时默认使用设备国标ID作为用户名不支持自定义配置，故此时平台中创建的对应的设备的用户名配置项需要与设备国标ID一致
密码 | 设备接入的密码，4~40位，可包含大写字母、小写字母、数字、中划线
注册成功后启动拉流 | 设备注册成功后是否启动设备拉流，默认为关闭
报警事件通知 | 是否开启国标报警时间通知及设置报警类型，开启设备端产生报警信息后将进行消息上报，可进行查阅，默认为关闭
描述 | 支持汉字、字母、数字、中划线、下划线均可输入，最大200个字符
# **批量添加设备**
### **操作说明**
1.设备列表中点击**批量添加设备** 进行批量添加操作。
**配置项说明**
配置项 | 说明
---|---
批次名称 | 批量创建设备的批次名称
添加方式 | 自动生成：设备国标ID、用户名、密码将自动生成
批量上传：用户自定义输入国标ID、用户名、密码等信息（开发中···敬请期待）
摄像头设备数量 | 自动生成时需要输入此项，需要批量创建摄像头类型的设备数量
平台设备数量 | 自动生成时需要输入此项，需要批量创建平台类型的设备数量
注册成功后启动拉流 | 自动生成时需要输入此项，设备注册成功后是否启动设备拉流，默认为关闭
报警事件通知 | 自动生成时需要输入此项，是否开启国标报警时间通知及设置报警类型，默认为关闭
**批次列表**
通过批次列表查询批量创建设备的记录，支持批次信息的导出和删除操作，删除批次后将删除该批次下所有的设备。
# **查看、编辑设备信息**
### **操作说明**
1.设备列表中选择要查看的设备，点击**查看** 查询设备的基本信息，如下图所示：
2.点击**编辑** 可以编辑设备的基本信息
**可编辑参数说明**
配置项 | 说明
---|---
设备名称 | 接入设备的设备名称
设备国标ID | 设置设备的国标ID，需要遵循[国标ID的命名规则 __](https://developer.qiniu.io/qvs/kb/7027/gb-id-naming-conventions)
手动输入：用户自定义输入国标ID
自动生成：选择自动生成系统将为设备自动分配一个国标ID
用户名 | 设备接入的用户名，4~40位，可包含大写字母、小写字母、数字、中划线；因部分摄像头注册时默认使用设备国标ID作为用户名不支持自定义配置，故此时平台中创建的对应的设备的用户名配置项需要与设备国标ID一致
密码 | 设备接入的密码，4~40位，可包含大写字母、小写字母、数字、中划线
注册成功后启动拉流 | 设备注册成功后是否启动设备拉流，默认为关闭
描述 | 支持汉字、字母、数字、中划线、下划线均可输入，最大200个字符
# **设备接入**
在QVS控制台中添加完设备之后，可以开始进行设备的接入操作，查询控制台中添加的设备的信息，将对应的信息添加到摄像头、NVR或监控平台的配置页面中，具体配置可参考[设备端配置说明
__](https://developer.qiniu.io/qvs/kb/7028/gb-
access)，配置完成后可以在控制台中设备管理模块查询对应的设备状态是否在线，在线说明接入成功。
# **实时预览、录制回放**
设备成功接入后可以实时预览设备的视频流，查询录制回放等操作。
### **操作说明**
1.设备列表中选择要查看的设备，点击**实时预览** 对设备接入的视频流进行实时预览，停止/启用拉流，查询录制回放等操作如下图所示：
**停止/启用拉流操作说明**
（1）视频流状态为在线时，可执行停止拉流操作。
（2）设备在线未启动拉流的设备，可执行启动拉流操作。
（3）设备不在线或流被禁用的状态下无法执行启动拉流操作。
# **通道列表**
类型为平台的接入设备，可以查询该设备下的通道接入的视频流，可以进行实时预览、录制回放相关操作。
### **操作说明**
1.设备列表中选择要查看的设备，点击**通道列表** 或**设备对应的通道数**
进入通道列表页面，在通道列表页面中可以对设备下的通道接入的视频流进行实时预览、查询录制回放，如下图所示：
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 使用指南 >设备管理
# 设备管理
最近更新时间: 2021-11-24 15:02:50
设备管理主要是用于通过国标GB/T28181协议接入设备的管理，可以添加、删除设备，进行设备状态查询，设置设备的启停拉流、实时预览、录制回放、截图查询等。
# **添加设备**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**设备管理** ，进入设备管理页面，选择**添加设备** 。
3.进入添加设备配置页面后开始设置设备配置信息。
**配置项说明**
配置项 | 说明
---|---
类型 | 接入设备的类型，可选项为摄像头和平台两种类型；NVR、视频监控平台接入时选择平台类型
设备名称 | 接入设备的设备名称
设备国标ID | 设置设备的国标ID，需要遵循[国标ID的命名规则 __](https://developer.qiniu.io/qvs/kb/7027/gb-id-naming-conventions)
手动输入：用户自定义输入国标ID
自动生成：选择自动生成系统将为设备自动分配一个国标ID
用户名 | 设备接入的用户名，4~40位，可包含大写字母、小写字母、数字、中划线；因部分摄像头注册时默认使用设备国标ID作为用户名不支持自定义配置，故此时平台中创建的对应的设备的用户名配置项需要与设备国标ID一致
密码 | 设备接入的密码，4~40位，可包含大写字母、小写字母、数字、中划线
注册成功后启动拉流 | 设备注册成功后是否启动设备拉流，默认为关闭
报警事件通知 | 是否开启国标报警时间通知及设置报警类型，开启设备端产生报警信息后将进行消息上报，可进行查阅，默认为关闭
描述 | 支持汉字、字母、数字、中划线、下划线均可输入，最大200个字符
# **批量添加设备**
### **操作说明**
1.设备列表中点击**批量添加设备** 进行批量添加操作。
**配置项说明**
配置项 | 说明
---|---
批次名称 | 批量创建设备的批次名称
添加方式 | 自动生成：设备国标ID、用户名、密码将自动生成
批量上传：用户自定义输入国标ID、用户名、密码等信息（开发中···敬请期待）
摄像头设备数量 | 自动生成时需要输入此项，需要批量创建摄像头类型的设备数量
平台设备数量 | 自动生成时需要输入此项，需要批量创建平台类型的设备数量
注册成功后启动拉流 | 自动生成时需要输入此项，设备注册成功后是否启动设备拉流，默认为关闭
报警事件通知 | 自动生成时需要输入此项，是否开启国标报警时间通知及设置报警类型，默认为关闭
**批次列表**
通过批次列表查询批量创建设备的记录，支持批次信息的导出和删除操作，删除批次后将删除该批次下所有的设备。
# **查看、编辑设备信息**
### **操作说明**
1.设备列表中选择要查看的设备，点击**查看** 查询设备的基本信息，如下图所示：
2.点击**编辑** 可以编辑设备的基本信息
**可编辑参数说明**
配置项 | 说明
---|---
设备名称 | 接入设备的设备名称
设备国标ID | 设置设备的国标ID，需要遵循[国标ID的命名规则 __](https://developer.qiniu.io/qvs/kb/7027/gb-id-naming-conventions)
手动输入：用户自定义输入国标ID
自动生成：选择自动生成系统将为设备自动分配一个国标ID
用户名 | 设备接入的用户名，4~40位，可包含大写字母、小写字母、数字、中划线；因部分摄像头注册时默认使用设备国标ID作为用户名不支持自定义配置，故此时平台中创建的对应的设备的用户名配置项需要与设备国标ID一致
密码 | 设备接入的密码，4~40位，可包含大写字母、小写字母、数字、中划线
注册成功后启动拉流 | 设备注册成功后是否启动设备拉流，默认为关闭
描述 | 支持汉字、字母、数字、中划线、下划线均可输入，最大200个字符
# **设备接入**
在QVS控制台中添加完设备之后，可以开始进行设备的接入操作，查询控制台中添加的设备的信息，将对应的信息添加到摄像头、NVR或监控平台的配置页面中，具体配置可参考[设备端配置说明
__](https://developer.qiniu.io/qvs/kb/7028/gb-
access)，配置完成后可以在控制台中设备管理模块查询对应的设备状态是否在线，在线说明接入成功。
# **实时预览、录制回放**
设备成功接入后可以实时预览设备的视频流，查询录制回放等操作。
### **操作说明**
1.设备列表中选择要查看的设备，点击**实时预览** 对设备接入的视频流进行实时预览，停止/启用拉流，查询录制回放等操作如下图所示：
**停止/启用拉流操作说明**
（1）视频流状态为在线时，可执行停止拉流操作。
（2）设备在线未启动拉流的设备，可执行启动拉流操作。
（3）设备不在线或流被禁用的状态下无法执行启动拉流操作。
# **通道列表**
类型为平台的接入设备，可以查询该设备下的通道接入的视频流，可以进行实时预览、录制回放相关操作。
### **操作说明**
1.设备列表中选择要查看的设备，点击**通道列表** 或**设备对应的通道数**
进入通道列表页面，在通道列表页面中可以对设备下的通道接入的视频流进行实时预览、查询录制回放，如下图所示：
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,295 |
语音对讲 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 使用指南
>[设备管理](https://developer.qiniu.com/qvs/manual/7026/equipment-control) > 语音对讲
# 语音对讲
最近更新时间: 2021-10-09 11:34:01
支持语音输出通道的视频监控设备通过国标协议接入QVS平台后，可以通过调用[语音对讲
__](https://developer.qiniu.com/qvs/8158/voice-
call)功能的API实现语音对讲功能。如果设备音频支持多种编码格式，需要将音频编码格式设置`g711a`。
# **语音对讲**
### **操作说明**
1.摄像机设置音频编码格式为`g711a`。
2.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
3.选择**视频监控** 产品，进入产品控制台，选择**设备管理** ，进入设备管理页面，设备列表中选择要查看的设备，点击**实时预览**
进入实时预览页面，可以点击语音对讲按钮，进行语音对讲功能的体验，如下图所示：
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 使用指南
>[设备管理](https://developer.qiniu.com/qvs/manual/7026/equipment-control) > 语音对讲
# 语音对讲
最近更新时间: 2021-10-09 11:34:01
支持语音输出通道的视频监控设备通过国标协议接入QVS平台后，可以通过调用[语音对讲
__](https://developer.qiniu.com/qvs/8158/voice-
call)功能的API实现语音对讲功能。如果设备音频支持多种编码格式，需要将音频编码格式设置`g711a`。
# **语音对讲**
### **操作说明**
1.摄像机设置音频编码格式为`g711a`。
2.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
3.选择**视频监控** 产品，进入产品控制台，选择**设备管理** ，进入设备管理页面，设备列表中选择要查看的设备，点击**实时预览**
进入实时预览页面，可以点击语音对讲按钮，进行语音对讲功能的体验，如下图所示：
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,301 |
本地录像回放 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 使用指南
>[设备管理](https://developer.qiniu.com/qvs/manual/7026/equipment-control) >
本地录像回放
# 本地录像回放
最近更新时间: 2021-11-30 18:02:39
通过国标接入的具备本地录像的能力的视频监控设备，QVS支持远程查询本地存储的视频文件，进行录像的回放分发并支持暂停、启动播放、倍速播放、拖拽播放相关操作。
# **本地录像回放**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**设备管理** ，进入设备管理页面，设备列表中选择要查看的设备，点击**查看**
进入设备详情页，选择**本地录像回放** 模块进行查询，如下图所示：
IPC类设备：
平台类型设备：
点击**播放** 进行本地录像的回放，支持HLS、FLV、RTMP、Webrtc协议的播放
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 使用指南
>[设备管理](https://developer.qiniu.com/qvs/manual/7026/equipment-control) >
本地录像回放
# 本地录像回放
最近更新时间: 2021-11-30 18:02:39
通过国标接入的具备本地录像的能力的视频监控设备，QVS支持远程查询本地存储的视频文件，进行录像的回放分发并支持暂停、启动播放、倍速播放、拖拽播放相关操作。
# **本地录像回放**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**设备管理** ，进入设备管理页面，设备列表中选择要查看的设备，点击**查看**
进入设备详情页，选择**本地录像回放** 模块进行查询，如下图所示：
IPC类设备：
平台类型设备：
点击**播放** 进行本地录像的回放，支持HLS、FLV、RTMP、Webrtc协议的播放
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,303 |
PTZ管理 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 使用指南
>[设备管理](https://developer.qiniu.com/qvs/manual/7026/equipment-control) > PTZ管理
# PTZ管理
最近更新时间: 2021-07-21 17:47:36
具备PTZ能力的视频监控设备通过国标协议接入QVS平台后，可以通过调用服务端对应的API进行云端的远程控制操作。
名词解释：
名称 | 解释
---|---
PTZ | 在安防监控应用中是 Pan/Tilt/Zoom 的简写，代表云台全方位（左右/上下）移动及镜头变倍、变焦控制。
步长 | 步长主要是用于控制云台转动方向的速度的调节， 调节范围1~10。
变倍（ZOOM） | 用户可以通过控制变倍参数，调整焦距的远近，得到所需的全景画面，或是近景视图。
光圈（Irish） | 光圈是用来调节摄像机画面的亮度的。
变焦（Focus） | 聚焦是调节摄像机画面中的一个物体或场景的清晰程度的过程
预置位 | 摄像机能将当前状态下云台的水平角度、倾斜角度和摄像机镜头焦距等位置参数存储到存储器中，需要时可以选择该预置位，迅速调用这些参数并将云台和摄像头调整至该位置。
# **PTZ管理**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**设备管理** ，进入设备管理页面，设备列表中选择要查看的设备，点击**实时预览**
进入实时预览页面，可以对设备进行云台全方位（左右/上下）移动及镜头变倍、变焦控制等操作如下图所示：
**预置位操作说明**
操作 | 说明
---|---
新增预置位 | 摄像机将当前状态下云台的水平角度、倾斜角度和摄像机镜头焦距等位置参数存储到存储器中记录下来
设置 | 使用该预置位，摄像头的镜头将根据预置位存储的云台的水平角度、倾斜角度和摄像机镜头焦距等位置参数，快速的切换到该位置及对应的焦距参数上
删除 | 删除此预置位，删除后将不可恢复
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 使用指南
>[设备管理](https://developer.qiniu.com/qvs/manual/7026/equipment-control) > PTZ管理
# PTZ管理
最近更新时间: 2021-07-21 17:47:36
具备PTZ能力的视频监控设备通过国标协议接入QVS平台后，可以通过调用服务端对应的API进行云端的远程控制操作。
名词解释：
名称 | 解释
---|---
PTZ | 在安防监控应用中是 Pan/Tilt/Zoom 的简写，代表云台全方位（左右/上下）移动及镜头变倍、变焦控制。
步长 | 步长主要是用于控制云台转动方向的速度的调节， 调节范围1~10。
变倍（ZOOM） | 用户可以通过控制变倍参数，调整焦距的远近，得到所需的全景画面，或是近景视图。
光圈（Irish） | 光圈是用来调节摄像机画面的亮度的。
变焦（Focus） | 聚焦是调节摄像机画面中的一个物体或场景的清晰程度的过程
预置位 | 摄像机能将当前状态下云台的水平角度、倾斜角度和摄像机镜头焦距等位置参数存储到存储器中，需要时可以选择该预置位，迅速调用这些参数并将云台和摄像头调整至该位置。
# **PTZ管理**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**设备管理** ，进入设备管理页面，设备列表中选择要查看的设备，点击**实时预览**
进入实时预览页面，可以对设备进行云台全方位（左右/上下）移动及镜头变倍、变焦控制等操作如下图所示：
**预置位操作说明**
操作 | 说明
---|---
新增预置位 | 摄像机将当前状态下云台的水平角度、倾斜角度和摄像机镜头焦距等位置参数存储到存储器中记录下来
设置 | 使用该预置位，摄像头的镜头将根据预置位存储的云台的水平角度、倾斜角度和摄像机镜头焦距等位置参数，快速的切换到该位置及对应的焦距参数上
删除 | 删除此预置位，删除后将不可恢复
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,305 |
报警事件通知 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 使用指南
>[设备管理](https://developer.qiniu.com/qvs/manual/7026/equipment-control) >
报警事件通知
# 报警事件通知
最近更新时间: 2022-07-13 11:49:56
通过国标接入的视频监控设备支持查询设备端的报警事件通知，当发生报警事件时，源设备将报警信息发送给QVS的SIP服务器；SIP服务器接收到报警事件后，将报警信息进行分发给目标设备。
# **报警事件通知**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择视频监控产品，进入产品控制台，选择**设备管理** ，进入设备管理页面，**添加设备** 或者**编辑设备** 时，可以开启**报警事件通知**
选择对应的报警方式保存配置后就可以接收设备端的报警信息了。
**注：**
开启接收国标报警后，需`确保设备端开启`了报警；为避免报警数据太多，请选择必要的报警方式；可以通过 portal 或空间配置的回调地址接收设备报警信息。
3.查询报警事件通知信息
（1）设备列表中选择要查看的设备，点击**查看** 进入设备详情页面，选择**报警事件通知** 模块查询设备报警事件信息，如下图所示：
（2）通过空间中配置的回调地址进行接收，详见[消息通知 __](https://developer.qiniu.com/qvs/10240/the-
message-callback)
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 使用指南
>[设备管理](https://developer.qiniu.com/qvs/manual/7026/equipment-control) >
报警事件通知
# 报警事件通知
最近更新时间: 2022-07-13 11:49:56
通过国标接入的视频监控设备支持查询设备端的报警事件通知，当发生报警事件时，源设备将报警信息发送给QVS的SIP服务器；SIP服务器接收到报警事件后，将报警信息进行分发给目标设备。
# **报警事件通知**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择视频监控产品，进入产品控制台，选择**设备管理** ，进入设备管理页面，**添加设备** 或者**编辑设备** 时，可以开启**报警事件通知**
选择对应的报警方式保存配置后就可以接收设备端的报警信息了。
**注：**
开启接收国标报警后，需`确保设备端开启`了报警；为避免报警数据太多，请选择必要的报警方式；可以通过 portal 或空间配置的回调地址接收设备报警信息。
3.查询报警事件通知信息
（1）设备列表中选择要查看的设备，点击**查看** 进入设备详情页面，选择**报警事件通知** 模块查询设备报警事件信息，如下图所示：
（2）通过空间中配置的回调地址进行接收，详见[消息通知 __](https://developer.qiniu.com/qvs/10240/the-
message-callback)
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,307 |
HTTPS配置 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 使用指南
>[设备管理](https://developer.qiniu.com/qvs/manual/7026/equipment-control) >
HTTPS配置
# HTTPS配置
最近更新时间: 2021-09-03 17:35:21
HTTPS 是指超文本传输安全协议（Hypertext Transfer Protocol Secure，缩写：HTTPS，常称为HTTP over
TLS，HTTP over SSL或HTTP
Secure）是一种通过计算机网络进行安全通信的传输协议。HTTPS经由HTTP进行通信，但利用SSL/TLS来加密数据包。HTTPS开发的主要目的，是提供对网站服务器的身份认证，保护交换数据的隐私与完整性。配置
HTTPS 时，需要您提供域名对应的证书，实现全网数据加密传输功能。
# **HTTPS配置**
### **操作说明**
**请注意，由于HTTPS功能需要您提供域名及对应的证书，实现全网数据加密传输功能，所以仅适用于空间模式为“静态地址”类型的空间。**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**空间管理** ，进入空间管理页面。
3.**空间管理** 中，点击**配置** ，进入空间配置页面。
4.选择**域名管理**
，进入域名管理页面，如无此模块，说明此空间为动态地址模式的空间不支持HTTPS功能，需要创建一个静态模式的空间并进行域名的解析配置后再进行以下步骤。[【新建空间及域名配置参考】
__](https://developer.qiniu.com/qvs/6784/namespace-management)
5.域名列表中HLS拉流、FLV拉流、Webrtc拉流类型的域名点击**配置** 可以对域名进行HTTPS相关配置。
6.选择HTTPS配置，点击**修改** 开始进行配置。
7.初次配置该域名时,尚无可用的证书.需要先进入[证书管理页面
__](https://portal.qiniu.com/certificate/ssl),完成对应的证书配置后，重新回到上面截图中所在的界面,刷新后可选择对应的证书,点击**保存**
完成HTTPS配置。
**说明：**
1.若无证书时, 用户可以点击【购买证书】,其中有[免费证书
__](https://developer.qiniu.com/fusion/kb/3725/how-to-apply-for-and-use-free-
certificate)只匹配单域名,也有付费证书可匹配多域名,用户可根据自身场景选择; 同时用户也可以上传自有证书。
2.配置完证书后，回到qvs的域名配置页面，如果找不到对应的证书，可以刷新一下页面，如还是找不到说明配置的证书与域名不匹配。
（1）如空间中配置的域名为qvs-live-hls.qiniu.com,那么上传的证书只能是qvs-live-
hls.qiniu.com标准域名的证书或者或者*.qiniu.com的证书。
（2）如果上传的证书为泛域名证书，例如*.qiniu.com,那么该证书只能对abc.qiniu.com、123.qiniu.com类的域名匹配生效，对于123.adc.qiniu.com类的与无法匹配。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 使用指南
>[设备管理](https://developer.qiniu.com/qvs/manual/7026/equipment-control) >
HTTPS配置
# HTTPS配置
最近更新时间: 2021-09-03 17:35:21
HTTPS 是指超文本传输安全协议（Hypertext Transfer Protocol Secure，缩写：HTTPS，常称为HTTP over
TLS，HTTP over SSL或HTTP
Secure）是一种通过计算机网络进行安全通信的传输协议。HTTPS经由HTTP进行通信，但利用SSL/TLS来加密数据包。HTTPS开发的主要目的，是提供对网站服务器的身份认证，保护交换数据的隐私与完整性。配置
HTTPS 时，需要您提供域名对应的证书，实现全网数据加密传输功能。
# **HTTPS配置**
### **操作说明**
**请注意，由于HTTPS功能需要您提供域名及对应的证书，实现全网数据加密传输功能，所以仅适用于空间模式为“静态地址”类型的空间。**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**空间管理** ，进入空间管理页面。
3.**空间管理** 中，点击**配置** ，进入空间配置页面。
4.选择**域名管理**
，进入域名管理页面，如无此模块，说明此空间为动态地址模式的空间不支持HTTPS功能，需要创建一个静态模式的空间并进行域名的解析配置后再进行以下步骤。[【新建空间及域名配置参考】
__](https://developer.qiniu.com/qvs/6784/namespace-management)
5.域名列表中HLS拉流、FLV拉流、Webrtc拉流类型的域名点击**配置** 可以对域名进行HTTPS相关配置。
6.选择HTTPS配置，点击**修改** 开始进行配置。
7.初次配置该域名时,尚无可用的证书.需要先进入[证书管理页面
__](https://portal.qiniu.com/certificate/ssl),完成对应的证书配置后，重新回到上面截图中所在的界面,刷新后可选择对应的证书,点击**保存**
完成HTTPS配置。
**说明：**
1.若无证书时, 用户可以点击【购买证书】,其中有[免费证书
__](https://developer.qiniu.com/fusion/kb/3725/how-to-apply-for-and-use-free-
certificate)只匹配单域名,也有付费证书可匹配多域名,用户可根据自身场景选择; 同时用户也可以上传自有证书。
2.配置完证书后，回到qvs的域名配置页面，如果找不到对应的证书，可以刷新一下页面，如还是找不到说明配置的证书与域名不匹配。
（1）如空间中配置的域名为qvs-live-hls.qiniu.com,那么上传的证书只能是qvs-live-
hls.qiniu.com标准域名的证书或者或者*.qiniu.com的证书。
（2）如果上传的证书为泛域名证书，例如*.qiniu.com,那么该证书只能对abc.qiniu.com、123.qiniu.com类的域名匹配生效，对于123.adc.qiniu.com类的与无法匹配。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,309 |
Ai模板 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 使用指南 >模板管理 >Ai模板
# Ai模板
最近更新时间: 2022-12-22 11:25:32
如需进行AI分析时，可按照需求场景创建对应的AI模板并进行模板的绑定操作即可。目前AI模板支持两种算法：1.安全帽检测；2.人脸识别。
# **使用说明**
1. 模版可应用于空间级别和流级别。同一个模版可以与多个空间绑定。流级别的模版优先级高于空间。
2. 模板最终生效的都在流维度上，如需AI分析功能需要先进行AI模版的创建和绑定，流接入后触发模板工作。
3. 将模板与空间或流绑定时，模板中bucket所属的存储区域需要和“视频监控”中空间的服务区域保持一致，故创建模板时需要根据模板将要作用的空间，选择与空间服务区域一致的存储区域的bucket。
# **添加模板**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**模板管理** ，进入模板管理页面，选择**AI模板** 。
3.点击**添加AI模板** ，创建新的AI模板。`需要注意的是`，如果选择了**人脸识别**
算法，需要绑定用于人脸比对的图像库。图像库需要额外创建，见步骤4。
4.点击**查看图像库** ，进入图像库列表页面，点击**创建图像库** ，
输入名称和备注后点击**确定** ，
点击**查看** 进入实体列表页面，
点击**添加实体** ，创建实体。
### **配置项说明**
**AI模板**
配置项 | 说明
---|---
模板名称 | 格式为 1 ~ 100个字符，可包含字母、数字、中划线、下划线
选择算法 | 算法可选 1:安全帽识别 2: 人脸识别；可以同时配置多种算法
截帧间隔 | 默认为1, 代表每1秒截取1帧进行AI计算。有效范围 500ms~ 3600s
置信度 | 默认 60, 有效范围是1～100
运行模式 | 全程:只要视频流在线就开始AI分析 按需: 通过API控制AI分析的开始和结束 时间段: 自定义区间段内开始AI分析
图像库 | 依赖的基础图像库ID，例如当算法为人脸识别时，需要指定一个基础的图像库，也可以新建一个基础图像库
回调结构化数据 | 是否回调ai计算结果
存储结构化数据 | 是否保存ai识别的结构化数据，默认为false。若不保存，可以通过回调的方式得到[结构化数据 __](https://developer.qiniu.com/qvs/12268/obtain-ai-structured-data)
存储空间 | 选择录制的视频文件存储的空间，目前只支持华北、华东、华南三个区域，创建模板时需要根据模板将要作用的空间，选择与空间服务区域一致的存储区域的bucket
文件生命周期 | 录制的视频文件存储的周期
文件存储类型 | 选择录制的视频文件存储的存储类型，可选项为普通存储和[低频存储 __](https://developer.qiniu.com/kodo/manual/3737/infrequent-storage)
**图像库**
配置项 | 说明
---|---
名称 | 格式为 1 ~ 100个字符，可包含字母、数字、中划线、下划线
备注 | 图像库描述
**实体**
配置项 | 说明
---|---
图像 | 实体的图像列表，图片格式支持 PNG、JPG、JPEG、BMP，最多可设置 10 张，每张图片不超过 5MB 且只能包含一张人脸
姓名 | 实体所属姓名,可包含中文、字母、数字、中划线、下划线
性别 | 可选项为 1：男 2：女，默认男
手机号 | 实体手机号
证件号 | 实体证件号
地址 | 实体地址
备注 | 实体描述
# **绑定AI模板**
模板可以绑定到空间上也可以绑定到对应的视频流上，绑定到空间上对空间下所有视频流生效，绑定到视频流上只对此路流生效。
### **操作说明**
**1.绑定到空间**
1.1选择**视频监控** 产品，进入产品控制台，选择**空间管理** ，进入空间列表页面，选择对应的空间点击**配置** ，进入空间详情页面。
1.2空间详情页面中选择**模板配置** ，点击**编辑** 进行配置如下图所示：
**2.绑定到流**
2.1选择**视频监控** 产品，进入产品控制台，选择**视频流管理** ，进入视频流列表页面，选择对应的视频流点击**管理** ，进入流管理页面。
2.2流管理页面中选择**基本信息** ，点击**编辑** 进行配置如下图所示：
# **接入流程演示**
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 使用指南 >模板管理 >Ai模板
# Ai模板
最近更新时间: 2022-12-22 11:25:32
如需进行AI分析时，可按照需求场景创建对应的AI模板并进行模板的绑定操作即可。目前AI模板支持两种算法：1.安全帽检测；2.人脸识别。
# **使用说明**
1. 模版可应用于空间级别和流级别。同一个模版可以与多个空间绑定。流级别的模版优先级高于空间。
2. 模板最终生效的都在流维度上，如需AI分析功能需要先进行AI模版的创建和绑定，流接入后触发模板工作。
3. 将模板与空间或流绑定时，模板中bucket所属的存储区域需要和“视频监控”中空间的服务区域保持一致，故创建模板时需要根据模板将要作用的空间，选择与空间服务区域一致的存储区域的bucket。
# **添加模板**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**模板管理** ，进入模板管理页面，选择**AI模板** 。
3.点击**添加AI模板** ，创建新的AI模板。`需要注意的是`，如果选择了**人脸识别**
算法，需要绑定用于人脸比对的图像库。图像库需要额外创建，见步骤4。
4.点击**查看图像库** ，进入图像库列表页面，点击**创建图像库** ，
输入名称和备注后点击**确定** ，
点击**查看** 进入实体列表页面，
点击**添加实体** ，创建实体。
### **配置项说明**
**AI模板**
配置项 | 说明
---|---
模板名称 | 格式为 1 ~ 100个字符，可包含字母、数字、中划线、下划线
选择算法 | 算法可选 1:安全帽识别 2: 人脸识别；可以同时配置多种算法
截帧间隔 | 默认为1, 代表每1秒截取1帧进行AI计算。有效范围 500ms~ 3600s
置信度 | 默认 60, 有效范围是1～100
运行模式 | 全程:只要视频流在线就开始AI分析 按需: 通过API控制AI分析的开始和结束 时间段: 自定义区间段内开始AI分析
图像库 | 依赖的基础图像库ID，例如当算法为人脸识别时，需要指定一个基础的图像库，也可以新建一个基础图像库
回调结构化数据 | 是否回调ai计算结果
存储结构化数据 | 是否保存ai识别的结构化数据，默认为false。若不保存，可以通过回调的方式得到[结构化数据 __](https://developer.qiniu.com/qvs/12268/obtain-ai-structured-data)
存储空间 | 选择录制的视频文件存储的空间，目前只支持华北、华东、华南三个区域，创建模板时需要根据模板将要作用的空间，选择与空间服务区域一致的存储区域的bucket
文件生命周期 | 录制的视频文件存储的周期
文件存储类型 | 选择录制的视频文件存储的存储类型，可选项为普通存储和[低频存储 __](https://developer.qiniu.com/kodo/manual/3737/infrequent-storage)
**图像库**
配置项 | 说明
---|---
名称 | 格式为 1 ~ 100个字符，可包含字母、数字、中划线、下划线
备注 | 图像库描述
**实体**
配置项 | 说明
---|---
图像 | 实体的图像列表，图片格式支持 PNG、JPG、JPEG、BMP，最多可设置 10 张，每张图片不超过 5MB 且只能包含一张人脸
姓名 | 实体所属姓名,可包含中文、字母、数字、中划线、下划线
性别 | 可选项为 1：男 2：女，默认男
手机号 | 实体手机号
证件号 | 实体证件号
地址 | 实体地址
备注 | 实体描述
# **绑定AI模板**
模板可以绑定到空间上也可以绑定到对应的视频流上，绑定到空间上对空间下所有视频流生效，绑定到视频流上只对此路流生效。
### **操作说明**
**1.绑定到空间**
1.1选择**视频监控** 产品，进入产品控制台，选择**空间管理** ，进入空间列表页面，选择对应的空间点击**配置** ，进入空间详情页面。
1.2空间详情页面中选择**模板配置** ，点击**编辑** 进行配置如下图所示：
**2.绑定到流**
2.1选择**视频监控** 产品，进入产品控制台，选择**视频流管理** ，进入视频流列表页面，选择对应的视频流点击**管理** ，进入流管理页面。
2.2流管理页面中选择**基本信息** ，点击**编辑** 进行配置如下图所示：
# **接入流程演示**
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,313 |
录制模板 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 使用指南 >模板管理 >录制模板
# 录制模板
最近更新时间: 2021-11-29 15:38:44
如需进行云端录制时，可按照需求场景创建对应的录制模板并进行绑定操作即可。
# **使用说明**
1. 模版可应用于空间级别和流级别。同一个模版可以与多个空间绑定。流级别的模版优先级高于空间。
2. 模板最终生效的都在流维度上，如需录制功能需要先进行模版的创建和绑定，流接入后触发模板工作。
3. 将模板与空间或流绑定时，模板中bucket所属的存储区域需要和“视频监控”中空间的服务区域保持一致，故创建模板时需要根据模板将要作用的空间，选择与空间服务区域一致的存储区域的bucket。
# **添加模板**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**模板管理** ，进入模板管理页面，选择**模板管理** 。
3.点击**添加录制模板** ，创建新的录制模板
**配置项说明**
配置项 | 说明
---|---
模板名称 | 模版名称，格式为 1 ~ 100个字符，可包含小写字母、数字、中划线
单个视频文件录制时长 | 录制周期支持 10-60 分钟，视频时长超过设定的录制周期后，将生成新文件
录制方式 | 可选项为实时录制和按需录制。
（1）实时录制：视频流在线后就开始进行录制。
（2）按需录制：是指当视频流在线后，调用启动录制接口后开始录制，调用停止录制接口后录制结束。如果不调录制结束接口，则一直进行录制。
视频格式 | 支持M3U8、MP4、FLV三种格式，可以同时选择生成三种协议的录制文件；生成 MP4/FLV 格式需要使用智能多媒体处理转码服务，会额外产生费用，生成过程需要一定时间。
存储空间 | 选择录制的视频文件存储的空间，目前只支持华北、华东、华南三个区域，创建模板时需要根据模板将要作用的空间，选择与空间服务区域一致的存储区域的bucket。
文件生命周期 | 录制的视频文件存储的周期
文件存储类型 | 选择录制的视频文件存储的存储类型，可选项为普通存储和[低频存储 __](https://developer.qiniu.com/kodo/manual/3737/infrequent-storage)
# **绑定录制模板**
模板可以绑定到空间上也可以绑定到对应的视频流上，绑定到空间上对空间下所有视频流生效，绑定到视频流上只对此路流生效。
### **操作说明**
**1.绑定到空间**
1.1选择**视频监控** 产品，进入产品控制台，选择**空间管理** ，进入空间列表页面，选择对应的空间点击**配置** ，进入空间详情页面。
1.2空间详情页面中选择**模板配置** ，点击**编辑** 进行配置如下图所示：
**2.绑定到流**
2.1选择**视频监控** 产品，进入产品控制台，选择**视频流管理** ，进入视频流列表页面，选择对应的视频流点击**管理** ，进入流管理页面。
2.2空间管理页面中选择**基本信息** ，点击**编辑** 进行配置如下图所示：
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 使用指南 >模板管理 >录制模板
# 录制模板
最近更新时间: 2021-11-29 15:38:44
如需进行云端录制时，可按照需求场景创建对应的录制模板并进行绑定操作即可。
# **使用说明**
1. 模版可应用于空间级别和流级别。同一个模版可以与多个空间绑定。流级别的模版优先级高于空间。
2. 模板最终生效的都在流维度上，如需录制功能需要先进行模版的创建和绑定，流接入后触发模板工作。
3. 将模板与空间或流绑定时，模板中bucket所属的存储区域需要和“视频监控”中空间的服务区域保持一致，故创建模板时需要根据模板将要作用的空间，选择与空间服务区域一致的存储区域的bucket。
# **添加模板**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**模板管理** ，进入模板管理页面，选择**模板管理** 。
3.点击**添加录制模板** ，创建新的录制模板
**配置项说明**
配置项 | 说明
---|---
模板名称 | 模版名称，格式为 1 ~ 100个字符，可包含小写字母、数字、中划线
单个视频文件录制时长 | 录制周期支持 10-60 分钟，视频时长超过设定的录制周期后，将生成新文件
录制方式 | 可选项为实时录制和按需录制。
（1）实时录制：视频流在线后就开始进行录制。
（2）按需录制：是指当视频流在线后，调用启动录制接口后开始录制，调用停止录制接口后录制结束。如果不调录制结束接口，则一直进行录制。
视频格式 | 支持M3U8、MP4、FLV三种格式，可以同时选择生成三种协议的录制文件；生成 MP4/FLV 格式需要使用智能多媒体处理转码服务，会额外产生费用，生成过程需要一定时间。
存储空间 | 选择录制的视频文件存储的空间，目前只支持华北、华东、华南三个区域，创建模板时需要根据模板将要作用的空间，选择与空间服务区域一致的存储区域的bucket。
文件生命周期 | 录制的视频文件存储的周期
文件存储类型 | 选择录制的视频文件存储的存储类型，可选项为普通存储和[低频存储 __](https://developer.qiniu.com/kodo/manual/3737/infrequent-storage)
# **绑定录制模板**
模板可以绑定到空间上也可以绑定到对应的视频流上，绑定到空间上对空间下所有视频流生效，绑定到视频流上只对此路流生效。
### **操作说明**
**1.绑定到空间**
1.1选择**视频监控** 产品，进入产品控制台，选择**空间管理** ，进入空间列表页面，选择对应的空间点击**配置** ，进入空间详情页面。
1.2空间详情页面中选择**模板配置** ，点击**编辑** 进行配置如下图所示：
**2.绑定到流**
2.1选择**视频监控** 产品，进入产品控制台，选择**视频流管理** ，进入视频流列表页面，选择对应的视频流点击**管理** ，进入流管理页面。
2.2空间管理页面中选择**基本信息** ，点击**编辑** 进行配置如下图所示：
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,318 |
截图模板 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 使用指南 >模板管理 >截图模板
# 截图模板
最近更新时间: 2021-11-29 15:39:07
如需进行云端截图时，可按照需求场景创建对应的截图模板并进行模板的绑定操作即可。
# **使用说明**
1. 模版可应用于空间级别和流级别。同一个模版可以与多个空间绑定。流级别的模版优先级高于空间。
2. 模板最终生效的都在流维度上，如需截图功能需要先进行截图模版的创建和绑定，流接入后触发模板工作。
3. 将模板与空间或流绑定时，模板中bucket所属的存储区域需要和“视频监控”中空间的服务区域保持一致，故创建模板时需要根据模板将要作用的空间，选择与空间服务区域一致的存储区域的bucket。
# **添加模板**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**模板管理** ，进入模板管理页面，选择**截图模板** 。
3.点击**添加截图模板** ，创建新的截图模板
**配置项说明**
配置项 | 说明
---|---
模板名称 | 模版名称，格式为 1 ~ 100个字符，可包含小写字母、数字、中划线
截图频率 | 支持 1-21600 秒
截图方式 | 可选项为实时截图、覆盖式截图、按需截图。
（1）实时截图：每张截图文件都独立存储，不覆盖。
（2）覆盖式截图：只保留最新一张截图，每次截图覆盖上一张截图，名称和地址保持不变，常用作视频封面。
（3）按需截图：只有当调用启动截图接口时才会进行截图。
存储空间 | 选择录制的视频文件存储的空间，目前只支持华北、华东、华南三个区域，创建模板时需要根据模板将要作用的空间，选择与空间服务区域一致的存储区域的bucket。
文件生命周期 | 录制的视频文件存储的周期
文件存储类型 | 选择录制的视频文件存储的存储类型，可选项为普通存储和[低频存储 __](https://developer.qiniu.com/kodo/manual/3737/infrequent-storage)
# **绑定截图模板**
模板可以绑定到空间上也可以绑定到对应的视频流上，绑定到空间上对空间下所有视频流生效，绑定到视频流上只对此路流生效。
### **操作说明**
**1.绑定到空间**
1.1选择**视频监控** 产品，进入产品控制台，选择**空间管理** ，进入空间列表页面，选择对应的空间点击**配置** ，进入空间详情页面。
1.2空间详情页面中选择**模板配置** ，点击**编辑** 进行配置如下图所示：
**2.绑定到流**
2.1选择**视频监控** 产品，进入产品控制台，选择**视频流管理** ，进入视频流列表页面，选择对应的视频流点击**管理** ，进入流管理页面。
2.2空间管理页面中选择**基本信息** ，点击**编辑** 进行配置如下图所示：
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > 使用文档 > 使用指南 >模板管理 >截图模板
# 截图模板
最近更新时间: 2021-11-29 15:39:07
如需进行云端截图时，可按照需求场景创建对应的截图模板并进行模板的绑定操作即可。
# **使用说明**
1. 模版可应用于空间级别和流级别。同一个模版可以与多个空间绑定。流级别的模版优先级高于空间。
2. 模板最终生效的都在流维度上，如需截图功能需要先进行截图模版的创建和绑定，流接入后触发模板工作。
3. 将模板与空间或流绑定时，模板中bucket所属的存储区域需要和“视频监控”中空间的服务区域保持一致，故创建模板时需要根据模板将要作用的空间，选择与空间服务区域一致的存储区域的bucket。
# **添加模板**
### **操作说明**
1.登录[七牛开发者平台
__](https://sso.qiniu.com/?client_id=PIapUKqa3u6S24H868BelwrG0OFu8dS7AxVQ8oz8HznLXhgrl2BnjaO9cs9LzxK2&redirect_url=https:%2F%2Fportal.qiniu.com%2Fapi%2Fgaea%2Fsso%2Fsignin%3Fredirect%3D%252Fcreate)。
2.选择**视频监控** 产品，进入产品控制台，选择**模板管理** ，进入模板管理页面，选择**截图模板** 。
3.点击**添加截图模板** ，创建新的截图模板
**配置项说明**
配置项 | 说明
---|---
模板名称 | 模版名称，格式为 1 ~ 100个字符，可包含小写字母、数字、中划线
截图频率 | 支持 1-21600 秒
截图方式 | 可选项为实时截图、覆盖式截图、按需截图。
（1）实时截图：每张截图文件都独立存储，不覆盖。
（2）覆盖式截图：只保留最新一张截图，每次截图覆盖上一张截图，名称和地址保持不变，常用作视频封面。
（3）按需截图：只有当调用启动截图接口时才会进行截图。
存储空间 | 选择录制的视频文件存储的空间，目前只支持华北、华东、华南三个区域，创建模板时需要根据模板将要作用的空间，选择与空间服务区域一致的存储区域的bucket。
文件生命周期 | 录制的视频文件存储的周期
文件存储类型 | 选择录制的视频文件存储的存储类型，可选项为普通存储和[低频存储 __](https://developer.qiniu.com/kodo/manual/3737/infrequent-storage)
# **绑定截图模板**
模板可以绑定到空间上也可以绑定到对应的视频流上，绑定到空间上对空间下所有视频流生效，绑定到视频流上只对此路流生效。
### **操作说明**
**1.绑定到空间**
1.1选择**视频监控** 产品，进入产品控制台，选择**空间管理** ，进入空间列表页面，选择对应的空间点击**配置** ，进入空间详情页面。
1.2空间详情页面中选择**模板配置** ，点击**编辑** 进行配置如下图所示：
**2.绑定到流**
2.1选择**视频监控** 产品，进入产品控制台，选择**视频流管理** ，进入视频流列表页面，选择对应的视频流点击**管理** ，进入流管理页面。
2.2空间管理页面中选择**基本信息** ，点击**编辑** 进行配置如下图所示：
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,321 |
API概述 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > API概述
# API概述
最近更新时间: 2024-05-15 14:27:43
本文档介绍了视频监控服务的各类API，您可以分别查看各API的具体信息。
# **空间管理相关**
API | 说明
---|---
[创建空间 __](https://developer.qiniu.com/qvs/api/6726/create-namespace)|
用于创建新的业务空间
[删除空间 __](https://developer.qiniu.com/qvs/api/6727/delete-namespace)|
用于删除业务空间
[更新空间 __](https://developer.qiniu.com/qvs/api/6728/update-namespace)|
用户更新空间的配置信息操作
[查询空间信息 __](https://developer.qiniu.com/qvs/api/6729/query-namespace)|
用户查询业务空间的详细信息
[获取空间列表 __](https://developer.qiniu.com/qvs/api/6730/list-namespace)|
用户获取空间列表
[禁用空间 __](https://developer.qiniu.com/qvs/api/6759/disable-the-space)| 禁用空间操作
[启用空间 __](https://developer.qiniu.com/qvs/api/6760/enable-the-space)| 启用空间操作
[消息通知 __](https://developer.qiniu.com/qvs/10240/the-message-callback)|
直播流状态的实时变化、设备状态的实时变化，视频录制/截图成功的事件通知
# **域名管理相关**
API | 说明
---|---
[创建域名 __](https://developer.qiniu.com/qvs/6903/create-domain)| 用于在某空间下创建新的域名
[删除域名 __](https://developer.qiniu.com/qvs/6904/delete-domain)| 用于删除空间下的域名
[更新域名 __](https://developer.qiniu.com/qvs/7317/update-domain)|
更新域名,例如开启或关闭时间戳防盗链,添加或删除https证书等
[查询域名 __](https://developer.qiniu.com/qvs/6917/domain-information)| 查询域名信息
[获取域名列表 __](https://developer.qiniu.com/qvs/6905/domain-name-list)|
获取某个空间下的域名列表
[获取https证书列表 __](https://developer.qiniu.com/qvs/6891/to-obtain-a-list-
certificate)| 获取https ssl证书列表
[配置域名戳防盗链 __](https://developer.qiniu.com/qvs/10481/the-domain-name-
configuration)| 修改域名下的防盗链信息
# **流管理相关**
API | 说明
---|---
[创建流 __](https://developer.qiniu.com/qvs/api/6734/create-flow)| 用于创建视频流
[删除流 __](https://developer.qiniu.com/qvs/api/6735/delete-flow)| 用于删除已添加的视频流
[更新流 __](https://developer.qiniu.com/qvs/api/6758/update-the-flow)| 用于更新流的配置新
[查询流信息 __](https://developer.qiniu.com/qvs/api/6736/query-information-flow)|
用于查询流的详细信息
[获取流列表 __](https://developer.qiniu.com/qvs/api/6737/query-list-flow)|
用于获取流列表信息
[获取流地址 __](https://developer.qiniu.com/qvs/api/6740/obtain-flow-address)|
用于获取推拉流地址信息
[启用流 __](https://developer.qiniu.com/qvs/api/6739/enable-the-flow)| 启用流操作
[禁用流 __](https://developer.qiniu.com/qvs/api/6738/disable-the-flow)| 禁用流操作
[查询流实时信息 __](https://developer.qiniu.com/qvs/api/6741/real-time-information-
query-flow)| 用于查询实时流的帧率、码率
[查询推流记录 __](https://developer.qiniu.com/qvs/api/6742/query-flow-records)|
用于查询流的推流记录
# **设备管理相关**
API | 说明
---|---
[创建设备 __](https://developer.qiniu.com/qvs/api/6896/create-device)| 用于创建设备
[批量创建设备 __](https://developer.qiniu.com/qvs/10086/batch-create-device)|
用于批量创建设备
[获取批次列表 __](https://developer.qiniu.com/qvs/10170/get-batch-list)|
用于查询批量创建设备的批次记录
[获取批次设备信息 __](https://developer.qiniu.com/qvs/10160/export-batch-equipment)|
用于查询批次下所有设备的信息
[删除批次 __](https://developer.qiniu.com/qvs/10171/batch-remove-devices)|
用于删除批次下所有的设备
[删除设备 __](https://developer.qiniu.com/qvs/api/6898/Delete-device)| 用于删除设备
[更新设备 __](https://developer.qiniu.com/qvs/api/6899/update-the-device)|
用于更新设备配置信息
[查询设备信息 __](https://developer.qiniu.com/qvs/api/6901/Query-device-
information)| 用于查询设备信息
[获取设备列表 __](https://developer.qiniu.com/qvs/api/6902/Query-device-list)|
用于获取设备列表信息
[获取通道列表 __](https://developer.qiniu.com/qvs/api/6906/query-channel-list)|
用于查询通道列表信息
[删除通道 __](https://developer.qiniu.com/qvs/7120/delete-the-channel)|
用于删除网络录像机的指定通道
[启动设备拉流 __](https://developer.qiniu.com/qvs/api/6907/start-device)|
用于启动国标设备拉流
[停止设备拉流 __](https://developer.qiniu.com/qvs/api/6908/stop-device)| 用于结束国标设备拉流
[语音对讲 __](https://developer.qiniu.com/qvs/8158/voice-call)| 用于对设备发起语音对讲
[获取设备地理位置 __](https://developer.qiniu.com/qvs/10243/get-to-location)用于获取设备地理位置信息 |
# **模板管理相关**
API | 说明
---|---
[创建模板 __](https://developer.qiniu.com/qvs/api/6721/create-template)|
用于创建录制、截图等模板
[删除模板 __](https://developer.qiniu.com/qvs/api/6722/delete-template)|
用户删除指定的模板
[更新模板 __](https://developer.qiniu.com/qvs/api/6723/modify-the-template)|
用于更新录制、截图等模板的配置信息
[查询模板信息 __](https://developer.qiniu.com/qvs/api/6724/template-
informationhttp://)| 用于查询指定模板的配置信息
[获取模板列表 __](https://developer.qiniu.com/qvs/api/6725/list-template)|
用于获取模板列表信息
# **录制管理相关**
API | 说明
---|---
[启动按需录制 __](https://developer.qiniu.com/qvs/api/6743/start-record-stream)|
本接口用于对指定流启动按需录制
[停止按需录制 __](https://developer.qiniu.com/qvs/api/6744/stop-record-stream)|
本接口用于对指定流停止按需录制
[查询录制记录 __](https://developer.qiniu.io/qvs/api/6745/query-recordhistories)|
用于查询视频流的录制的记录
[删除录制片段 __](https://developer.qiniu.io/qvs/6746/delete-recorded-fragments)|
用于删除通过qvs录制模板生成的视频文件
[录制视频片段合并 __](https://developer.qiniu.com/qvs/api/7140/record-video-clips)|
该接口用于将多个录制文件合并成一个大的视频文件
[录制回放 __](https://developer.qiniu.com/qvs/api/6747/recording-playback)|
本接口用于查询指定时间段的录像记录进行录像回放
[按需截图 __](https://developer.qiniu.com/qvs/api/6748/start-snapshot)|
本接口用于对指定流立即截图一次，适用于按需截图场景
[删除截图 __](https://developer.qiniu.io/qvs/7109/deleted-screenshots)|
用于删除通过qvs截图模板生成的截图文件
[获取截图列表 __](https://developer.qiniu.com/qvs/api/6749/list-stream-snapshots)|
用于查询视频流截图的记录
[获取直播封面截图 __](https://developer.qiniu.com/qvs/api/6814/the-cover-for-
screenshots)| 用于查询视频流的封面
# **本地录像管理相关**
API | 说明
---|---
[本地录像回放控制 __](https://developer.qiniu.com/qvs/8405/local-video-playback-
control)| 用于本地录像回放的控制，如快进、快退、慢放、拖动播放、暂停等操作
[查询本地录像列表 __](https://developer.qiniu.com/qvs/api/7112/query-local-video-
list)| 用于查询设备本地录像列表
[本地录像上传云端存储 __](https://developer.qiniu.com/qvs/7765/uploaded-to-the-cloud)|
用于将本地录像文件上传到云端并进行录制存储的操作
[终止本地录像上传云端存储 __](https://developer.qiniu.com/qvs/7766/stop-uploaded-to-the-
cloud)| 用于终止本地录制文件上传云端录制的操作
# **PTZ相关**
API | 说明
---|---
[云台控制 __](https://developer.qiniu.com/qvs/api/7290/ptz-control)| 用于对摄像头进行
转动镜头，如水平、垂直、缩放等操作
[变焦控制 __](https://developer.qiniu.com/qvs/api/7292/zoom-control)| 用于摄像头的变焦控制
[光圈控制 __](https://developer.qiniu.com/qvs/api/7291/aperture-control)|
用于摄像头的光圈控制
[预置位控制 __](https://developer.qiniu.com/qvs/api/7293/set-the-preset-position)|
用于预置位的管理
[获取预置位列表 __](https://developer.qiniu.com/qvs/api/7295/get-prepared-list)|
用于摄像头端获取预置位列表信息
# **国标报警相关接口**
API | 说明
---|---
[获取国标报警事件列表 __](https://developer.qiniu.com/qvs/7775/gb-alarm-events-list)|
用于获取设备国标报警事件列表
# **数据统计相关**
API | 说明
---|---
[查询流量数据 __](https://developer.qiniu.com/qvs/api/6855/query-the-network-
traffic-data)| 本接口用于查询用户或者空间下的流量数据
[查询带宽数据 __](https://developer.qiniu.com/qvs/api/6856/query-data-bandwidth)|
本接口用于查询用户或者空间下的带宽数据
[查询国标接入设备数 __](https://developer.qiniu.com/qvs/8748/gb-devicecount)|
本接口用于查询用户或者空间下接入的国标设备数量
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > API概述
# API概述
最近更新时间: 2024-05-15 14:27:43
本文档介绍了视频监控服务的各类API，您可以分别查看各API的具体信息。
# **空间管理相关**
API | 说明
---|---
[创建空间 __](https://developer.qiniu.com/qvs/api/6726/create-namespace)|
用于创建新的业务空间
[删除空间 __](https://developer.qiniu.com/qvs/api/6727/delete-namespace)|
用于删除业务空间
[更新空间 __](https://developer.qiniu.com/qvs/api/6728/update-namespace)|
用户更新空间的配置信息操作
[查询空间信息 __](https://developer.qiniu.com/qvs/api/6729/query-namespace)|
用户查询业务空间的详细信息
[获取空间列表 __](https://developer.qiniu.com/qvs/api/6730/list-namespace)|
用户获取空间列表
[禁用空间 __](https://developer.qiniu.com/qvs/api/6759/disable-the-space)| 禁用空间操作
[启用空间 __](https://developer.qiniu.com/qvs/api/6760/enable-the-space)| 启用空间操作
[消息通知 __](https://developer.qiniu.com/qvs/10240/the-message-callback)|
直播流状态的实时变化、设备状态的实时变化，视频录制/截图成功的事件通知
# **域名管理相关**
API | 说明
---|---
[创建域名 __](https://developer.qiniu.com/qvs/6903/create-domain)| 用于在某空间下创建新的域名
[删除域名 __](https://developer.qiniu.com/qvs/6904/delete-domain)| 用于删除空间下的域名
[更新域名 __](https://developer.qiniu.com/qvs/7317/update-domain)|
更新域名,例如开启或关闭时间戳防盗链,添加或删除https证书等
[查询域名 __](https://developer.qiniu.com/qvs/6917/domain-information)| 查询域名信息
[获取域名列表 __](https://developer.qiniu.com/qvs/6905/domain-name-list)|
获取某个空间下的域名列表
[获取https证书列表 __](https://developer.qiniu.com/qvs/6891/to-obtain-a-list-
certificate)| 获取https ssl证书列表
[配置域名戳防盗链 __](https://developer.qiniu.com/qvs/10481/the-domain-name-
configuration)| 修改域名下的防盗链信息
# **流管理相关**
API | 说明
---|---
[创建流 __](https://developer.qiniu.com/qvs/api/6734/create-flow)| 用于创建视频流
[删除流 __](https://developer.qiniu.com/qvs/api/6735/delete-flow)| 用于删除已添加的视频流
[更新流 __](https://developer.qiniu.com/qvs/api/6758/update-the-flow)| 用于更新流的配置新
[查询流信息 __](https://developer.qiniu.com/qvs/api/6736/query-information-flow)|
用于查询流的详细信息
[获取流列表 __](https://developer.qiniu.com/qvs/api/6737/query-list-flow)|
用于获取流列表信息
[获取流地址 __](https://developer.qiniu.com/qvs/api/6740/obtain-flow-address)|
用于获取推拉流地址信息
[启用流 __](https://developer.qiniu.com/qvs/api/6739/enable-the-flow)| 启用流操作
[禁用流 __](https://developer.qiniu.com/qvs/api/6738/disable-the-flow)| 禁用流操作
[查询流实时信息 __](https://developer.qiniu.com/qvs/api/6741/real-time-information-
query-flow)| 用于查询实时流的帧率、码率
[查询推流记录 __](https://developer.qiniu.com/qvs/api/6742/query-flow-records)|
用于查询流的推流记录
# **设备管理相关**
API | 说明
---|---
[创建设备 __](https://developer.qiniu.com/qvs/api/6896/create-device)| 用于创建设备
[批量创建设备 __](https://developer.qiniu.com/qvs/10086/batch-create-device)|
用于批量创建设备
[获取批次列表 __](https://developer.qiniu.com/qvs/10170/get-batch-list)|
用于查询批量创建设备的批次记录
[获取批次设备信息 __](https://developer.qiniu.com/qvs/10160/export-batch-equipment)|
用于查询批次下所有设备的信息
[删除批次 __](https://developer.qiniu.com/qvs/10171/batch-remove-devices)|
用于删除批次下所有的设备
[删除设备 __](https://developer.qiniu.com/qvs/api/6898/Delete-device)| 用于删除设备
[更新设备 __](https://developer.qiniu.com/qvs/api/6899/update-the-device)|
用于更新设备配置信息
[查询设备信息 __](https://developer.qiniu.com/qvs/api/6901/Query-device-
information)| 用于查询设备信息
[获取设备列表 __](https://developer.qiniu.com/qvs/api/6902/Query-device-list)|
用于获取设备列表信息
[获取通道列表 __](https://developer.qiniu.com/qvs/api/6906/query-channel-list)|
用于查询通道列表信息
[删除通道 __](https://developer.qiniu.com/qvs/7120/delete-the-channel)|
用于删除网络录像机的指定通道
[启动设备拉流 __](https://developer.qiniu.com/qvs/api/6907/start-device)|
用于启动国标设备拉流
[停止设备拉流 __](https://developer.qiniu.com/qvs/api/6908/stop-device)| 用于结束国标设备拉流
[语音对讲 __](https://developer.qiniu.com/qvs/8158/voice-call)| 用于对设备发起语音对讲
[获取设备地理位置 __](https://developer.qiniu.com/qvs/10243/get-to-location)用于获取设备地理位置信息 |
# **模板管理相关**
API | 说明
---|---
[创建模板 __](https://developer.qiniu.com/qvs/api/6721/create-template)|
用于创建录制、截图等模板
[删除模板 __](https://developer.qiniu.com/qvs/api/6722/delete-template)|
用户删除指定的模板
[更新模板 __](https://developer.qiniu.com/qvs/api/6723/modify-the-template)|
用于更新录制、截图等模板的配置信息
[查询模板信息 __](https://developer.qiniu.com/qvs/api/6724/template-
informationhttp://)| 用于查询指定模板的配置信息
[获取模板列表 __](https://developer.qiniu.com/qvs/api/6725/list-template)|
用于获取模板列表信息
# **录制管理相关**
API | 说明
---|---
[启动按需录制 __](https://developer.qiniu.com/qvs/api/6743/start-record-stream)|
本接口用于对指定流启动按需录制
[停止按需录制 __](https://developer.qiniu.com/qvs/api/6744/stop-record-stream)|
本接口用于对指定流停止按需录制
[查询录制记录 __](https://developer.qiniu.io/qvs/api/6745/query-recordhistories)|
用于查询视频流的录制的记录
[删除录制片段 __](https://developer.qiniu.io/qvs/6746/delete-recorded-fragments)|
用于删除通过qvs录制模板生成的视频文件
[录制视频片段合并 __](https://developer.qiniu.com/qvs/api/7140/record-video-clips)|
该接口用于将多个录制文件合并成一个大的视频文件
[录制回放 __](https://developer.qiniu.com/qvs/api/6747/recording-playback)|
本接口用于查询指定时间段的录像记录进行录像回放
[按需截图 __](https://developer.qiniu.com/qvs/api/6748/start-snapshot)|
本接口用于对指定流立即截图一次，适用于按需截图场景
[删除截图 __](https://developer.qiniu.io/qvs/7109/deleted-screenshots)|
用于删除通过qvs截图模板生成的截图文件
[获取截图列表 __](https://developer.qiniu.com/qvs/api/6749/list-stream-snapshots)|
用于查询视频流截图的记录
[获取直播封面截图 __](https://developer.qiniu.com/qvs/api/6814/the-cover-for-
screenshots)| 用于查询视频流的封面
# **本地录像管理相关**
API | 说明
---|---
[本地录像回放控制 __](https://developer.qiniu.com/qvs/8405/local-video-playback-
control)| 用于本地录像回放的控制，如快进、快退、慢放、拖动播放、暂停等操作
[查询本地录像列表 __](https://developer.qiniu.com/qvs/api/7112/query-local-video-
list)| 用于查询设备本地录像列表
[本地录像上传云端存储 __](https://developer.qiniu.com/qvs/7765/uploaded-to-the-cloud)|
用于将本地录像文件上传到云端并进行录制存储的操作
[终止本地录像上传云端存储 __](https://developer.qiniu.com/qvs/7766/stop-uploaded-to-the-
cloud)| 用于终止本地录制文件上传云端录制的操作
# **PTZ相关**
API | 说明
---|---
[云台控制 __](https://developer.qiniu.com/qvs/api/7290/ptz-control)| 用于对摄像头进行
转动镜头，如水平、垂直、缩放等操作
[变焦控制 __](https://developer.qiniu.com/qvs/api/7292/zoom-control)| 用于摄像头的变焦控制
[光圈控制 __](https://developer.qiniu.com/qvs/api/7291/aperture-control)|
用于摄像头的光圈控制
[预置位控制 __](https://developer.qiniu.com/qvs/api/7293/set-the-preset-position)|
用于预置位的管理
[获取预置位列表 __](https://developer.qiniu.com/qvs/api/7295/get-prepared-list)|
用于摄像头端获取预置位列表信息
# **国标报警相关接口**
API | 说明
---|---
[获取国标报警事件列表 __](https://developer.qiniu.com/qvs/7775/gb-alarm-events-list)|
用于获取设备国标报警事件列表
# **数据统计相关**
API | 说明
---|---
[查询流量数据 __](https://developer.qiniu.com/qvs/api/6855/query-the-network-
traffic-data)| 本接口用于查询用户或者空间下的流量数据
[查询带宽数据 __](https://developer.qiniu.com/qvs/api/6856/query-data-bandwidth)|
本接口用于查询用户或者空间下的带宽数据
[查询国标接入设备数 __](https://developer.qiniu.com/qvs/8748/gb-devicecount)|
本接口用于查询用户或者空间下接入的国标设备数量
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,324 |
错误响应 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 调用方式 >错误响应
# 错误响应
最近更新时间: 2022-12-12 11:45:28
**视频监控（qvs）API 返回结果说明**
调用 API 服务后返回数据采用统一格式：
返回的 HTTP 状态码为 2xx，代表调用成功。 调用成功返回的数据格式为json。
返回的 HTTP 状态码为 4xx、5xx或6xx，代表调用失败。错误状态下会返回详细的错误信息：
{
"code": <errorCode>,
"error": "<errorInfo>"
}
### 错误码表
HTTP状态码 | 详细错误码 | 错误信息
---|---|---
400 | 400000 | patch请求参数非法
400 | 400001 | patch请求解析失败
400 | 400002 | patch op非法
400 | 400100 | 空间名称非法(^[a-zA-Z0-9_-]{1,100}$)
400 | 400101 | 空间描述不合法(最大支持100个字符)
400 | 400102 | 空间接入方式不合法，必须为"rtmp"或者"gb28181"
400 | 400103 | rtmp 方式接入的时候需指定接入类型(1:静态,2:动态)
400 | 400105 | rtmp 静态接入必须指定域名
400 | 400106 | 域名已存在
400 | 400109 | 录制模版ID非法
400 | 400110 | 截图模版ID非法
400 | 400111 | 无效的回调地址
400 | 400112 | 无效的服务区域
400 | 400113 | 只允许在gb28181类型的空间下进行该操作
400 | 400114 | 只允许在rtmp类型的空间下进行该操作
400 | 400115 | 按需拉流已开启，请绑定按需模版
400 | 400116 | 空间被禁用
400 | 400200 | 模版名称非法(^[a-zA-Z0-9_-]{1,100}$)
400 | 400201 | 模版描述不合法(最大支持100个字符）
400 | 400202 | 模版类型不合法(0:录制模版,1:截图模版)
400 | 400203 | 录制文件名非法，当前不支持自定义录制文件名
400 | 400204 | 截图文件名非法当前不支持自定义截图文件名
400 | 400205 | 查询Bucket所在区域信息失败
400 | 400206 | 截图类型非法(0:序列式截图,1:覆盖式截图,2:按需截图)
400 | 400207 | 录制模版类型非法(0:不录制,1:实时录制,2:按需录制)
400 | 400208 | 文件存储类型非法(0:普通存储,1:低频存储)
400 | 400212 | 录制模版时长非法([600,3600秒])
400 | 400213 | 截图模版按需截图间隔非法([10-21600秒])
400 | 400215 | 无效bucket, bucket区域需与绑定bucket对应空间区域信息一致
400 | 400300 | stream 名称非法(^[a-zA-Z0-9_-]{1,100}$)
400 | 400301 | stream 描述非法，最大为100个字符
400 | 400302 | 查询流列表接口sortBy参数非法
400 | 400305 | publish ip不能为空
400 | 400306 | play ip 不能为空
400 | 400307 | 请求rtmp动态地址时，urlExpireSec参数非法，此参数不能小于0
400 | 400308 | 查询start，end非法，时间跨度最大只能查询1天
400 | 400309 | ip地址无效
400 | 400310 | 请求rtmp动态地址时，playip、publiship 不能同时为空
400 | 400402 | 请求非法，只有静态接入才能绑定域名
400 | 400405 | 域名不存在
400 | 400406 | 时间戳防盗链输入key值非法
400 | 400407 | 时间戳防盗链没有启用
400 | 400408 | 域名与实际域名类型不匹配
400 | 400410 | ssl 证书不存在
400 | 400501 | start、end参数非法，start参数应小于end参数
400 | 400502 | 截图列表参数非法，[0,3]
400 | 400505 | 另存为格式非法，支持m3u8、mp4、flv
400 | 400506 | 另存文件名和format不匹配
400 | 400507 | 非法的录制间隔
400 | 400600 | 非法的start、end参数，流量带宽查询参数格式为20201012(年月日)或者20201012204005(年月日时分秒)
400 | 400601 | 非法的device name
400 | 400602 | 非法的device type
400 | 400603 | 非法username格式
400 | 400604 | 非法的passowd格式
400 | 400606 | 查询设备列表sortBy参数非法
400 | 400607 | 非法的国标ID
400 | 400608 | 无效的起止时间
400 | 400609 | 无效的告警方法，全部报警方法 1,2,3,4,5,6,7
400 | 400702 | 不支持的控制指令
400 | 400703 | 预设位id非法
400 | 400704 | 平台设备需指定通道ID
400 | 400705 | 预置位名称非法(最大支持20个字符)
400 | 400706 | 预置位名称已存在
400 | 400718 | 巡航组中绑定了该预置位，请先解除绑定
400 | 400802 | 非法的ai模板参数，截帧间隔（0.5~3600，单位秒），置信度（1~100），运行模式（0为全程开启，1为按需开启，2为指定运行时间段）
400 | 400803 | 非法的图像库参数，名称(^[a-zA-Z0-9_-]{1,100}$)，描述(最大支持100个字符)
400 | 400804 | 非法的实体参数，名称(^[\u4e00-\u9fa5a-zA-Z0-9_-]{1,100}$)，性别（female/male），手机号码（^(+\d{2,}-)?[\d-]{6,}$），证件号（最大支持50个字符），地址（最大支持100个字符），描述（最大支持100个字符）
400 | 400805 | 查询ai模板列表接口sortBy参数非法
400 | 400806 | 上传图像非法，请上传只包含一个人脸的图片
400 | 400807 | 图片内容无法解析，请上传合法的base64编码
500 | 500000 | 服务端内部错误
612 | 612100 | 空间不存在
612 | 612200 | 模版不存在
612 | 612300 | 流不存在
612 | 612303 | 流被禁用
612 | 612500 | 流对应的录制模版没有绑定
612 | 612501 | 录制模版对应的bucket不存在
612 | 612502 | 没有录制记录
612 | 612503 | 模板中选择的存储bucket未绑定域名，请绑定域名后在进行访问
612 | 612504 | 流不在线
612 | 612505 | 未绑定覆盖式截图模版
612 | 612600 | 设备不存在
612 | 612601 | channel不存在
612 | 612604 | 流对应的截图模版没有绑定
612 | 612607 | 删除文件失败，一次最多可以删除1000个文件
612 | 612701 | 国标设备推流启动中
612 | 612706 | 启动拉流或停止拉流操作失败，需指定国标设备进行操作
612 | 612707 | 国标设备离线
612 | 612708 | 启动拉流或停止拉流操作失败
612 | 612712 | 输入国标ID为非平台类设备，无法返回通道相关数据，请输入国标ID平台类的设备进行查询
612 | 612713 | 国标设备获取本地录制信息失败
612 | 612714 | 平台设备同步通道失败
612 | 612717 | 查询预置位列表失败
612 | 612719 | 本地录像上传开关未开启
612 | 612720 | 查询录制回放记录失败
612 | 612721 | 设备录制模版对应的bucket与流指定的bucket发生冲突
612 | 612800 | 图像库不存在
612 | 612802 | 实体不存在
612 | 612803 | 图片不存在
612 | 612804 | 上传图片时服务器发生错误
612 | 612805 | 删除图片时服务器发生错误
612 | 612806 | ai分析时发生错误
613 | 613100 | 添加空间失败，超出空间数量限制，最多可以创建10个空间
614 | 614100 | 空间名已经存在(namesapce 名称必须保证唯一)
614 | 614200 | 模版已经存在(模版名称必须保证唯一)
614 | 614300 | 流已经存在
614 | 614400 | 设备已经存在
614 | 614500 | 国标ID已经存在
614 | 614801 | 图像库已经存在
614 | 614802 | 实体已经存在
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 调用方式 >错误响应
# 错误响应
最近更新时间: 2022-12-12 11:45:28
**视频监控（qvs）API 返回结果说明**
调用 API 服务后返回数据采用统一格式：
返回的 HTTP 状态码为 2xx，代表调用成功。 调用成功返回的数据格式为json。
返回的 HTTP 状态码为 4xx、5xx或6xx，代表调用失败。错误状态下会返回详细的错误信息：
{
"code": <errorCode>,
"error": "<errorInfo>"
}
### 错误码表
HTTP状态码 | 详细错误码 | 错误信息
---|---|---
400 | 400000 | patch请求参数非法
400 | 400001 | patch请求解析失败
400 | 400002 | patch op非法
400 | 400100 | 空间名称非法(^[a-zA-Z0-9_-]{1,100}$)
400 | 400101 | 空间描述不合法(最大支持100个字符)
400 | 400102 | 空间接入方式不合法，必须为"rtmp"或者"gb28181"
400 | 400103 | rtmp 方式接入的时候需指定接入类型(1:静态,2:动态)
400 | 400105 | rtmp 静态接入必须指定域名
400 | 400106 | 域名已存在
400 | 400109 | 录制模版ID非法
400 | 400110 | 截图模版ID非法
400 | 400111 | 无效的回调地址
400 | 400112 | 无效的服务区域
400 | 400113 | 只允许在gb28181类型的空间下进行该操作
400 | 400114 | 只允许在rtmp类型的空间下进行该操作
400 | 400115 | 按需拉流已开启，请绑定按需模版
400 | 400116 | 空间被禁用
400 | 400200 | 模版名称非法(^[a-zA-Z0-9_-]{1,100}$)
400 | 400201 | 模版描述不合法(最大支持100个字符）
400 | 400202 | 模版类型不合法(0:录制模版,1:截图模版)
400 | 400203 | 录制文件名非法，当前不支持自定义录制文件名
400 | 400204 | 截图文件名非法当前不支持自定义截图文件名
400 | 400205 | 查询Bucket所在区域信息失败
400 | 400206 | 截图类型非法(0:序列式截图,1:覆盖式截图,2:按需截图)
400 | 400207 | 录制模版类型非法(0:不录制,1:实时录制,2:按需录制)
400 | 400208 | 文件存储类型非法(0:普通存储,1:低频存储)
400 | 400212 | 录制模版时长非法([600,3600秒])
400 | 400213 | 截图模版按需截图间隔非法([10-21600秒])
400 | 400215 | 无效bucket, bucket区域需与绑定bucket对应空间区域信息一致
400 | 400300 | stream 名称非法(^[a-zA-Z0-9_-]{1,100}$)
400 | 400301 | stream 描述非法，最大为100个字符
400 | 400302 | 查询流列表接口sortBy参数非法
400 | 400305 | publish ip不能为空
400 | 400306 | play ip 不能为空
400 | 400307 | 请求rtmp动态地址时，urlExpireSec参数非法，此参数不能小于0
400 | 400308 | 查询start，end非法，时间跨度最大只能查询1天
400 | 400309 | ip地址无效
400 | 400310 | 请求rtmp动态地址时，playip、publiship 不能同时为空
400 | 400402 | 请求非法，只有静态接入才能绑定域名
400 | 400405 | 域名不存在
400 | 400406 | 时间戳防盗链输入key值非法
400 | 400407 | 时间戳防盗链没有启用
400 | 400408 | 域名与实际域名类型不匹配
400 | 400410 | ssl 证书不存在
400 | 400501 | start、end参数非法，start参数应小于end参数
400 | 400502 | 截图列表参数非法，[0,3]
400 | 400505 | 另存为格式非法，支持m3u8、mp4、flv
400 | 400506 | 另存文件名和format不匹配
400 | 400507 | 非法的录制间隔
400 | 400600 | 非法的start、end参数，流量带宽查询参数格式为20201012(年月日)或者20201012204005(年月日时分秒)
400 | 400601 | 非法的device name
400 | 400602 | 非法的device type
400 | 400603 | 非法username格式
400 | 400604 | 非法的passowd格式
400 | 400606 | 查询设备列表sortBy参数非法
400 | 400607 | 非法的国标ID
400 | 400608 | 无效的起止时间
400 | 400609 | 无效的告警方法，全部报警方法 1,2,3,4,5,6,7
400 | 400702 | 不支持的控制指令
400 | 400703 | 预设位id非法
400 | 400704 | 平台设备需指定通道ID
400 | 400705 | 预置位名称非法(最大支持20个字符)
400 | 400706 | 预置位名称已存在
400 | 400718 | 巡航组中绑定了该预置位，请先解除绑定
400 | 400802 | 非法的ai模板参数，截帧间隔（0.5~3600，单位秒），置信度（1~100），运行模式（0为全程开启，1为按需开启，2为指定运行时间段）
400 | 400803 | 非法的图像库参数，名称(^[a-zA-Z0-9_-]{1,100}$)，描述(最大支持100个字符)
400 | 400804 | 非法的实体参数，名称(^[\u4e00-\u9fa5a-zA-Z0-9_-]{1,100}$)，性别（female/male），手机号码（^(+\d{2,}-)?[\d-]{6,}$），证件号（最大支持50个字符），地址（最大支持100个字符），描述（最大支持100个字符）
400 | 400805 | 查询ai模板列表接口sortBy参数非法
400 | 400806 | 上传图像非法，请上传只包含一个人脸的图片
400 | 400807 | 图片内容无法解析，请上传合法的base64编码
500 | 500000 | 服务端内部错误
612 | 612100 | 空间不存在
612 | 612200 | 模版不存在
612 | 612300 | 流不存在
612 | 612303 | 流被禁用
612 | 612500 | 流对应的录制模版没有绑定
612 | 612501 | 录制模版对应的bucket不存在
612 | 612502 | 没有录制记录
612 | 612503 | 模板中选择的存储bucket未绑定域名，请绑定域名后在进行访问
612 | 612504 | 流不在线
612 | 612505 | 未绑定覆盖式截图模版
612 | 612600 | 设备不存在
612 | 612601 | channel不存在
612 | 612604 | 流对应的截图模版没有绑定
612 | 612607 | 删除文件失败，一次最多可以删除1000个文件
612 | 612701 | 国标设备推流启动中
612 | 612706 | 启动拉流或停止拉流操作失败，需指定国标设备进行操作
612 | 612707 | 国标设备离线
612 | 612708 | 启动拉流或停止拉流操作失败
612 | 612712 | 输入国标ID为非平台类设备，无法返回通道相关数据，请输入国标ID平台类的设备进行查询
612 | 612713 | 国标设备获取本地录制信息失败
612 | 612714 | 平台设备同步通道失败
612 | 612717 | 查询预置位列表失败
612 | 612719 | 本地录像上传开关未开启
612 | 612720 | 查询录制回放记录失败
612 | 612721 | 设备录制模版对应的bucket与流指定的bucket发生冲突
612 | 612800 | 图像库不存在
612 | 612802 | 实体不存在
612 | 612803 | 图片不存在
612 | 612804 | 上传图片时服务器发生错误
612 | 612805 | 删除图片时服务器发生错误
612 | 612806 | ai分析时发生错误
613 | 613100 | 添加空间失败，超出空间数量限制，最多可以创建10个空间
614 | 614100 | 空间名已经存在(namesapce 名称必须保证唯一)
614 | 614200 | 模版已经存在(模版名称必须保证唯一)
614 | 614300 | 流已经存在
614 | 614400 | 设备已经存在
614 | 614500 | 国标ID已经存在
614 | 614801 | 图像库已经存在
614 | 614802 | 实体已经存在
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,334 |
HTTP Headers | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 调用方式 >HTTP Headers
# HTTP Headers
最近更新时间: 2022-08-08 11:30:06
# **公共请求头**
名称 | 类型 | 是否必填 | 示例值 | 说明
---|---|---|---|---
Host | String | 是 | qvs.qiniuapi.com | 服务地址
Authorization | String | 是 | QiniuToken | 验证请求合法性的认证信息。认证不通过时，会收到401错误码。格式为`Authorization: Qiniu xx:xx`。 建议使用服务端接入SDK，[java版本SDK __](https://developer.qiniu.com/qvs/6923/qvs-java-sdk)或者其他版本，sdk已经封装了鉴权机制；如果客户自行计算该字段，可以参考[鉴权机制 __](https://developer.qiniu.io/qvs/6713/authentication)
Content-Type | String | 否 | | 一. http body为空时，例如Get请求, Content-Type有3种选择
1\. `不`携带Content-Type
2.设置为`空`
3.设置为`application/x-www-form-urlencoded`;
二. http body 不为空时，例如Post或者Patch等,Content-Type设置为application/json
# **公共响应头**
名称 | 说明 | 示例值
---|---|---
Content-Length | 请求或响应内容长度，单位`字节`。 | 例如 `Content-Length: 299`。
Content-Type | 请求或响应内容的 MIME 类型。 | 例如 `Content-Type: application/json`。
X-Reqid | 上传请求的唯一 ID。通过该 ID 可快速定位用户请求的相关日志。在联系技术支持时提供该 ID 可快速解决问题。 | 例如 `X-Reqid: BlcAAAFP_Hx-RfkU`。
Date | 服务器端响应时间。 | 例如 `Date: Wed, 22 Nov 2017 01:52:39 GMT`。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 调用方式 >HTTP Headers
# HTTP Headers
最近更新时间: 2022-08-08 11:30:06
# **公共请求头**
名称 | 类型 | 是否必填 | 示例值 | 说明
---|---|---|---|---
Host | String | 是 | qvs.qiniuapi.com | 服务地址
Authorization | String | 是 | QiniuToken | 验证请求合法性的认证信息。认证不通过时，会收到401错误码。格式为`Authorization: Qiniu xx:xx`。 建议使用服务端接入SDK，[java版本SDK __](https://developer.qiniu.com/qvs/6923/qvs-java-sdk)或者其他版本，sdk已经封装了鉴权机制；如果客户自行计算该字段，可以参考[鉴权机制 __](https://developer.qiniu.io/qvs/6713/authentication)
Content-Type | String | 否 | | 一. http body为空时，例如Get请求, Content-Type有3种选择
1\. `不`携带Content-Type
2.设置为`空`
3.设置为`application/x-www-form-urlencoded`;
二. http body 不为空时，例如Post或者Patch等,Content-Type设置为application/json
# **公共响应头**
名称 | 说明 | 示例值
---|---|---
Content-Length | 请求或响应内容长度，单位`字节`。 | 例如 `Content-Length: 299`。
Content-Type | 请求或响应内容的 MIME 类型。 | 例如 `Content-Type: application/json`。
X-Reqid | 上传请求的唯一 ID。通过该 ID 可快速定位用户请求的相关日志。在联系技术支持时提供该 ID 可快速解决问题。 | 例如 `X-Reqid: BlcAAAFP_Hx-RfkU`。
Date | 服务器端响应时间。 | 例如 `Date: Wed, 22 Nov 2017 01:52:39 GMT`。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,346 |
鉴权机制 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 调用方式 >鉴权机制
# 鉴权机制
最近更新时间: 2023-03-28 16:38:47
鉴权机制用于QVS服务的授权，通过授权客户端，使其具备访问服务的能力。访问 API 需要带一个合法的凭证。不带凭证或带非法凭证的请求将返回 HTTP 错误码
401，代表认证失败。
每一个API请求均需在 HTTP 请求头部增加一个 Authorization 字段，形式如下：
Authorization: <QiniuToken>
`<QiniuToken>`:管理凭证，用于鉴权。
**管理凭证计算方式：**
// 构造待签名的 Data
// 1. 添加 Path
data = "<Method> <Path>"
// 2. 添加 Query，前提: Query 存在且不为空
if "<RawQuery>" != "" {
data += "?<RawQuery>"
}
// 3. 添加 Host
data += "\nHost: <Host>"
// 4. 添加 Content-Type，前提: Content-Type 存在且不为空
if "<Content-Type>" != "" {
data += "\nContent-Type: <Content-Type>"
}
// 5. 添加回车
data += "\n\n"
// 6. 添加 Body，前提: Content-Length 存在且 Body 不为空，同时 Content-Type 存在且不为空或 "application/octet-stream"
bodyOK := "<Content-Length>" != "" && "<Body>" != ""
contentTypeOK := "<Content-Type>" != "" && "<Content-Type>" != "application/octet-stream"
if bodyOK && contentTypeOK {
data += "<Body>"
}
// 计算 HMAC-SHA1 签名，并对签名结果做 URL 安全的 Base64 编码
sign = hmac_sha1(data, "Your_Secret_Key")
encodedSign = urlsafe_base64_encode(sign)
// 将 Qiniu 标识与 AccessKey、encodedSign 拼接得到管理凭证
<QiniuToken> = "Qiniu " + "Your_Access_Key" + ":" + encodedSign
[URL 安全的 Base64 编码 __](https://developer.qiniu.com/kodo/manual/1231/appendix)
**python 计算Authorization管理凭证示例：**
以[获取流地址](https://developer.qiniu.com/qvs/6800/static-model)为例
import hmac
import base64
import hashlib
// 拼接规则
//data=方法+" "+接口路径+"\nHost: "+ "qvs.qiniuapi.com" + "\nContent-Type: "+"application/json\n\n"+"json body"
// 具体实现
# -*- coding:utf-8 -*-
import hmac
import base64
import hashlib
#具体实现 python2
data = "POST"+ " " + "/v1/namespaces/2xenzw32d1rf9/streams/31011500991180001471_34020000001320000001/domain" + \
"\nHost: " + "qvs.qiniuapi.com" + \
"\nContent-Type: " + "application/json" + "\n\n" + \
'{"domain":"qvs-live-hls.cpgroup.cn","domainType":"liveHls"}'
accessKey = '替换成自己的accessKey'
secretKey = '替换成自己的secretKey'
sign = hmac.new(secretKey, data, hashlib.sha1).digest()
encodedSign = base64.urlsafe_b64encode(sign)
authorization = 'Qiniu ' + accessKey + ':' + encodedSign
print(authorization)
**API请求示例：**
GET /v1/apps/test/devices/dGVzdGRldmljZTE= HTTP/1.1
Host: linking.qiniuapi.com
Authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=
Content-Type: application/json
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 调用方式 >鉴权机制
# 鉴权机制
最近更新时间: 2023-03-28 16:38:47
鉴权机制用于QVS服务的授权，通过授权客户端，使其具备访问服务的能力。访问 API 需要带一个合法的凭证。不带凭证或带非法凭证的请求将返回 HTTP 错误码
401，代表认证失败。
每一个API请求均需在 HTTP 请求头部增加一个 Authorization 字段，形式如下：
Authorization: <QiniuToken>
`<QiniuToken>`:管理凭证，用于鉴权。
**管理凭证计算方式：**
// 构造待签名的 Data
// 1. 添加 Path
data = "<Method> <Path>"
// 2. 添加 Query，前提: Query 存在且不为空
if "<RawQuery>" != "" {
data += "?<RawQuery>"
}
// 3. 添加 Host
data += "\nHost: <Host>"
// 4. 添加 Content-Type，前提: Content-Type 存在且不为空
if "<Content-Type>" != "" {
data += "\nContent-Type: <Content-Type>"
}
// 5. 添加回车
data += "\n\n"
// 6. 添加 Body，前提: Content-Length 存在且 Body 不为空，同时 Content-Type 存在且不为空或 "application/octet-stream"
bodyOK := "<Content-Length>" != "" && "<Body>" != ""
contentTypeOK := "<Content-Type>" != "" && "<Content-Type>" != "application/octet-stream"
if bodyOK && contentTypeOK {
data += "<Body>"
}
// 计算 HMAC-SHA1 签名，并对签名结果做 URL 安全的 Base64 编码
sign = hmac_sha1(data, "Your_Secret_Key")
encodedSign = urlsafe_base64_encode(sign)
// 将 Qiniu 标识与 AccessKey、encodedSign 拼接得到管理凭证
<QiniuToken> = "Qiniu " + "Your_Access_Key" + ":" + encodedSign
[URL 安全的 Base64 编码 __](https://developer.qiniu.com/kodo/manual/1231/appendix)
**python 计算Authorization管理凭证示例：**
以[获取流地址](https://developer.qiniu.com/qvs/6800/static-model)为例
import hmac
import base64
import hashlib
// 拼接规则
//data=方法+" "+接口路径+"\nHost: "+ "qvs.qiniuapi.com" + "\nContent-Type: "+"application/json\n\n"+"json body"
// 具体实现
# -*- coding:utf-8 -*-
import hmac
import base64
import hashlib
#具体实现 python2
data = "POST"+ " " + "/v1/namespaces/2xenzw32d1rf9/streams/31011500991180001471_34020000001320000001/domain" + \
"\nHost: " + "qvs.qiniuapi.com" + \
"\nContent-Type: " + "application/json" + "\n\n" + \
'{"domain":"qvs-live-hls.cpgroup.cn","domainType":"liveHls"}'
accessKey = '替换成自己的accessKey'
secretKey = '替换成自己的secretKey'
sign = hmac.new(secretKey, data, hashlib.sha1).digest()
encodedSign = base64.urlsafe_b64encode(sign)
authorization = 'Qiniu ' + accessKey + ':' + encodedSign
print(authorization)
**API请求示例：**
GET /v1/apps/test/devices/dGVzdGRldmljZTE= HTTP/1.1
Host: linking.qiniuapi.com
Authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=
Content-Type: application/json
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,349 |
请求结构 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 调用方式 >请求结构
# 请求结构
最近更新时间: 2022-08-03 16:19:43
# **服务地址**
API服务域名: `http(s)://qvs.qiniuapi.com`
# **通信协议**
支持通过 HTTP 或 HTTPS 进行通信，为了更高的安全性，建议使用 HTTPS 发送API请求。
# **字符编码**
请求及返回结果都使用 UTF-8 字符集进行编码。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 调用方式 >请求结构
# 请求结构
最近更新时间: 2022-08-03 16:19:43
# **服务地址**
API服务域名: `http(s)://qvs.qiniuapi.com`
# **通信协议**
支持通过 HTTP 或 HTTPS 进行通信，为了更高的安全性，建议使用 HTTPS 发送API请求。
# **字符编码**
请求及返回结果都使用 UTF-8 字符集进行编码。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,354 |
消息回调 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 空间管理相关接口 >消息回调
# 消息回调
最近更新时间: 2024-05-15 14:25:26
# **功能介绍**
直播流状态的实时变化、设备状态的实时变化，视频录制/截图成功的通知这类事件都在QVS内部管理，用户可使用QVS的状态回调服务及时获知这些信息。
# **消息组织格式**
使用状态回调服务，您需要在QVS后台配置可正常访问的状态回调URL，回调信息采用JSON格式进行组织，通过Http/Https POST协议传递。
## **流状态回调参数** ：
参数名称 | 字段类型 | 说明
---|---|---
type | string | 事件类型，流状态对应事件类型为"stream"
nsId | string | 空间ID
streamId | string | 流ID 当采用GBT28181接入，设备类型为“摄像头”时，流ID就是设备国标ID；设备类型为“平台”时，流ID就是“设备国标ID_通道ID”的形式，例31011500991180003166_34020000001310000001；当采用rtmp接入时，rtmp://xxx:2045/空间ID/流ID
streamState | integer | 0：离线，1：在线
timeSec | integer | 对应10位时间戳
reqId | string | 请求唯一标识
示例：
curl --request POST \
--url http://客户自己配置的回调地址 \
--header 'content-type: application/json' \
--data '{
"type": "stream",
"nsId": "d102sni9zryu",
"streamId": "31011500991320000137",
"streamState": 1,
"timeSec": 1606810185,
"reqId": "mjgBAHjcY6cbhkwW"
}'
## **设备状态回调参数** :
该回调只适用于采用GBT28181接入的空间。
参数名称 | 字段类型 | 说明
---|---|---
type | string | 事件类型，流状态对应事件类型为"device"
nsId | string | 空间ID
gbid | string | 国标ID
chGbid | string | 通道ID 设备类型为“摄像头”时，因为不存在通道，所以该字段为空
deviceState | string | 设备状态 “online”/“offline”
timeSec | integer | 对应10位时间戳
reqId | string | 请求唯一标识
示例：
curl --request POST \
--url http://客户自己配置的回调地址 \
--header 'content-type: application/json' \
--data '{
"type": "device",
"nsId": "d102sni9zryu",
"gbid": "54020000001110000001",
"chGbid": "31011500991320000096",
"deviceState": "online"
"timeSec": 1606810285,
"reqId": "9H4AAKscvcSXiUwW"
}'
## **录制状态回调参数** :
参数名称 | 字段类型 | 说明
---|---|---
type | string | 事件类型，流状态对应事件类型为"record"
nsId | string | 空间ID
streamId | string | 流ID
start | bigint/uint64 | 录制开始时间，毫秒时间戳（例如：1607311044166）
end | bigint/uint64 | 录制结束时间， 毫秒时间戳
duration | integer | 录制时长
fname | string | 录制文件名
recordType | integer | 1：实时录制，2：按需录制
code | integer | 状态码0成功，1等待处理，2正在处理，3处理失败
errmsg | string | 错误信息
timeSec | integer | 对应10位时间戳
reqId | string | 请求唯一标识
processId | string | 客户自定义ID,录制完毕，平台重新把该ID回调给客户
示例：
curl --request POST \
--url http://客户自己配置的回调地址 \
--header 'content-type: application/json' \
--data '{
"type": "record",
"nsId": "2akras1jotpfe",
"streamId": "teststream",
"start": 1607310997732,
"end": 1607311044166,
"duration": 46434,
"fname": "record/2akras1jotpfe/teststream/1607310997732-1607311044166-44478.mp4"
"recordType": 1,
"code": 0,
"errmsg": "",
"timeSec": 1607311045,
"reqId": "5AMAADto6DDhUE4W"
}'
## **截图状态回调参数** :
参数名称 | 字段类型 | 说明
---|---|---
type | string | 事件类型，流状态对应事件类型为"snap"
nsId | string | 空间ID
streamId | string | 流ID
snapItems | 对象数组 | 截图结果集
code | integer | 状态码0成功，1等待处理，2正在处理，3处理失败
errmsg | string | 错误信息
timeSec | integer | 对应10位时间戳，回调的时间
reqId | string | 请求唯一标识
snapItem对象参数
参数名称 | 字段类型 | 说明
---|---|---
fname | string | 截图结果的外链资源名
code | int | 状态码0成功，1等待处理，2正在处理，3处理失败
error | string | 如果处理失败，该字段会给出失败的详细原因
示例：
curl --request POST \
--url http://客户自己配置的回调地址 \
--header 'content-type: application/json' \
--data '{
"type": "snap",
"nsId": "2akras1jotpfe",
"streamId": "teststream",
"snapItems": [{
"fname": "snapshot/jpg/2akras1jotpfe/teststream/1607311542082.jpg",
"code": 0,
"error": ""
}]
"code": 0,
"errmsg": "",
"timeSec": 1607311552,
"reqId": "TxcAAAmEzkBWUU4W"
}'
## **国标报警回调参数** :
参数名称 | 字段类型 | 说明
---|---|---
type | string | 事件类型，取值"alarm"
nsId | string | 空间ID
gbid | string | 国标ID
chGbid | string | 通道ID
deviceState | string | 设备状态 “online”/“offline”
timeSec | integer | 报警时间，单位秒
alarmMethod | integer | 报警方式：1为电话报警， 2为设备报警， 3为短信报警， 4为GPS报警， 5为视频报警， 6为设备故障报警， 7其他报警
alarmType | integer | 报警类型，详见`报警类型说明`
alarmPriority | integer | 报警级别。 取值：1（一级警情），2（二级警情），3（三级警情），4（四级警情）
reqId | string | 请求唯一标识
### **报警类型说明**
* 报警方式（alarmMethod）为2时，
不携带alarmType为默认的报警设备报警；
携带alarmType取值及对应报警类型：1-视频丢失报警； 2-设备防拆报警； 3-存储设备磁盘满报警； 4-设备高温报警； 5-设备低温报警。
* 报警方式（alarmMethod）为5时，
取值如下：1-人工视频报警； 2-运动目标检测报警； 3-遗留物检测报警； 4-物体移除检测报警； 5-绊线检测报警；6-入侵检测报警； 7-逆行检测报警；
8-徘徊检测报警； 9-流量统计报警； 10-密度检测报警； 11-视频异常检测报警； 12-快速移动报警。
* 报警方式（alarmMethod）为6时，
取值如下： 1-存储设备磁盘故障报警； 2-存储设备风扇故障报警。
示例：
curl --request POST \
--url http://客户自己配置的回调地址 \
--header 'content-type: application/json' \
--data '{
"type": "alarm",
"nsId": "2akras1jotpfe",
"gbid": "54020000001110000001",
"chGbid": "31011500991320000096",
"deviceState":"online",
"alarmMethod":5,
"alarmType":2,
"alarmPriority":1,
"timeSec": 1607311552,
"reqId": "TxcAAAmEzkBWUU4W"
}'
## **AI分析结构化数据回调参数** :
参数名称 | 字段类型 | 说明
---|---|---
type | string | 事件类型，AI分析结构化数据对应事件类型为"ai"
nsId | string | 空间ID
streamId | string | 流ID
structuredDataItems | 对象数组 | 截图结果集
code | integer | 状态码0成功，1等待处理，2正在处理，3处理失败
errmsg | string | 错误信息
timeSec | integer | 对应10位时间戳，回调的时间
reqId | string | 请求唯一标识
structuredDataItem对象参数
参数名称 | 字段类型 | 说明
---|---|---
algorithm | int | 使用的算法类型，1安全帽检测，2人脸识别
frameName | string | 截帧的外链资源名
structuredData | object | 结构化数据
timeStamp | int | 截帧时间戳
error | string | 如果处理失败，该字段会给出失败的详细原因
示例：
curl --request POST \
--url http://客户自己配置的回调地址 \
--header 'content-type: application/json' \
--data '{
"type": "ai",
"nsId": "2akras1jotpfe",
"streamId": "teststream",
"structuredDataItems": [{
"algorithm": 1,
"frameName": "AiSourceFile/2akras1jotpfe/teststream/2akras1jotpfe_teststream_2022-11-30 15:39:17.jpg",
"structuredData": {
"details":[{
"bbox":[773,217,807,261], //检测框在图⽚中的位置[left, top, right, bottom]
"label":"王二",
"landmark":[777,788,779,783,790,232,230,241,251,249] //面部关键特征点
}],
"imageLabel":["王二"]
},
"error": ""
}]
"code": 0,
"errmsg": "",
"timeSec": 1607311552,
"reqId": "TxcAAAmEzkBWUU4W"
}'
## **流播放状态回调参数** ：
参数名称 | 字段类型 | 说明
---|---|---
type | string | 事件类型，流播放状态对应事件类型为"play"
nsId | string | 空间ID
streamId | string | 流ID 当采用GBT28181接入，设备类型为“摄像头”时，流ID就是设备国标ID；设备类型为“平台”时，流ID就是“设备国标ID_通道ID”的形式，例31011500991180003166_34020000001310000001；当采用rtmp接入时，rtmp://xxx:2045/空间ID/流ID
playUrl | string | 播放地址
status | string | 播放状态。“PlayStart”: 流开始播放; “NormalClose”: 播放器正常关闭; “StreamExpired”: 流过期; “ConsoleDetached”: 流离线。
timeSec | integer | 对应10位时间戳
reqId | string | 请求唯一标识
示例：
curl --request POST \
--url http://客户自己配置的回调地址 \
--header 'content-type: application/json' \
--data '{
"type": "play",
"nsId": "d102sni9zryu",
"streamId": "31011500991320000137",
"playUrl": "rtmp://14.29.108.156:2044/testapp/31011500991320000137?e=1683190080\u0026token=52fdfc072182654d%3AMK79G8kGpUMHeIIC8Ic8lzGVc0k",
"status": "StreamExpired",
"timeSec": 1606810185,
"reqId": "mjgBAHjcY6cbhkwW"
}'
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 空间管理相关接口 >消息回调
# 消息回调
最近更新时间: 2024-05-15 14:25:26
# **功能介绍**
直播流状态的实时变化、设备状态的实时变化，视频录制/截图成功的通知这类事件都在QVS内部管理，用户可使用QVS的状态回调服务及时获知这些信息。
# **消息组织格式**
使用状态回调服务，您需要在QVS后台配置可正常访问的状态回调URL，回调信息采用JSON格式进行组织，通过Http/Https POST协议传递。
## **流状态回调参数** ：
参数名称 | 字段类型 | 说明
---|---|---
type | string | 事件类型，流状态对应事件类型为"stream"
nsId | string | 空间ID
streamId | string | 流ID 当采用GBT28181接入，设备类型为“摄像头”时，流ID就是设备国标ID；设备类型为“平台”时，流ID就是“设备国标ID_通道ID”的形式，例31011500991180003166_34020000001310000001；当采用rtmp接入时，rtmp://xxx:2045/空间ID/流ID
streamState | integer | 0：离线，1：在线
timeSec | integer | 对应10位时间戳
reqId | string | 请求唯一标识
示例：
curl --request POST \
--url http://客户自己配置的回调地址 \
--header 'content-type: application/json' \
--data '{
"type": "stream",
"nsId": "d102sni9zryu",
"streamId": "31011500991320000137",
"streamState": 1,
"timeSec": 1606810185,
"reqId": "mjgBAHjcY6cbhkwW"
}'
## **设备状态回调参数** :
该回调只适用于采用GBT28181接入的空间。
参数名称 | 字段类型 | 说明
---|---|---
type | string | 事件类型，流状态对应事件类型为"device"
nsId | string | 空间ID
gbid | string | 国标ID
chGbid | string | 通道ID 设备类型为“摄像头”时，因为不存在通道，所以该字段为空
deviceState | string | 设备状态 “online”/“offline”
timeSec | integer | 对应10位时间戳
reqId | string | 请求唯一标识
示例：
curl --request POST \
--url http://客户自己配置的回调地址 \
--header 'content-type: application/json' \
--data '{
"type": "device",
"nsId": "d102sni9zryu",
"gbid": "54020000001110000001",
"chGbid": "31011500991320000096",
"deviceState": "online"
"timeSec": 1606810285,
"reqId": "9H4AAKscvcSXiUwW"
}'
## **录制状态回调参数** :
参数名称 | 字段类型 | 说明
---|---|---
type | string | 事件类型，流状态对应事件类型为"record"
nsId | string | 空间ID
streamId | string | 流ID
start | bigint/uint64 | 录制开始时间，毫秒时间戳（例如：1607311044166）
end | bigint/uint64 | 录制结束时间， 毫秒时间戳
duration | integer | 录制时长
fname | string | 录制文件名
recordType | integer | 1：实时录制，2：按需录制
code | integer | 状态码0成功，1等待处理，2正在处理，3处理失败
errmsg | string | 错误信息
timeSec | integer | 对应10位时间戳
reqId | string | 请求唯一标识
processId | string | 客户自定义ID,录制完毕，平台重新把该ID回调给客户
示例：
curl --request POST \
--url http://客户自己配置的回调地址 \
--header 'content-type: application/json' \
--data '{
"type": "record",
"nsId": "2akras1jotpfe",
"streamId": "teststream",
"start": 1607310997732,
"end": 1607311044166,
"duration": 46434,
"fname": "record/2akras1jotpfe/teststream/1607310997732-1607311044166-44478.mp4"
"recordType": 1,
"code": 0,
"errmsg": "",
"timeSec": 1607311045,
"reqId": "5AMAADto6DDhUE4W"
}'
## **截图状态回调参数** :
参数名称 | 字段类型 | 说明
---|---|---
type | string | 事件类型，流状态对应事件类型为"snap"
nsId | string | 空间ID
streamId | string | 流ID
snapItems | 对象数组 | 截图结果集
code | integer | 状态码0成功，1等待处理，2正在处理，3处理失败
errmsg | string | 错误信息
timeSec | integer | 对应10位时间戳，回调的时间
reqId | string | 请求唯一标识
snapItem对象参数
参数名称 | 字段类型 | 说明
---|---|---
fname | string | 截图结果的外链资源名
code | int | 状态码0成功，1等待处理，2正在处理，3处理失败
error | string | 如果处理失败，该字段会给出失败的详细原因
示例：
curl --request POST \
--url http://客户自己配置的回调地址 \
--header 'content-type: application/json' \
--data '{
"type": "snap",
"nsId": "2akras1jotpfe",
"streamId": "teststream",
"snapItems": [{
"fname": "snapshot/jpg/2akras1jotpfe/teststream/1607311542082.jpg",
"code": 0,
"error": ""
}]
"code": 0,
"errmsg": "",
"timeSec": 1607311552,
"reqId": "TxcAAAmEzkBWUU4W"
}'
## **国标报警回调参数** :
参数名称 | 字段类型 | 说明
---|---|---
type | string | 事件类型，取值"alarm"
nsId | string | 空间ID
gbid | string | 国标ID
chGbid | string | 通道ID
deviceState | string | 设备状态 “online”/“offline”
timeSec | integer | 报警时间，单位秒
alarmMethod | integer | 报警方式：1为电话报警， 2为设备报警， 3为短信报警， 4为GPS报警， 5为视频报警， 6为设备故障报警， 7其他报警
alarmType | integer | 报警类型，详见`报警类型说明`
alarmPriority | integer | 报警级别。 取值：1（一级警情），2（二级警情），3（三级警情），4（四级警情）
reqId | string | 请求唯一标识
### **报警类型说明**
* 报警方式（alarmMethod）为2时，
不携带alarmType为默认的报警设备报警；
携带alarmType取值及对应报警类型：1-视频丢失报警； 2-设备防拆报警； 3-存储设备磁盘满报警； 4-设备高温报警； 5-设备低温报警。
* 报警方式（alarmMethod）为5时，
取值如下：1-人工视频报警； 2-运动目标检测报警； 3-遗留物检测报警； 4-物体移除检测报警； 5-绊线检测报警；6-入侵检测报警； 7-逆行检测报警；
8-徘徊检测报警； 9-流量统计报警； 10-密度检测报警； 11-视频异常检测报警； 12-快速移动报警。
* 报警方式（alarmMethod）为6时，
取值如下： 1-存储设备磁盘故障报警； 2-存储设备风扇故障报警。
示例：
curl --request POST \
--url http://客户自己配置的回调地址 \
--header 'content-type: application/json' \
--data '{
"type": "alarm",
"nsId": "2akras1jotpfe",
"gbid": "54020000001110000001",
"chGbid": "31011500991320000096",
"deviceState":"online",
"alarmMethod":5,
"alarmType":2,
"alarmPriority":1,
"timeSec": 1607311552,
"reqId": "TxcAAAmEzkBWUU4W"
}'
## **AI分析结构化数据回调参数** :
参数名称 | 字段类型 | 说明
---|---|---
type | string | 事件类型，AI分析结构化数据对应事件类型为"ai"
nsId | string | 空间ID
streamId | string | 流ID
structuredDataItems | 对象数组 | 截图结果集
code | integer | 状态码0成功，1等待处理，2正在处理，3处理失败
errmsg | string | 错误信息
timeSec | integer | 对应10位时间戳，回调的时间
reqId | string | 请求唯一标识
structuredDataItem对象参数
参数名称 | 字段类型 | 说明
---|---|---
algorithm | int | 使用的算法类型，1安全帽检测，2人脸识别
frameName | string | 截帧的外链资源名
structuredData | object | 结构化数据
timeStamp | int | 截帧时间戳
error | string | 如果处理失败，该字段会给出失败的详细原因
示例：
curl --request POST \
--url http://客户自己配置的回调地址 \
--header 'content-type: application/json' \
--data '{
"type": "ai",
"nsId": "2akras1jotpfe",
"streamId": "teststream",
"structuredDataItems": [{
"algorithm": 1,
"frameName": "AiSourceFile/2akras1jotpfe/teststream/2akras1jotpfe_teststream_2022-11-30 15:39:17.jpg",
"structuredData": {
"details":[{
"bbox":[773,217,807,261], //检测框在图⽚中的位置[left, top, right, bottom]
"label":"王二",
"landmark":[777,788,779,783,790,232,230,241,251,249] //面部关键特征点
}],
"imageLabel":["王二"]
},
"error": ""
}]
"code": 0,
"errmsg": "",
"timeSec": 1607311552,
"reqId": "TxcAAAmEzkBWUU4W"
}'
## **流播放状态回调参数** ：
参数名称 | 字段类型 | 说明
---|---|---
type | string | 事件类型，流播放状态对应事件类型为"play"
nsId | string | 空间ID
streamId | string | 流ID 当采用GBT28181接入，设备类型为“摄像头”时，流ID就是设备国标ID；设备类型为“平台”时，流ID就是“设备国标ID_通道ID”的形式，例31011500991180003166_34020000001310000001；当采用rtmp接入时，rtmp://xxx:2045/空间ID/流ID
playUrl | string | 播放地址
status | string | 播放状态。“PlayStart”: 流开始播放; “NormalClose”: 播放器正常关闭; “StreamExpired”: 流过期; “ConsoleDetached”: 流离线。
timeSec | integer | 对应10位时间戳
reqId | string | 请求唯一标识
示例：
curl --request POST \
--url http://客户自己配置的回调地址 \
--header 'content-type: application/json' \
--data '{
"type": "play",
"nsId": "d102sni9zryu",
"streamId": "31011500991320000137",
"playUrl": "rtmp://14.29.108.156:2044/testapp/31011500991320000137?e=1683190080\u0026token=52fdfc072182654d%3AMK79G8kGpUMHeIIC8Ic8lzGVc0k",
"status": "StreamExpired",
"timeSec": 1606810185,
"reqId": "mjgBAHjcY6cbhkwW"
}'
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,355 |
创建空间 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 空间管理相关接口 >创建空间
# 创建空间
最近更新时间: 2023-04-13 10:27:23
# **描述**
本接口用于创建新的业务空间。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces`
* 默认只能创建`10`个空间，如果需要更多的配额，请提工单, 在后台为您提升配额后，可以通过接口创建更多的空间,(超过10个后，无法通过控制台创建，只能通过接口)。
# **请求参数**
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
name | 是 | string | 空间名称(格式"^[a-zA-Z0-9_-]{1,100}$")
desc | 否 | string | 空间描述
accessType | 是 | string | 接入类型(rtmp,gb28181,pull,onvif)
~~rtmpUrlType~~(废弃,请使用urlMode) | 是 | integer | 推拉流地址计算方式，1:static, 2:dynamic
urlMode | 是 | integer | 推拉流地址计算方式，1:static, 2:dynamic
domains | urlMode为1时必填 | string 数组 | 直播域名
zone | 否 | string | zone为服务区域, 可根据流媒体实时处理、视频录制、截图的存储需求选择对应的区域, 可选项为z0, z1, z2, cn-east-2, as0, 默认为z0. z0表示华东, z1表示华北、z2表示华南, cn-east-2代表华东-浙江2区域, as0代表亚太-新加坡区域
callBack | 否 | string | 回调地址，可用于获取空间内设备/流状态更新时的信息
hlsLowLatency | 否 | boolean | hls低延迟开关
recordTemplateId | 否 | string | 录制模版ID，需要录制功能时输入对应的模板ID，录制模板ID可以模板管理中获取
snapshotTemplateId | 否 | string | 截图模版ID，需要截图功能时输入对应的模板ID，截图模板ID可以模板管理中获取
aiTemplateId | 否 | string | AI模版ID，需要AI分析功能时输入对应的模板ID，AI模板ID可以模板管理中获取
recordTemplateApplyAll | 否 | boolean | 空间模版是否应用到全局
snapshotTemplateApplyAll | 否 | boolean | 截图模版是否应用到全局
aiTemplateApplyAll | 否 | boolean | AI模版是否应用到全局
onDemandPull | 否 | boolean | 按需拉流开关，默认关闭
retryInterval | 否 | integer | accessType为"pull"时，拉流中断重连间隔
retryCount | 否 | integer | accessType为"pull"时，拉流中断重连次数
rtpAudio | 否 | boolean | 是否开启音频
rtpAudioTranscode | 否 | boolean | 是否开启音频转码
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
id | string | 空间ID
name | string | 空间名称
desc | string | 空间描述
domains | string数组 | rtmp 静态接入的时候的域名
zone | string | 服务区域
accessType | string | 接入类型
urlMode | integer | 推拉流地址计算方式，1:static, 2:dynamic
sipAddrs | sip信息数组 | sip信息数组
sipAddrs.sipServerId | string | accessType为gb28181时sip服务器地址，地址前10位为对应sip域
sipAddrs.sipServerIP | string | accessType为gb28181时sip服务器IP
sipAddrs.sipServerPort | string数组 | accessType为gb28181时sip服务器端口
callBack | string | 回调地址
hlsLowLatency | boolean | hls低延迟
recordTemplateId | string | 录制模版ID
snapshotTemplateId | string | 截图模版ID
aiTemplateId | string | AI模版ID
recordTemplateApplyAll | boolean | 空间模版是否应用到全局
snapshotTemplateApplyAll | boolean | 截图模版是否应用到全局
aiTemplateApplyAll | boolean | 截图模版是否应用到全局
disabled | boolean | 空间是否被禁用
onDemandPull | boolean | 按需拉流开关
createdAt | integer | 空间创建时间
updatedAt | integer | 空间更新时间
retryInterval | integer | accessType为"pull"时，拉流中断重连间隔，单位为秒
retryCount | integer | accessType为"pull"时，拉流中断重连次数，单位为次
rtpAudio | boolean | 是否开启音频
rtpAudioTranscode | boolean | 是否开启音频转码
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"name":"test001235",
"accessType":"rtmp",
"urlMode":1,
"zone": "z1",
"domains":["tests6.com"],
"recordTemplateId":"2akrarrzr7rh5"
}'
**响应示例**
{
"id": "2akrars3nkw3s",
"name": "test001235",
"domains": [
"qiniu.com"
],
"accessType": "rtmp",
"urlMode": 1,
"zone": "z1",
"hlsLowLatency": false,
"createdAt": 1586750356,
"updatedAt": 1586750356,
"recordTemplateId": "2akrarrzr7rh5",
"recordTemplateApplyAll": false,
"snapshotTemplateApplyAll": false,
"aiTemplateApplyAll": false,
"disabled": false,
"onDemandPull": false,
"authMode": "expiryAuth",
"authExpire": 86400
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 空间管理相关接口 >创建空间
# 创建空间
最近更新时间: 2023-04-13 10:27:23
# **描述**
本接口用于创建新的业务空间。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces`
* 默认只能创建`10`个空间，如果需要更多的配额，请提工单, 在后台为您提升配额后，可以通过接口创建更多的空间,(超过10个后，无法通过控制台创建，只能通过接口)。
# **请求参数**
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
name | 是 | string | 空间名称(格式"^[a-zA-Z0-9_-]{1,100}$")
desc | 否 | string | 空间描述
accessType | 是 | string | 接入类型(rtmp,gb28181,pull,onvif)
~~rtmpUrlType~~(废弃,请使用urlMode) | 是 | integer | 推拉流地址计算方式，1:static, 2:dynamic
urlMode | 是 | integer | 推拉流地址计算方式，1:static, 2:dynamic
domains | urlMode为1时必填 | string 数组 | 直播域名
zone | 否 | string | zone为服务区域, 可根据流媒体实时处理、视频录制、截图的存储需求选择对应的区域, 可选项为z0, z1, z2, cn-east-2, as0, 默认为z0. z0表示华东, z1表示华北、z2表示华南, cn-east-2代表华东-浙江2区域, as0代表亚太-新加坡区域
callBack | 否 | string | 回调地址，可用于获取空间内设备/流状态更新时的信息
hlsLowLatency | 否 | boolean | hls低延迟开关
recordTemplateId | 否 | string | 录制模版ID，需要录制功能时输入对应的模板ID，录制模板ID可以模板管理中获取
snapshotTemplateId | 否 | string | 截图模版ID，需要截图功能时输入对应的模板ID，截图模板ID可以模板管理中获取
aiTemplateId | 否 | string | AI模版ID，需要AI分析功能时输入对应的模板ID，AI模板ID可以模板管理中获取
recordTemplateApplyAll | 否 | boolean | 空间模版是否应用到全局
snapshotTemplateApplyAll | 否 | boolean | 截图模版是否应用到全局
aiTemplateApplyAll | 否 | boolean | AI模版是否应用到全局
onDemandPull | 否 | boolean | 按需拉流开关，默认关闭
retryInterval | 否 | integer | accessType为"pull"时，拉流中断重连间隔
retryCount | 否 | integer | accessType为"pull"时，拉流中断重连次数
rtpAudio | 否 | boolean | 是否开启音频
rtpAudioTranscode | 否 | boolean | 是否开启音频转码
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
id | string | 空间ID
name | string | 空间名称
desc | string | 空间描述
domains | string数组 | rtmp 静态接入的时候的域名
zone | string | 服务区域
accessType | string | 接入类型
urlMode | integer | 推拉流地址计算方式，1:static, 2:dynamic
sipAddrs | sip信息数组 | sip信息数组
sipAddrs.sipServerId | string | accessType为gb28181时sip服务器地址，地址前10位为对应sip域
sipAddrs.sipServerIP | string | accessType为gb28181时sip服务器IP
sipAddrs.sipServerPort | string数组 | accessType为gb28181时sip服务器端口
callBack | string | 回调地址
hlsLowLatency | boolean | hls低延迟
recordTemplateId | string | 录制模版ID
snapshotTemplateId | string | 截图模版ID
aiTemplateId | string | AI模版ID
recordTemplateApplyAll | boolean | 空间模版是否应用到全局
snapshotTemplateApplyAll | boolean | 截图模版是否应用到全局
aiTemplateApplyAll | boolean | 截图模版是否应用到全局
disabled | boolean | 空间是否被禁用
onDemandPull | boolean | 按需拉流开关
createdAt | integer | 空间创建时间
updatedAt | integer | 空间更新时间
retryInterval | integer | accessType为"pull"时，拉流中断重连间隔，单位为秒
retryCount | integer | accessType为"pull"时，拉流中断重连次数，单位为次
rtpAudio | boolean | 是否开启音频
rtpAudioTranscode | boolean | 是否开启音频转码
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"name":"test001235",
"accessType":"rtmp",
"urlMode":1,
"zone": "z1",
"domains":["tests6.com"],
"recordTemplateId":"2akrarrzr7rh5"
}'
**响应示例**
{
"id": "2akrars3nkw3s",
"name": "test001235",
"domains": [
"qiniu.com"
],
"accessType": "rtmp",
"urlMode": 1,
"zone": "z1",
"hlsLowLatency": false,
"createdAt": 1586750356,
"updatedAt": 1586750356,
"recordTemplateId": "2akrarrzr7rh5",
"recordTemplateApplyAll": false,
"snapshotTemplateApplyAll": false,
"aiTemplateApplyAll": false,
"disabled": false,
"onDemandPull": false,
"authMode": "expiryAuth",
"authExpire": 86400
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,371 |
删除空间 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 空间管理相关接口 >删除空间
# 删除空间
最近更新时间: 2020-05-06 15:28:51
# **描述**
本接口用于删除空间
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：DELETE
* 接口路径：`/v1/namespaces/{namespaceId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
# **响应参数**
无
# **示例**
**请求示例**
curl --request DELETE \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrars3nkw3s \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 空间管理相关接口 >删除空间
# 删除空间
最近更新时间: 2020-05-06 15:28:51
# **描述**
本接口用于删除空间
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：DELETE
* 接口路径：`/v1/namespaces/{namespaceId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
# **响应参数**
无
# **示例**
**请求示例**
curl --request DELETE \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrars3nkw3s \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,379 |
更新空间 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 空间管理相关接口 >更新空间
# 更新空间
最近更新时间: 2023-04-13 10:27:05
# **描述**
本接口用于更新空间信息
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：PATCH
* 接口路径：`/v1/namespaces/{namespaceId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations | 是 | op数组 | op集合，详见： _表一_
_表一：_ OP集合参数
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations.key | 是 | string | 要修改的参数
operations.op | 是 | string | op操作(目前支持replace和delete)
operations.value | 是 | object | 要修改的参数对应的value(当op为delete的时候可以忽略)
_表二：_ 可编辑参数说明
参数名称 | 字段类型 | 说明
---|---|---
name | string | 空间名称
desc | string | 空间描述
callBack | string | 回调地址
hlsLowLatency | boolean | HLS低延时开关
authMode | string | 鉴权模式，noUrlAuth：不开启鉴权，expiryAuth：开启url过期鉴权
authExpire | integer | 当鉴权模式为expiryAuth的鉴权过期时间
recordTemplateId | string | 录制模版ID
snapshotTemplateId | string | 截图模版ID
aiTemplateId | string | AI模版ID
recordTemplateApplyAll | boolean | 空间模版是否应用到全局
snapshotTemplateApplyAll | boolean | 截图模版是否应用到全局
aiTemplateApplyAll | boolean | ai模版是否应用到全局
onDemandPull | boolean | 按需拉流开关
retryInterval | integer | 空间接入类型为"主动拉流"时，拉流中断重连间隔
retryCount | integer | 空间接入类型为"主动拉流"时，拉流中断重连次数
rtpAudio | boolean | 是否开启音频
rtpAudioTranscode | boolean | 是否开启音频转码
# **响应参数**
与创建空间接口响应内容一致，请参阅创建空间[响应参数 __](https://developer.qiniu.io/qvs/api/6726/create-
namespace#3)
# **示例**
**请求示例**
curl --request PATCH \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrars3vpsxa \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{"operations":[{"key":"recordTemplateApplyAll","op":"replace","value":true}]
}'
**响应示例**
{
"id": "2akrars3vpsxa",
"name": "test001238",
"domains": [
"qiniu.com"
],
"accessType": "rtmp",
"urlMode": 1,
"hlsLowLatency": false,
""
"zone": "z0",
"createdAt": 1586764022,
"updatedAt": 1586780381,
"recordTemplateId": "2akrarrzr7rh5",
"recordTemplateApplyAll": true,
"snapshotTemplateApplyAll": false,
"disabled": false,
"onDemandPull": false,
"authMode": "expiryAuth",
"authExpire": 86400
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 空间管理相关接口 >更新空间
# 更新空间
最近更新时间: 2023-04-13 10:27:05
# **描述**
本接口用于更新空间信息
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：PATCH
* 接口路径：`/v1/namespaces/{namespaceId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations | 是 | op数组 | op集合，详见： _表一_
_表一：_ OP集合参数
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations.key | 是 | string | 要修改的参数
operations.op | 是 | string | op操作(目前支持replace和delete)
operations.value | 是 | object | 要修改的参数对应的value(当op为delete的时候可以忽略)
_表二：_ 可编辑参数说明
参数名称 | 字段类型 | 说明
---|---|---
name | string | 空间名称
desc | string | 空间描述
callBack | string | 回调地址
hlsLowLatency | boolean | HLS低延时开关
authMode | string | 鉴权模式，noUrlAuth：不开启鉴权，expiryAuth：开启url过期鉴权
authExpire | integer | 当鉴权模式为expiryAuth的鉴权过期时间
recordTemplateId | string | 录制模版ID
snapshotTemplateId | string | 截图模版ID
aiTemplateId | string | AI模版ID
recordTemplateApplyAll | boolean | 空间模版是否应用到全局
snapshotTemplateApplyAll | boolean | 截图模版是否应用到全局
aiTemplateApplyAll | boolean | ai模版是否应用到全局
onDemandPull | boolean | 按需拉流开关
retryInterval | integer | 空间接入类型为"主动拉流"时，拉流中断重连间隔
retryCount | integer | 空间接入类型为"主动拉流"时，拉流中断重连次数
rtpAudio | boolean | 是否开启音频
rtpAudioTranscode | boolean | 是否开启音频转码
# **响应参数**
与创建空间接口响应内容一致，请参阅创建空间[响应参数 __](https://developer.qiniu.io/qvs/api/6726/create-
namespace#3)
# **示例**
**请求示例**
curl --request PATCH \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrars3vpsxa \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{"operations":[{"key":"recordTemplateApplyAll","op":"replace","value":true}]
}'
**响应示例**
{
"id": "2akrars3vpsxa",
"name": "test001238",
"domains": [
"qiniu.com"
],
"accessType": "rtmp",
"urlMode": 1,
"hlsLowLatency": false,
""
"zone": "z0",
"createdAt": 1586764022,
"updatedAt": 1586780381,
"recordTemplateId": "2akrarrzr7rh5",
"recordTemplateApplyAll": true,
"snapshotTemplateApplyAll": false,
"disabled": false,
"onDemandPull": false,
"authMode": "expiryAuth",
"authExpire": 86400
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,381 |
查询空间信息 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 空间管理相关接口 >查询空间信息
# 查询空间信息
最近更新时间: 2023-12-22 15:11:47
# **描述**
本接口用于查询空间信息
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/namespaces/{namespaceId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
id | string | 空间ID
name | string | 空间名称
domains | string数组 | 静态类型（域名方式）接入时的域名信息
accessType | string | 接入类型,三种接入类型中的一种(rtmp,gb28181,pull,onvif)
~~rtmpUrlType~~(废弃,请使用urlMode) | integer | 推拉流地址计算方式，1:static（域名方式）, 2:dynamic（API动态获取）
urlMode | integer | 推拉流地址计算方式，1:static（域名方式）, 2:dynamic（API动态获取）
callBack | string | 回调地址
zone | string | zone为服务区域, 可根据流媒体实时处理、视频录制、截图的存储需求选择对应的区域, 可选项为z0, z1, z2, 默认为z0. z0表示华东, z1表示华北、z2表示华南
hlsLowLatency | boolean | HLS低延时开关
recordTemplateId | string | 录制模版ID
snapshotTemplateId | string | 截图模版ID
aiTemplateId | string | AI模版ID
recordTemplateApplyAll | boolean | 空间模版是否应用到全局
snapshotTemplateApplyAll | boolean | 截图模版是否应用到全局
aiTemplateApplyAll | boolean | AI模版是否应用到全局
disabled | boolean | 空间是否被禁用
deviceCount | integer | 接入设备的数量
streamCount | integer | 空间中流的数量
onlineStreamCount | integer | 空间中在线流数量
disabledStreamCount | integer | 空间中禁用流数量
sipAddrs | sip信息数组 | sip信息数组, 建议:`同一个空间设备量较大时，可从该数组中随机选取地址，而不是固定一个`
sipAddrs.sipServerId | string | accessType为gb28181时sip服务器地址，地址前10位为对应sip域
sipAddrs.sipServerIP | string | accessType为gb28181时sip服务器IP
sipAddrs.sipServerPort | string数组 | accessType为gb28181时sip服务器端口
createdAt | integer | 空间创建时间
updatedAt | integer | 空间更新时间
retryInterval | integer | accessType为"pull",即主动拉流时，代表拉流中断重连间隔，单位为秒
retryCount | integer | accessType为"pull",即主动拉流时，代表拉流中断重连次数，单位为次
rtpAudio | boolean | 是否开启音频
rtpAudioTranscode | boolean | 是否开启音频转码
desc | string | 空间描述信息
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrars3nkw3s \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"id": "2akrars3nkw3s",
"name": "test001235",
"domains": [
"qiniu.com"
],
"accessType": "rtmp",
"urlMode": 1,
"zone": "z0",
"hlsLowLatency": false,
"createdAt": 1586750356,
"updatedAt": 1586750356,
"recordTemplateId": "2akrarrzr7rh5",
"recordTemplateApplyAll": false,
"snapshotTemplateApplyAll": false,
"disabled": false,
"streamCount":2,
"onlineStreamCount":1,
"disabledStreamCount":1
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 空间管理相关接口 >查询空间信息
# 查询空间信息
最近更新时间: 2023-12-22 15:11:47
# **描述**
本接口用于查询空间信息
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/namespaces/{namespaceId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
id | string | 空间ID
name | string | 空间名称
domains | string数组 | 静态类型（域名方式）接入时的域名信息
accessType | string | 接入类型,三种接入类型中的一种(rtmp,gb28181,pull,onvif)
~~rtmpUrlType~~(废弃,请使用urlMode) | integer | 推拉流地址计算方式，1:static（域名方式）, 2:dynamic（API动态获取）
urlMode | integer | 推拉流地址计算方式，1:static（域名方式）, 2:dynamic（API动态获取）
callBack | string | 回调地址
zone | string | zone为服务区域, 可根据流媒体实时处理、视频录制、截图的存储需求选择对应的区域, 可选项为z0, z1, z2, 默认为z0. z0表示华东, z1表示华北、z2表示华南
hlsLowLatency | boolean | HLS低延时开关
recordTemplateId | string | 录制模版ID
snapshotTemplateId | string | 截图模版ID
aiTemplateId | string | AI模版ID
recordTemplateApplyAll | boolean | 空间模版是否应用到全局
snapshotTemplateApplyAll | boolean | 截图模版是否应用到全局
aiTemplateApplyAll | boolean | AI模版是否应用到全局
disabled | boolean | 空间是否被禁用
deviceCount | integer | 接入设备的数量
streamCount | integer | 空间中流的数量
onlineStreamCount | integer | 空间中在线流数量
disabledStreamCount | integer | 空间中禁用流数量
sipAddrs | sip信息数组 | sip信息数组, 建议:`同一个空间设备量较大时，可从该数组中随机选取地址，而不是固定一个`
sipAddrs.sipServerId | string | accessType为gb28181时sip服务器地址，地址前10位为对应sip域
sipAddrs.sipServerIP | string | accessType为gb28181时sip服务器IP
sipAddrs.sipServerPort | string数组 | accessType为gb28181时sip服务器端口
createdAt | integer | 空间创建时间
updatedAt | integer | 空间更新时间
retryInterval | integer | accessType为"pull",即主动拉流时，代表拉流中断重连间隔，单位为秒
retryCount | integer | accessType为"pull",即主动拉流时，代表拉流中断重连次数，单位为次
rtpAudio | boolean | 是否开启音频
rtpAudioTranscode | boolean | 是否开启音频转码
desc | string | 空间描述信息
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrars3nkw3s \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"id": "2akrars3nkw3s",
"name": "test001235",
"domains": [
"qiniu.com"
],
"accessType": "rtmp",
"urlMode": 1,
"zone": "z0",
"hlsLowLatency": false,
"createdAt": 1586750356,
"updatedAt": 1586750356,
"recordTemplateId": "2akrarrzr7rh5",
"recordTemplateApplyAll": false,
"snapshotTemplateApplyAll": false,
"disabled": false,
"streamCount":2,
"onlineStreamCount":1,
"disabledStreamCount":1
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,386 |
获取空间列表 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 空间管理相关接口 >获取空间列表
# 获取空间列表
最近更新时间: 2023-04-13 10:26:49
# **描述**
本接口用于获取空间列表
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/namespaces?offset=<offset>&line=<line>&sortBy=<SortBy>`
* Get请求，通过`非SDK`方式调用的客户，http头部Content-Type`要么置空`, `要么不要携带`[公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
offset | 否 | integer | 在全部namespace中的偏移量
line | 否 | integer | 一次返回多少条, 默认最多1万个
sortBy | 否 | string | asc 表示升序, desc 表示降序, 默认按创建时间降序排列(可参与排序的字段有createdAt, updatedAt).asc:updatedAt表示更新时间从小到大排序, desc:updatedAt表示更新时间从大到小排序
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
items | 空间数组 | 空间数组
items.id | string | 空间ID
items.name | string | 空间名称
items.domains | string数组 | rtmp 静态接入的时候的域名
items.accessType | string | 接入类型(四种之一 rtmp,gb28181,pull)
items.urlMode | integer | 推拉流地址计算方式，1:static, 2:dynamic
items.zone | string | zone为服务区域, 可根据流媒体实时处理、视频录制、截图的存储需求选择对应的区域, 可选项为z0, z1, z2, cn-east-2, 默认为z0. z0表示华东, z1表示华北、z2表示华南, cn-east-2表示华东-浙江2区
items.desc | string | 描述
items.callBack | string | 回调地址
items.recordTemplateId | string | 录制模版ID
items.snapshotTemplateId | string | 截图模版ID
items.aiTemplateId | string | AI模版ID
items.recordTemplateName | string | 录制模版名称
items.snapshotTemplateName | string | 截图模版名称
items.aiTemplateName | string | AI模版名称
items.recordTemplateApplyAll | boolean | 空间模版是否应用到全局
items.snapshotTemplateApplyAll | boolean | 截图模版是否应用到全局
items.aiTemplateApplyAll | boolean | AI模版是否应用到全局
items.disabled | boolean | 空间是否被禁用
items.createdAt | integer | 空间创建时间
items.updatedAt | integer | 空间更新时间
items.streamCount | integer | 空间中流的数量
items.onlineStreamCount | integer | 空间中在线流数量
items.disabledStreamCount | integer | 空间中禁用流数量
retryInterval | integer | accessType为"pull",即主动拉流时，代表拉流中断重连间隔
retryTime | integer | accessType为"pull",即主动拉流时，代表拉流中断重连次数
rtpAudio | boolean | 是否开启音频
rtpAudioTranscode | boolean | 是否开启音频转码
total | integer | 空间总共数
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/namespaces \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"items":[
{
"id": "d102sni9zryu",
"name": "test001",
"domains": null,
"accessType": "rtmp",
"urlMode": 2,
"zone": "z0",
"createdAt": 1584511799,
"updatedAt": 1584511799,
"disabledStreamCount": 2,
"recordTemplateApplyAll": false,
"snapshotTemplateApplyAll": false,
"aiTemplateApplyAll": false,
"disabled": false,
"streamCount":2,
"onlineStreamCount":1,
"disabledStreamCount":1
},
{
"id": "2akrarqr133ds",
"name": "test002",
"desc": "test",
"domains": null,
"accessType": "gb28181",
"urlMode": 0,
"zone": "z0",
"createdAt": 1583810197,
"updatedAt": 1583811193,
"recordTemplateApplyAll": false,
"snapshotTemplateApplyAll": false,
"aiTemplateApplyAll": false,
"disabled": false,
"streamCount":2,
"onlineStreamCount":1,
"disabledStreamCount":1
}
],
"total": 2
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 空间管理相关接口 >获取空间列表
# 获取空间列表
最近更新时间: 2023-04-13 10:26:49
# **描述**
本接口用于获取空间列表
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/namespaces?offset=<offset>&line=<line>&sortBy=<SortBy>`
* Get请求，通过`非SDK`方式调用的客户，http头部Content-Type`要么置空`, `要么不要携带`[公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
offset | 否 | integer | 在全部namespace中的偏移量
line | 否 | integer | 一次返回多少条, 默认最多1万个
sortBy | 否 | string | asc 表示升序, desc 表示降序, 默认按创建时间降序排列(可参与排序的字段有createdAt, updatedAt).asc:updatedAt表示更新时间从小到大排序, desc:updatedAt表示更新时间从大到小排序
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
items | 空间数组 | 空间数组
items.id | string | 空间ID
items.name | string | 空间名称
items.domains | string数组 | rtmp 静态接入的时候的域名
items.accessType | string | 接入类型(四种之一 rtmp,gb28181,pull)
items.urlMode | integer | 推拉流地址计算方式，1:static, 2:dynamic
items.zone | string | zone为服务区域, 可根据流媒体实时处理、视频录制、截图的存储需求选择对应的区域, 可选项为z0, z1, z2, cn-east-2, 默认为z0. z0表示华东, z1表示华北、z2表示华南, cn-east-2表示华东-浙江2区
items.desc | string | 描述
items.callBack | string | 回调地址
items.recordTemplateId | string | 录制模版ID
items.snapshotTemplateId | string | 截图模版ID
items.aiTemplateId | string | AI模版ID
items.recordTemplateName | string | 录制模版名称
items.snapshotTemplateName | string | 截图模版名称
items.aiTemplateName | string | AI模版名称
items.recordTemplateApplyAll | boolean | 空间模版是否应用到全局
items.snapshotTemplateApplyAll | boolean | 截图模版是否应用到全局
items.aiTemplateApplyAll | boolean | AI模版是否应用到全局
items.disabled | boolean | 空间是否被禁用
items.createdAt | integer | 空间创建时间
items.updatedAt | integer | 空间更新时间
items.streamCount | integer | 空间中流的数量
items.onlineStreamCount | integer | 空间中在线流数量
items.disabledStreamCount | integer | 空间中禁用流数量
retryInterval | integer | accessType为"pull",即主动拉流时，代表拉流中断重连间隔
retryTime | integer | accessType为"pull",即主动拉流时，代表拉流中断重连次数
rtpAudio | boolean | 是否开启音频
rtpAudioTranscode | boolean | 是否开启音频转码
total | integer | 空间总共数
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/namespaces \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"items":[
{
"id": "d102sni9zryu",
"name": "test001",
"domains": null,
"accessType": "rtmp",
"urlMode": 2,
"zone": "z0",
"createdAt": 1584511799,
"updatedAt": 1584511799,
"disabledStreamCount": 2,
"recordTemplateApplyAll": false,
"snapshotTemplateApplyAll": false,
"aiTemplateApplyAll": false,
"disabled": false,
"streamCount":2,
"onlineStreamCount":1,
"disabledStreamCount":1
},
{
"id": "2akrarqr133ds",
"name": "test002",
"desc": "test",
"domains": null,
"accessType": "gb28181",
"urlMode": 0,
"zone": "z0",
"createdAt": 1583810197,
"updatedAt": 1583811193,
"recordTemplateApplyAll": false,
"snapshotTemplateApplyAll": false,
"aiTemplateApplyAll": false,
"disabled": false,
"streamCount":2,
"onlineStreamCount":1,
"disabledStreamCount":1
}
],
"total": 2
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,392 |
禁用空间 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 空间管理相关接口 >禁用空间
# 禁用空间
最近更新时间: 2020-05-06 15:29:13
# **描述**
本接口用于禁用空间
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespacesId}/disabled`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespacesId | 是 | string | 空间ID
# **响应参数**
无
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/disabled \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 空间管理相关接口 >禁用空间
# 禁用空间
最近更新时间: 2020-05-06 15:29:13
# **描述**
本接口用于禁用空间
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespacesId}/disabled`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespacesId | 是 | string | 空间ID
# **响应参数**
无
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/disabled \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,399 |
启用空间 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 空间管理相关接口 >启用空间
# 启用空间
最近更新时间: 2020-05-06 15:29:18
# **描述**
本接口用于启用空间
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespacesId}/enabled`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespacesId | 是 | string | 空间ID
# **响应参数**
无
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/enabled \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 空间管理相关接口 >启用空间
# 启用空间
最近更新时间: 2020-05-06 15:29:18
# **描述**
本接口用于启用空间
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespacesId}/enabled`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespacesId | 是 | string | 空间ID
# **响应参数**
无
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/enabled \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,401 |
使用流接口必读 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >使用流接口必读
# 使用流接口必读
最近更新时间: 2023-07-07 19:09:16
**一.流id规则**
1.空间类型`gb28181`:设备类型为摄像头,流ID就是`设备国标ID`;设备类型是NVR(平台类型),流ID为`设备国标ID_通道国标ID`
2.空间类型为`rtmp`或者`主动拉流`:流ID就是`流名称`
3.空间类型为`onvif`,流ID就是`onvif设备ID`
4.对于录像回放，空间类型`gb28181`,设备类型为摄像头时，流ID格式为`设备国标ID_history_开始时间戳_结束时间戳`；当设备类型为平台时，流ID格式为`设备国标ID_通道ID_history_开始时间戳_结束时间戳`；假设目前有一个NVR国标ID为31011500991320020874，通道ID为34020000001310000001，希望观看2022-12-12
00:00:00到2022-12-12
23:59:59时间段内的录像，则流ID为:`31011500991320020874_34020000001310000001_history_1671638400_1671724799`，通过请求此接口可以获取到回放的流地址。注意这里的时间戳指的是unix时间戳，单位秒。
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >使用流接口必读
# 使用流接口必读
最近更新时间: 2023-07-07 19:09:16
**一.流id规则**
1.空间类型`gb28181`:设备类型为摄像头,流ID就是`设备国标ID`;设备类型是NVR(平台类型),流ID为`设备国标ID_通道国标ID`
2.空间类型为`rtmp`或者`主动拉流`:流ID就是`流名称`
3.空间类型为`onvif`,流ID就是`onvif设备ID`
4.对于录像回放，空间类型`gb28181`,设备类型为摄像头时，流ID格式为`设备国标ID_history_开始时间戳_结束时间戳`；当设备类型为平台时，流ID格式为`设备国标ID_通道ID_history_开始时间戳_结束时间戳`；假设目前有一个NVR国标ID为31011500991320020874，通道ID为34020000001310000001，希望观看2022-12-12
00:00:00到2022-12-12
23:59:59时间段内的录像，则流ID为:`31011500991320020874_34020000001310000001_history_1671638400_1671724799`，通过请求此接口可以获取到回放的流地址。注意这里的时间戳指的是unix时间戳，单位秒。
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,403 |
重置流状态 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >重置流状态
# 重置流状态
最近更新时间: 2022-09-29 15:35:15
# **描述**
本接口用于重置视频流的状态为`离线`
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/streams/resets`
* 使用场景：流实际离线了(设备没有推流),由于异常原因,获取的流状态却是在线状态,此时可通过本接口重置流为`离线`状态。
* 本接口不能被其他接口替代，只用于上面的异常情况使用
**请求 body参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
streamIds | 是 | string数组 | 需要重置的流id列表
# **响应参数**
200 ok
# **示例**
**请求示例**
curl --request POST \
--url 'qvs.qiniuapi.com/v1/namespaces/2akrarrzns76w/streams/resets' \
--header 'authorization: Qiniu xxxx:xxx'
--data '{
"streamIds":["111", "222"]
}'
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >重置流状态
# 重置流状态
最近更新时间: 2022-09-29 15:35:15
# **描述**
本接口用于重置视频流的状态为`离线`
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/streams/resets`
* 使用场景：流实际离线了(设备没有推流),由于异常原因,获取的流状态却是在线状态,此时可通过本接口重置流为`离线`状态。
* 本接口不能被其他接口替代，只用于上面的异常情况使用
**请求 body参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
streamIds | 是 | string数组 | 需要重置的流id列表
# **响应参数**
200 ok
# **示例**
**请求示例**
curl --request POST \
--url 'qvs.qiniuapi.com/v1/namespaces/2akrarrzns76w/streams/resets' \
--header 'authorization: Qiniu xxxx:xxx'
--data '{
"streamIds":["111", "222"]
}'
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,405 |
创建流 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >创建流
# 创建流
最近更新时间: 2022-12-12 12:05:11
# **描述**
本接口用于创建流（用于接入类型`非gb28181`的空间）
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/streams`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
streamId | 是 | string | 流名称, 流名称在空间中唯一，可包含 字母、数字、中划线、下划线；1 ~ 100 个字符长；创建后将不可修改
desc | 否 | string | 关于流的描述信息
recordTemplateId | 否 | string | 录制模版ID，配置流维度的录制模板，默认从空间继承
snapshotTemplateId | 否 | string | 截图模版ID，配置流维度的截图模板，默认从空间继承
aiTemplateId | 否 | string | AI模版ID，配置流维度的AI模板，默认从空间继承
pullType | 否 | string | 主动拉流模式的空间下，流的接入类型。rtsp/rtmp/http-flv/hls/other 拉流
pullAddr | 否 | string | 主动拉流模式的空间下，拉流地址
pullVideoModel | 否 | integer | 主动拉流模式的空间下，0代表视频源为实时流 1代表视频源为点播内容或静态文件
rtspModel | 否 | integer | 主动拉流模式的空间下，当拉流地址为rtsp时 0:代表udp拉流,1:代表tcp拉流。默认为0即udp
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
streamId | string | 流名称（流ID）
desc | string | 描述
nsId | string | 所属的空间ID
nsName | string | 所属的空间名称
recordTemplateId | string | 录制模版ID
snapshotTemplateId | string | 截图模版ID
aiTemplateId | string | AI模版ID
disabled | boolean | 流是否被禁用
lastPushedAt | integer | 最后一次推流时间,0:表示流从创建开始尚未进行过推流操作
status | bool | 流是否在线
pullType | string | 主动拉流模式的空间下，流的接入类型。rtsp/rtmp/http-flv/hls/other 拉流
pullAddr | string | 主动拉流模式的空间下，拉流地址
createdAt | integer | 流创建时间
updatedAt | integer | 流更新时间
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"streamId":"device009",
"recordTemplateId":"d102sns2mwhd"
}'
**响应示例**
{
"streamId": "device009",
"nsId": "d102sni9zryu",
"nsName": "test009",
"recordTemplateId": "d102sns2mwhd",
"snapshotTemplateId": "",
"aiTemplateId": "",
"createdAt": 1586832470,
"updatedAt": 1586832470,
"status": false,
"disabled": false,
"lastPushedAt": 0
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >创建流
# 创建流
最近更新时间: 2022-12-12 12:05:11
# **描述**
本接口用于创建流（用于接入类型`非gb28181`的空间）
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/streams`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
streamId | 是 | string | 流名称, 流名称在空间中唯一，可包含 字母、数字、中划线、下划线；1 ~ 100 个字符长；创建后将不可修改
desc | 否 | string | 关于流的描述信息
recordTemplateId | 否 | string | 录制模版ID，配置流维度的录制模板，默认从空间继承
snapshotTemplateId | 否 | string | 截图模版ID，配置流维度的截图模板，默认从空间继承
aiTemplateId | 否 | string | AI模版ID，配置流维度的AI模板，默认从空间继承
pullType | 否 | string | 主动拉流模式的空间下，流的接入类型。rtsp/rtmp/http-flv/hls/other 拉流
pullAddr | 否 | string | 主动拉流模式的空间下，拉流地址
pullVideoModel | 否 | integer | 主动拉流模式的空间下，0代表视频源为实时流 1代表视频源为点播内容或静态文件
rtspModel | 否 | integer | 主动拉流模式的空间下，当拉流地址为rtsp时 0:代表udp拉流,1:代表tcp拉流。默认为0即udp
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
streamId | string | 流名称（流ID）
desc | string | 描述
nsId | string | 所属的空间ID
nsName | string | 所属的空间名称
recordTemplateId | string | 录制模版ID
snapshotTemplateId | string | 截图模版ID
aiTemplateId | string | AI模版ID
disabled | boolean | 流是否被禁用
lastPushedAt | integer | 最后一次推流时间,0:表示流从创建开始尚未进行过推流操作
status | bool | 流是否在线
pullType | string | 主动拉流模式的空间下，流的接入类型。rtsp/rtmp/http-flv/hls/other 拉流
pullAddr | string | 主动拉流模式的空间下，拉流地址
createdAt | integer | 流创建时间
updatedAt | integer | 流更新时间
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"streamId":"device009",
"recordTemplateId":"d102sns2mwhd"
}'
**响应示例**
{
"streamId": "device009",
"nsId": "d102sni9zryu",
"nsName": "test009",
"recordTemplateId": "d102sns2mwhd",
"snapshotTemplateId": "",
"aiTemplateId": "",
"createdAt": 1586832470,
"updatedAt": 1586832470,
"status": false,
"disabled": false,
"lastPushedAt": 0
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,407 |
删除流 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >删除流
# 删除流
最近更新时间: 2022-05-20 12:29:39
# **描述**
本接口用于删除流
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：DELETE
* 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
streamId | 是 | string | 流ID
# **响应参数**
无
# **示例**
**请求示例**
curl --request DELETE \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams/device009 \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
code:200
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >删除流
# 删除流
最近更新时间: 2022-05-20 12:29:39
# **描述**
本接口用于删除流
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：DELETE
* 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
streamId | 是 | string | 流ID
# **响应参数**
无
# **示例**
**请求示例**
curl --request DELETE \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams/device009 \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
code:200
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,412 |
更新流 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >更新流
# 更新流
最近更新时间: 2022-05-20 12:29:30
# **描述**
本接口用于更新流信息
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：PATCH
* 接口路径：`/v1/namespaces/{namespacesId}/streams/{streamId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
streamId | 是 | string | 流ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations | 是 | op数组 | op集合，详见： _表一_
_表一：_ OP集合参数
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations.key | 是 | string | 要修改的参数
operations.op | 是 | string | op操作(目前支持replace和delete)
operations.value | 是 | object | 要修改的参数对应的value(当op为delete的时候可以忽略)
_表二：_ 可编辑参数说明
参数名称 | 字段类型 | 说明
---|---|---
desc | string | 流描述
recordTemplateId | string | 录制模版ID
snapshotTemplateId | string | 截图模版ID
diabled | boolean | 流是否被禁用
pullAddr | string | 主动拉流模式的空间下，拉流地址
# **响应参数**
与创建流接口响应内容一致，请参阅创建流[响应参数 __](https://developer.qiniu.io/qvs/api/6734/create-
flow#3)
# **示例**
**请求示例**
curl --request PATCH \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams/device009 \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{"operations":[{"key":"recordTemplateId","op":"replace","value":"d102sns2mwhd"}]
}'
**响应示例**
{
"streamId": "device009",
"nsId": "d102sni9zryu",
"nsName": "test009",
"recordTemplateId": "d102sns2mwhd",
"snapshotTemplateId": "",
"createdAt": 1586832470,
"updatedAt": 1586832470,
"status": false,
"disabled": false,
"lastPushedAt": 0
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >更新流
# 更新流
最近更新时间: 2022-05-20 12:29:30
# **描述**
本接口用于更新流信息
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：PATCH
* 接口路径：`/v1/namespaces/{namespacesId}/streams/{streamId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
streamId | 是 | string | 流ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations | 是 | op数组 | op集合，详见： _表一_
_表一：_ OP集合参数
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations.key | 是 | string | 要修改的参数
operations.op | 是 | string | op操作(目前支持replace和delete)
operations.value | 是 | object | 要修改的参数对应的value(当op为delete的时候可以忽略)
_表二：_ 可编辑参数说明
参数名称 | 字段类型 | 说明
---|---|---
desc | string | 流描述
recordTemplateId | string | 录制模版ID
snapshotTemplateId | string | 截图模版ID
diabled | boolean | 流是否被禁用
pullAddr | string | 主动拉流模式的空间下，拉流地址
# **响应参数**
与创建流接口响应内容一致，请参阅创建流[响应参数 __](https://developer.qiniu.io/qvs/api/6734/create-
flow#3)
# **示例**
**请求示例**
curl --request PATCH \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams/device009 \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{"operations":[{"key":"recordTemplateId","op":"replace","value":"d102sns2mwhd"}]
}'
**响应示例**
{
"streamId": "device009",
"nsId": "d102sni9zryu",
"nsName": "test009",
"recordTemplateId": "d102sns2mwhd",
"snapshotTemplateId": "",
"createdAt": 1586832470,
"updatedAt": 1586832470,
"status": false,
"disabled": false,
"lastPushedAt": 0
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,414 |
查询流信息 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >查询流信息
# 查询流信息
最近更新时间: 2022-12-12 12:05:17
# **描述**
本接口用于查询流信息。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
streamId | 是 | string | 空间为`gb28181`:设备类型为摄像头,流ID就是`设备国标ID`;设备类型是NVR(平台类型),流ID为`设备国标ID_通道国标ID`
空间类型为`rtmp`或者`主动拉流`:流ID就是`流名称`
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
streamId | string | 流ID
desc | string | 描述
nsId | string | 所属空间ID
nsName | string | 所属空间名称
recordTemplateId | string | 录制模版ID，默认从空间继承
snapshotTemplateId | string | 截图模版ID，默认从空间继承
aiTemplateId | string | AI模版ID，默认从空间继承
disabled | boolean | 流是否被禁用
lastPushedAt | integer | 最后一次推流时间，0:表示流从创建开始尚未进行过推流操作
pullType | string | 主动拉流模式的空间下，流的接入类型。rtsp/rtmp/http-flv/hls/other 拉流
pullAddr | string | 主动拉流模式的空间下，拉流地址
pullVideoModel | integer | 0:直播 1:点播
rtspModel | integer | rtsp传输协议。 0:udp 1:tcp
status | bool | 流是否在线
userCount | integer | 在线观看人数(只有在流在线的时候才会出现)
clientIp | string | 推流端IP(只有在流在线的时候才会出现)
audioFrameRate | integer | 直播流的实时音频帧率(只有在流在线的时候才会出现)
bitRate | integer | 直播流的实时码率(只有在流在线的时候才会出现)
videoFrameRate | integer | 直播流的实时视频帧率(只有在流在线的时候才会出现)
createdAt | integer | 流创建时间
updatedAt | integer | 流更新时间
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams/device009 \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"streamId": "device009",
"nsId": "d102sni9zryu",
"nsName": "test009",
"recordTemplateId": "d102sns2mwhd",
"snapshotTemplateId": "",
"aiTemplateId": "",
"createdAt": 1586832470,
"updatedAt": 1586832470,
"status": false,
"disabled": false,
"lastPushedAt": 0
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >查询流信息
# 查询流信息
最近更新时间: 2022-12-12 12:05:17
# **描述**
本接口用于查询流信息。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
streamId | 是 | string | 空间为`gb28181`:设备类型为摄像头,流ID就是`设备国标ID`;设备类型是NVR(平台类型),流ID为`设备国标ID_通道国标ID`
空间类型为`rtmp`或者`主动拉流`:流ID就是`流名称`
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
streamId | string | 流ID
desc | string | 描述
nsId | string | 所属空间ID
nsName | string | 所属空间名称
recordTemplateId | string | 录制模版ID，默认从空间继承
snapshotTemplateId | string | 截图模版ID，默认从空间继承
aiTemplateId | string | AI模版ID，默认从空间继承
disabled | boolean | 流是否被禁用
lastPushedAt | integer | 最后一次推流时间，0:表示流从创建开始尚未进行过推流操作
pullType | string | 主动拉流模式的空间下，流的接入类型。rtsp/rtmp/http-flv/hls/other 拉流
pullAddr | string | 主动拉流模式的空间下，拉流地址
pullVideoModel | integer | 0:直播 1:点播
rtspModel | integer | rtsp传输协议。 0:udp 1:tcp
status | bool | 流是否在线
userCount | integer | 在线观看人数(只有在流在线的时候才会出现)
clientIp | string | 推流端IP(只有在流在线的时候才会出现)
audioFrameRate | integer | 直播流的实时音频帧率(只有在流在线的时候才会出现)
bitRate | integer | 直播流的实时码率(只有在流在线的时候才会出现)
videoFrameRate | integer | 直播流的实时视频帧率(只有在流在线的时候才会出现)
createdAt | integer | 流创建时间
updatedAt | integer | 流更新时间
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams/device009 \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"streamId": "device009",
"nsId": "d102sni9zryu",
"nsName": "test009",
"recordTemplateId": "d102sns2mwhd",
"snapshotTemplateId": "",
"aiTemplateId": "",
"createdAt": 1586832470,
"updatedAt": 1586832470,
"status": false,
"disabled": false,
"lastPushedAt": 0
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,418 |
获取流列表 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >获取流列表
# 获取流列表
最近更新时间: 2022-12-12 12:05:24
# **描述**
本接口用于获取流列表。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/namespaces/{namespaceid}/streams?offset=<offset>&line=<line>&qtype=<qtype>&prefix=<prefix>&sortBy=<sortBy>`
* 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
qtype | 否 | integer | 查询流类型， 0:全部，1:在线流，2:离线流
prefix | 否 | string | 流ID 前缀，可根据`流ID`或者`描述`字段 进行前缀检索查询
sortBy | 否 | string | asc 表示升序，desc 表示降序，默认按创建时间降序排列(可参与排序的字段有createdAt、updatedAt、lastPushedAt)。asc:updatedAt表示更新时间从小到大排序，desc:updatedAt表示更新时间从大到小排序
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
items | 流数组 | 流数组
items.streamId | string | 流ID
items.desc | string | 描述
items.nsId | string | 所属空间ID
items.nsName | string | 所属空间名称
items.recordTemplateId | string | 录制模版ID
items.snapshotTemplateId | string | 截图模版ID
items.aiTemplateId | string | AI模版ID
items.recordTemplateName | string | 录制模版名称
items.snapshotTemplateName | string | 截图模版名称
items.aiTemplateName | string | AI模版名称
items.disabled | boolean | 流是否被禁用
items.lastPushedAt | integer | 最后一次推流时间，0:表示流从创建开始尚未进行过推流操作
pullType | 否 | string
pullAddr | 否 | string
pullVideoModel | 否 | integer
rtspModel | 否 | integer
items.status | bool | 流是否在线
items.createdAt | integer | 流创建时间
items.updatedAt | integer | 流更新时间
items.userCount | integer | 在线观看人数(只有在流在线的时候才会出现)
items.clientIp | integer | 推流端IP(只有在流在线的时候才会出现)
items.audioFrameRate | integer | 直播流的实时音频帧率(只有在流在线的时候才会出现)
items.bitRate | integer | 直播流的实时码率(只有在流在线的时候才会出现)
items.videoFrameRate | integer | 直播流的实时视频帧率(只有在流在线的时候才会出现)
total | integer | 空间下流总数
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrarrpj8lcl/streams \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"items": [
{
"streamId": "abcdef",
"nsId": "2akrarrpj8lcl",
"nsName": "test_name3",
"recordTemplateId": "2akrarrviqwvu",
"snapshotTemplateId": "",
"aiTemplateId": "",
"createdAt": 1586258862,
"updatedAt": 1586258862,
"status": false,
"disabled": false,
"lastPushedAt": 0
},
{
"streamId": "xcfdde",
"nsId": "2akrarrpj8lcl",
"nsName": "test_name3",
"recordTemplateId": "2akrarrpisqps",
"snapshotTemplateId": "",
"aiTemplateId": "",
"createdAt": 1585898236,
"updatedAt": 1585898236,
"status": false,
"disabled": false,
"lastPushedAt": 0
},
{
"streamId": "xcfdd",
"nsId": "2akrarrpj8lcl",
"nsName": "test_name3",
"recordTemplateId": "",
"snapshotTemplateId": "",
"aiTemplateId": "",
"createdAt": 1585896582,
"updatedAt": 1585896582,
"status": false,
"disabled": false,
"lastPushedAt": 0
}
],
"total": 3
}
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >获取流列表
# 获取流列表
最近更新时间: 2022-12-12 12:05:24
# **描述**
本接口用于获取流列表。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/namespaces/{namespaceid}/streams?offset=<offset>&line=<line>&qtype=<qtype>&prefix=<prefix>&sortBy=<sortBy>`
* 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
qtype | 否 | integer | 查询流类型， 0:全部，1:在线流，2:离线流
prefix | 否 | string | 流ID 前缀，可根据`流ID`或者`描述`字段 进行前缀检索查询
sortBy | 否 | string | asc 表示升序，desc 表示降序，默认按创建时间降序排列(可参与排序的字段有createdAt、updatedAt、lastPushedAt)。asc:updatedAt表示更新时间从小到大排序，desc:updatedAt表示更新时间从大到小排序
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
items | 流数组 | 流数组
items.streamId | string | 流ID
items.desc | string | 描述
items.nsId | string | 所属空间ID
items.nsName | string | 所属空间名称
items.recordTemplateId | string | 录制模版ID
items.snapshotTemplateId | string | 截图模版ID
items.aiTemplateId | string | AI模版ID
items.recordTemplateName | string | 录制模版名称
items.snapshotTemplateName | string | 截图模版名称
items.aiTemplateName | string | AI模版名称
items.disabled | boolean | 流是否被禁用
items.lastPushedAt | integer | 最后一次推流时间，0:表示流从创建开始尚未进行过推流操作
pullType | 否 | string
pullAddr | 否 | string
pullVideoModel | 否 | integer
rtspModel | 否 | integer
items.status | bool | 流是否在线
items.createdAt | integer | 流创建时间
items.updatedAt | integer | 流更新时间
items.userCount | integer | 在线观看人数(只有在流在线的时候才会出现)
items.clientIp | integer | 推流端IP(只有在流在线的时候才会出现)
items.audioFrameRate | integer | 直播流的实时音频帧率(只有在流在线的时候才会出现)
items.bitRate | integer | 直播流的实时码率(只有在流在线的时候才会出现)
items.videoFrameRate | integer | 直播流的实时视频帧率(只有在流在线的时候才会出现)
total | integer | 空间下流总数
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrarrpj8lcl/streams \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"items": [
{
"streamId": "abcdef",
"nsId": "2akrarrpj8lcl",
"nsName": "test_name3",
"recordTemplateId": "2akrarrviqwvu",
"snapshotTemplateId": "",
"aiTemplateId": "",
"createdAt": 1586258862,
"updatedAt": 1586258862,
"status": false,
"disabled": false,
"lastPushedAt": 0
},
{
"streamId": "xcfdde",
"nsId": "2akrarrpj8lcl",
"nsName": "test_name3",
"recordTemplateId": "2akrarrpisqps",
"snapshotTemplateId": "",
"aiTemplateId": "",
"createdAt": 1585898236,
"updatedAt": 1585898236,
"status": false,
"disabled": false,
"lastPushedAt": 0
},
{
"streamId": "xcfdd",
"nsId": "2akrarrpj8lcl",
"nsName": "test_name3",
"recordTemplateId": "",
"snapshotTemplateId": "",
"aiTemplateId": "",
"createdAt": 1585896582,
"updatedAt": 1585896582,
"status": false,
"disabled": false,
"lastPushedAt": 0
}
],
"total": 3
}
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,423 |
获取流地址 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >获取流地址
# 获取流地址
最近更新时间: 2022-05-20 13:53:01
# **获取流地址**
创建空间时时，需要选择是`静态地址`模式或`动态地址`模式，请根据空间设置的模式选择对应的接口获取流地址。
模式 | 说明
---|---
静态地址 | qvs域名系统用于实时的视频推流或播放,与客户在对象存储里配置的域名(视频回看)是独立的。
通过配置域名的方式接入，流地址既可以通过api获取,在不开启时间戳防盗链时,`地址是固定的, 也可以自行拼装`。
拼装格式:
1.rtmp，推流和播放格式:“rtmp://推流或播放域名:2045/空间id/流id”。
2.hls,http格式"http://播放域名:1240/空间id/流id.m3u8",https格式"https://播放域名:447/空间id/流id.m3u8"。
3.flv,http格式
“http://播放域名:1240/空间id/流id.flv”,https格式"https://播放域名:447/空间id/流id.flv"。
4.webrtc, http环境
“webrtc://播放域名:1240/空间id/流id”,https环境"webrtc://播放域名:447/空间id/流id"。
5.[流id规则 __](https://developer.qiniu.com/qvs/11878/use-the-stream-interface-
is-required)
6.`https`环境播放实时视频流 需要2个条件,
1:提供域名,配置cname解析,[`如何配置cname?`__](https://developer.qiniu.com/qvs/8746/configure-
cname)2.在qvs的域名管理界面,为该域名配置https证书。[`如何配置https证书?`__](https://developer.qiniu.com/qvs/6925/qvs-
https-configuration)
7.看不到域名配置管理界面?那是因为`新建空间`时,`模式`选择了动态地址,怎么办?
需要客户重建一个新空间，选择`静态地址`。客户如果不想新建空间时,需要提工单,我们在后台为客户转换空间模式.
动态地址 | 无需配置域名，流地址全部为IP形式，需通过API获取实时的流地址。
适用场景：
1.测试阶段，快速验证。
2.不想配置域名，能接受流地址通过API获取。
3\. http的播放环境。如果是`https`环境,`务必`使用上面的`静态地址`
**动态接入`不支持https`环境中播放, IP`不`固定，必须通过API获取最新流地址**
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >获取流地址
# 获取流地址
最近更新时间: 2022-05-20 13:53:01
# **获取流地址**
创建空间时时，需要选择是`静态地址`模式或`动态地址`模式，请根据空间设置的模式选择对应的接口获取流地址。
模式 | 说明
---|---
静态地址 | qvs域名系统用于实时的视频推流或播放,与客户在对象存储里配置的域名(视频回看)是独立的。
通过配置域名的方式接入，流地址既可以通过api获取,在不开启时间戳防盗链时,`地址是固定的, 也可以自行拼装`。
拼装格式:
1.rtmp，推流和播放格式:“rtmp://推流或播放域名:2045/空间id/流id”。
2.hls,http格式"http://播放域名:1240/空间id/流id.m3u8",https格式"https://播放域名:447/空间id/流id.m3u8"。
3.flv,http格式
“http://播放域名:1240/空间id/流id.flv”,https格式"https://播放域名:447/空间id/流id.flv"。
4.webrtc, http环境
“webrtc://播放域名:1240/空间id/流id”,https环境"webrtc://播放域名:447/空间id/流id"。
5.[流id规则 __](https://developer.qiniu.com/qvs/11878/use-the-stream-interface-
is-required)
6.`https`环境播放实时视频流 需要2个条件,
1:提供域名,配置cname解析,[`如何配置cname?`__](https://developer.qiniu.com/qvs/8746/configure-
cname)2.在qvs的域名管理界面,为该域名配置https证书。[`如何配置https证书?`__](https://developer.qiniu.com/qvs/6925/qvs-
https-configuration)
7.看不到域名配置管理界面?那是因为`新建空间`时,`模式`选择了动态地址,怎么办?
需要客户重建一个新空间，选择`静态地址`。客户如果不想新建空间时,需要提工单,我们在后台为客户转换空间模式.
动态地址 | 无需配置域名，流地址全部为IP形式，需通过API获取实时的流地址。
适用场景：
1.测试阶段，快速验证。
2.不想配置域名，能接受流地址通过API获取。
3\. http的播放环境。如果是`https`环境,`务必`使用上面的`静态地址`
**动态接入`不支持https`环境中播放, IP`不`固定，必须通过API获取最新流地址**
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,430 |
静态模式 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口
>[获取流地址](https://developer.qiniu.com/qvs/api/6740/obtain-flow-address) > 静态模式
# 静态模式
最近更新时间: 2023-05-19 15:36:54
# **描述**
本接口用于获得使用配置域名的方式接入到七牛视频监控的推拉流地址。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}/domain`
* 当空间类型为GBT28181时，设备类型为`摄像头`时，流ID就是设备国标ID；设备类型为`平台`时，流ID就是`设备国标ID_通道ID`的形式
* 对于本地录像回放，如果希望播放任意时间段内的录像，需要手动构造流ID。当设备类型为`摄像头`时，流ID格式为`设备国标ID_history_开始时间戳_结束时间戳`；当设备类型为`平台`时，流ID格式为`设备国标ID_通道ID_history_开始时间戳_结束时间戳`；假设目前有一个NVR国标ID为`31011500991320020874`，通道ID为`34020000001310000001`，希望观看`2022-12-12 00:00:00`到`2022-12-12 23:59:59`时间段内的录像，则流ID为:`31011500991320020874_34020000001310000001_history_1671638400_1671724799`，通过请求此接口可以获取到回放的流地址。注意这里的时间戳指的是`unix时间戳`，单位秒。
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
streamId | 是 | string | [`流id规则详情参考` __](https://developer.qiniu.com/qvs/11878/use-the-stream-interface-is-required)
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
domain | 是 | string | 域名
domainType | 是 | string | 域名类型,取值 “publishRtmp”:rtmp推流, “liveRtmp”:rtmp播放, “liveHls”:hls播放, “liveHdl”:flv播放, “liveWebrtc”:webrtc播放
urlExpireSec | 否 | integer | 流地址过期时间(单位为秒)
playExpireSec | 否 | integer | 播放过期时间(单位为秒)
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
publishUrl | string | rtmp推流地址
playUrls.rtmp | string | rtmp播放地址
playUrls.flv | string | flv播放地址
playUrls.hls | string | hls播放地址
playUrls.webrtc | string | webrtc播放地址
publishUrlExpired | integer | 流地址过期时间点(unix时间戳，单位second)
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams/device005/domain \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"domain": "qvs-live-hdl.qiniu.com",
"domainType": "liveHdl"
}'
**响应示例**
{
"playUrls": {
"flv": "http://qvs-live-hdl.qiniu.com:2045/d102sni9zryu/device005.flv?e=1587956536&token=6301b0c1a5cfa6a67c2249c4f9eedfd2"
},
"publishUrlExpired": 1587956536
}
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams/device005/domain \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"domain": "qvs-publish.qiniu.com",
"domainType": "publishRtmp"
}'
**响应示例**
{
"publishUrl": "rtmp://qvs-publish.qiniu.com:2045/d102sni9zryu/device005",
"publishUrlExpired": 1587956536
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口
>[获取流地址](https://developer.qiniu.com/qvs/api/6740/obtain-flow-address) > 静态模式
# 静态模式
最近更新时间: 2023-05-19 15:36:54
# **描述**
本接口用于获得使用配置域名的方式接入到七牛视频监控的推拉流地址。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}/domain`
* 当空间类型为GBT28181时，设备类型为`摄像头`时，流ID就是设备国标ID；设备类型为`平台`时，流ID就是`设备国标ID_通道ID`的形式
* 对于本地录像回放，如果希望播放任意时间段内的录像，需要手动构造流ID。当设备类型为`摄像头`时，流ID格式为`设备国标ID_history_开始时间戳_结束时间戳`；当设备类型为`平台`时，流ID格式为`设备国标ID_通道ID_history_开始时间戳_结束时间戳`；假设目前有一个NVR国标ID为`31011500991320020874`，通道ID为`34020000001310000001`，希望观看`2022-12-12 00:00:00`到`2022-12-12 23:59:59`时间段内的录像，则流ID为:`31011500991320020874_34020000001310000001_history_1671638400_1671724799`，通过请求此接口可以获取到回放的流地址。注意这里的时间戳指的是`unix时间戳`，单位秒。
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
streamId | 是 | string | [`流id规则详情参考` __](https://developer.qiniu.com/qvs/11878/use-the-stream-interface-is-required)
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
domain | 是 | string | 域名
domainType | 是 | string | 域名类型,取值 “publishRtmp”:rtmp推流, “liveRtmp”:rtmp播放, “liveHls”:hls播放, “liveHdl”:flv播放, “liveWebrtc”:webrtc播放
urlExpireSec | 否 | integer | 流地址过期时间(单位为秒)
playExpireSec | 否 | integer | 播放过期时间(单位为秒)
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
publishUrl | string | rtmp推流地址
playUrls.rtmp | string | rtmp播放地址
playUrls.flv | string | flv播放地址
playUrls.hls | string | hls播放地址
playUrls.webrtc | string | webrtc播放地址
publishUrlExpired | integer | 流地址过期时间点(unix时间戳，单位second)
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams/device005/domain \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"domain": "qvs-live-hdl.qiniu.com",
"domainType": "liveHdl"
}'
**响应示例**
{
"playUrls": {
"flv": "http://qvs-live-hdl.qiniu.com:2045/d102sni9zryu/device005.flv?e=1587956536&token=6301b0c1a5cfa6a67c2249c4f9eedfd2"
},
"publishUrlExpired": 1587956536
}
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams/device005/domain \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"domain": "qvs-publish.qiniu.com",
"domainType": "publishRtmp"
}'
**响应示例**
{
"publishUrl": "rtmp://qvs-publish.qiniu.com:2045/d102sni9zryu/device005",
"publishUrlExpired": 1587956536
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,433 |
动态模式 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口
>[获取流地址](https://developer.qiniu.com/qvs/api/6740/obtain-flow-address) > 动态模式
# 动态模式
最近更新时间: 2023-05-24 16:14:40
# **描述**
本接口根据推流端和播放端的公网IP，计算最合适的推流和播放地址。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}/urls`
* 当空间类型为GBT28181时，设备类型为`摄像头`时，流ID就是设备国标ID；设备类型为`平台`时，流ID就是`设备国标ID_通道ID`的形式
* 对于本地录像回放，如果希望播放任意时间段内的录像，需要手动拼接流ID。当设备类型为`摄像头`时，流ID格式为`设备国标ID_history_开始时间戳_结束时间戳`；当设备类型为`平台`时，流ID格式为`设备国标ID_通道ID_history_开始时间戳_结束时间戳`；假设目前有一个NVR国标ID为`31011500991320020874`，通道ID为`34020000001310000001`，希望观看`2022-12-12 00:00:00`到`2022-12-12 23:59:59`时间段内的录像，则流ID为:`31011500991320020874_34020000001310000001_history_1671638400_1671724799`，通过请求此接口可以获取到回放的流地址。注意这里的时间戳指的是`unix时间戳`，单位秒。
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
streamId | 是 | string | [流id规则 __](https://developer.qiniu.com/qvs/11878/use-the-stream-interface-is-required)
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
publishIp | 否 | string | 推流端公网IP地址。注：gb28181类型的空间可以不传。rtmp接入的空间在无法获取推流客户端ip时，可填充为127.0.0.1
playIp | 否 | string | 播放端公网IP。注：在无法获取播放端公网ip时，可以填充为127.0.0.1
urlExpireSec | 否 | integer | 流地址过期时间(单位为秒)
playExpireSec | 否 | integer | 播放过期时间(单位为秒)
**备注** :
1. 只传 publishIp,只返回推流地址。注：gb28181类型的空间，推流地址为空
2. 只传 playIp, 只返回播放地址。注：在无法感知到播放端的对外ip时，可以填充为127.0.0.1
3. 两个都传, 同时返回推拉流地址。注：gb28181类型的空间，推流地址为空。
4. 若域名配置中设置了防盗链过期时间，优先以域名配置为主
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
publishUrl | string | rtmp推流地址
playUrls.rtmp | string | rtmp播放地址
playUrls.flv | string | flv播放地址
playUrls.hls | string | hls播放地址
playUrls.webrtc | string | webrtc播放地址
publishUrlExpired | integer | 流地址过期时间点(unix时间戳，单位second)
onlineState | bool | 流的在线状态
disabled | bool | 流是否被禁用
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams/device005/urls \
--header 'authorization: QiniuStub j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"publishIp":"116.236.177.50",
"playIp":"116.236.177.50"
}'
**响应示例**
{
"publishUrl": "rtmp://47.105.118.51:2045/2akrars3vld9y/device009?e=1586922179&token=test123%3Al8rY2rRRKT182Hc7pymLMWX7how",
"playUrls": {
"rtmp": "rtmp://47.105.118.51:2045/2akrars3vld9y/device009?e=1586922179&token=test123%3Al8rY2rRRKT182Hc7pymLMWX7how",
"flv": "http://47.105.118.51:1360/2akrars3vld9y/device009.flv?e=1586922179&token=test123%3A4JyGGXWy4OKOuXF2LYfs3inxt0k",
"hls": "http://47.105.118.51:1370/2akrars3vld9y/device009.m3u8?e=1586922179&token=test123%3Ak6TOQ8vvsYnOTdjBcjnO6_m5uB0",
"webrtc": "webtrtc://47.105.118.51:1240/2akrars3vld9y/device009"
},
"publishUrlExpired": 1586922179
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口
>[获取流地址](https://developer.qiniu.com/qvs/api/6740/obtain-flow-address) > 动态模式
# 动态模式
最近更新时间: 2023-05-24 16:14:40
# **描述**
本接口根据推流端和播放端的公网IP，计算最合适的推流和播放地址。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}/urls`
* 当空间类型为GBT28181时，设备类型为`摄像头`时，流ID就是设备国标ID；设备类型为`平台`时，流ID就是`设备国标ID_通道ID`的形式
* 对于本地录像回放，如果希望播放任意时间段内的录像，需要手动拼接流ID。当设备类型为`摄像头`时，流ID格式为`设备国标ID_history_开始时间戳_结束时间戳`；当设备类型为`平台`时，流ID格式为`设备国标ID_通道ID_history_开始时间戳_结束时间戳`；假设目前有一个NVR国标ID为`31011500991320020874`，通道ID为`34020000001310000001`，希望观看`2022-12-12 00:00:00`到`2022-12-12 23:59:59`时间段内的录像，则流ID为:`31011500991320020874_34020000001310000001_history_1671638400_1671724799`，通过请求此接口可以获取到回放的流地址。注意这里的时间戳指的是`unix时间戳`，单位秒。
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
streamId | 是 | string | [流id规则 __](https://developer.qiniu.com/qvs/11878/use-the-stream-interface-is-required)
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
publishIp | 否 | string | 推流端公网IP地址。注：gb28181类型的空间可以不传。rtmp接入的空间在无法获取推流客户端ip时，可填充为127.0.0.1
playIp | 否 | string | 播放端公网IP。注：在无法获取播放端公网ip时，可以填充为127.0.0.1
urlExpireSec | 否 | integer | 流地址过期时间(单位为秒)
playExpireSec | 否 | integer | 播放过期时间(单位为秒)
**备注** :
1. 只传 publishIp,只返回推流地址。注：gb28181类型的空间，推流地址为空
2. 只传 playIp, 只返回播放地址。注：在无法感知到播放端的对外ip时，可以填充为127.0.0.1
3. 两个都传, 同时返回推拉流地址。注：gb28181类型的空间，推流地址为空。
4. 若域名配置中设置了防盗链过期时间，优先以域名配置为主
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
publishUrl | string | rtmp推流地址
playUrls.rtmp | string | rtmp播放地址
playUrls.flv | string | flv播放地址
playUrls.hls | string | hls播放地址
playUrls.webrtc | string | webrtc播放地址
publishUrlExpired | integer | 流地址过期时间点(unix时间戳，单位second)
onlineState | bool | 流的在线状态
disabled | bool | 流是否被禁用
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams/device005/urls \
--header 'authorization: QiniuStub j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"publishIp":"116.236.177.50",
"playIp":"116.236.177.50"
}'
**响应示例**
{
"publishUrl": "rtmp://47.105.118.51:2045/2akrars3vld9y/device009?e=1586922179&token=test123%3Al8rY2rRRKT182Hc7pymLMWX7how",
"playUrls": {
"rtmp": "rtmp://47.105.118.51:2045/2akrars3vld9y/device009?e=1586922179&token=test123%3Al8rY2rRRKT182Hc7pymLMWX7how",
"flv": "http://47.105.118.51:1360/2akrars3vld9y/device009.flv?e=1586922179&token=test123%3A4JyGGXWy4OKOuXF2LYfs3inxt0k",
"hls": "http://47.105.118.51:1370/2akrars3vld9y/device009.m3u8?e=1586922179&token=test123%3Ak6TOQ8vvsYnOTdjBcjnO6_m5uB0",
"webrtc": "webtrtc://47.105.118.51:1240/2akrars3vld9y/device009"
},
"publishUrlExpired": 1586922179
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,438 |
启用流 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >启用流
# 启用流
最近更新时间: 2022-05-20 12:29:54
# **描述**
本接口用于启用流
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{id}/streams/{streamId}/enabled`
* 当流为`禁用`状态时，需要`启用`后才能正常观看或推流；
* 空间接入类型为`主动拉流`时，该接口会主动回源拉流。
* 空间接入类型为`GB28181`时,该接口会重新开启设备推流。
* 空间接入类型为`rtmp`时，我们提供如下功能，来满足按需拉流，节省客户流量: 一.持续1分钟无人观看,自动中断并禁用推流 二.当有观众观看请求触发时，流会被自动启用，推流断就可以恢复推流。体验改功能，客户可以提工单，我们将在后台定向为客户启用该功能。`GB28181`或者`主动拉流`类型的空间，自带“按需拉流”，客户可以在qvs控制台空间信息面板里，打开或者关闭[按需拉流 __](https://developer.qiniu.com/qvs/7703/on-demand-pull-flow-introduced)。
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
streamId | 是 | string | 流ID
# **响应参数**
无
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams/device0059/enabled \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >启用流
# 启用流
最近更新时间: 2022-05-20 12:29:54
# **描述**
本接口用于启用流
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{id}/streams/{streamId}/enabled`
* 当流为`禁用`状态时，需要`启用`后才能正常观看或推流；
* 空间接入类型为`主动拉流`时，该接口会主动回源拉流。
* 空间接入类型为`GB28181`时,该接口会重新开启设备推流。
* 空间接入类型为`rtmp`时，我们提供如下功能，来满足按需拉流，节省客户流量: 一.持续1分钟无人观看,自动中断并禁用推流 二.当有观众观看请求触发时，流会被自动启用，推流断就可以恢复推流。体验改功能，客户可以提工单，我们将在后台定向为客户启用该功能。`GB28181`或者`主动拉流`类型的空间，自带“按需拉流”，客户可以在qvs控制台空间信息面板里，打开或者关闭[按需拉流 __](https://developer.qiniu.com/qvs/7703/on-demand-pull-flow-introduced)。
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
streamId | 是 | string | 流ID
# **响应参数**
无
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams/device0059/enabled \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,444 |
禁用流 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >禁用流
# 禁用流
最近更新时间: 2022-11-28 11:15:03
# **描述**
本接口用于禁用流
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{id}/streams/{streamId}/disabled`
* 执行本接口后, 既无法推流,也无关拉流观看; 正在推/观看的流也会被强制中断(同样适用于本地录像生成的历史流)。
* 与[`启用流` __](https://developer.qiniu.com/qvs/6739/enable-the-flow)天生一对，相辅相成
* 当需要恢复流操作时，可调用[`启用流` __](https://developer.qiniu.com/qvs/6739/enable-the-flow)。
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
streamId | 是 | string | 流ID
# **响应参数**
无
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams/device0059/disabled \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >禁用流
# 禁用流
最近更新时间: 2022-11-28 11:15:03
# **描述**
本接口用于禁用流
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{id}/streams/{streamId}/disabled`
* 执行本接口后, 既无法推流,也无关拉流观看; 正在推/观看的流也会被强制中断(同样适用于本地录像生成的历史流)。
* 与[`启用流` __](https://developer.qiniu.com/qvs/6739/enable-the-flow)天生一对，相辅相成
* 当需要恢复流操作时，可调用[`启用流` __](https://developer.qiniu.com/qvs/6739/enable-the-flow)。
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
streamId | 是 | string | 流ID
# **响应参数**
无
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams/device0059/disabled \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,446 |
停止推流 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >停止推流
# 停止推流
最近更新时间: 2022-05-20 12:30:01
# **描述**
本接口用于停止推流，仅适用于类型为`RTMP`的空间
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：`POST`
* 接口路径：`/v1/namespaces/{id}/streams/{streamId}/stop`
* 使用场景：当需要强制终止推流时，可以调用此接口；本接口可以被[禁用流 __](https://developer.qiniu.io/qvs/6738/disable-the-flow)替代。
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
streamId | 是 | string | 流ID
# **响应参数**
无
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams/device0059/stop \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >停止推流
# 停止推流
最近更新时间: 2022-05-20 12:30:01
# **描述**
本接口用于停止推流，仅适用于类型为`RTMP`的空间
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：`POST`
* 接口路径：`/v1/namespaces/{id}/streams/{streamId}/stop`
* 使用场景：当需要强制终止推流时，可以调用此接口；本接口可以被[禁用流 __](https://developer.qiniu.io/qvs/6738/disable-the-flow)替代。
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
streamId | 是 | string | 流ID
# **响应参数**
无
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams/device0059/stop \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,448 |
查询推流记录 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >查询推流记录
# 查询推流记录
最近更新时间: 2022-08-10 11:51:33
# **描述**
本接口用于查询推流历史记录
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}/pubhistories?start=<start>&end=<end>&offset=<offset>&line=<line>`
* Get请求，通过`非SDK`方式调用的客户，http头部Content-Type`要么置空`, `要么不要携带`; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
streamId | 是 | string | 流ID
start | 是 | integer | 推流开始时间(unix timestamp in second)
end | 是 | integer | 推流结束时间(unix timestamp in second)
line | 否 | integer | 一次返回多少条, 最大值1000条，当超过1000条时，需要结合offset 循环读取。
offset | 否 | integer | 偏移量。当数据较多，需要循环读取时使用。例如有2001条数据，初始值offset = 0, 第N次请求时offset = (N -1) * line
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
items | 推流历史记录数组 | 推流历史记录数组
items.start | integer | 推流开始时间(unix timestamp in second)
items.end | integer | 推流结束时间(unix timestamp in second)
items.type | string | 推流记录类型，实时流/历史流
items.duration | integer | 推流时长,单位为秒
total | integer | 查询到历史记录总数
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams/device009/pubhistories?start=1586828400&end=1586828425 \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"items":[
{
"start": 1586828404,
"end": 1586828420,
"duration": 16,
}
]
"total":1
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 流管理相关接口 >查询推流记录
# 查询推流记录
最近更新时间: 2022-08-10 11:51:33
# **描述**
本接口用于查询推流历史记录
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}/pubhistories?start=<start>&end=<end>&offset=<offset>&line=<line>`
* Get请求，通过`非SDK`方式调用的客户，http头部Content-Type`要么置空`, `要么不要携带`; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
streamId | 是 | string | 流ID
start | 是 | integer | 推流开始时间(unix timestamp in second)
end | 是 | integer | 推流结束时间(unix timestamp in second)
line | 否 | integer | 一次返回多少条, 最大值1000条，当超过1000条时，需要结合offset 循环读取。
offset | 否 | integer | 偏移量。当数据较多，需要循环读取时使用。例如有2001条数据，初始值offset = 0, 第N次请求时offset = (N -1) * line
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
items | 推流历史记录数组 | 推流历史记录数组
items.start | integer | 推流开始时间(unix timestamp in second)
items.end | integer | 推流结束时间(unix timestamp in second)
items.type | string | 推流记录类型，实时流/历史流
items.duration | integer | 推流时长,单位为秒
total | integer | 查询到历史记录总数
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/namespaces/d102sni9zryu/streams/device009/pubhistories?start=1586828400&end=1586828425 \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"items":[
{
"start": 1586828404,
"end": 1586828420,
"duration": 16,
}
]
"total":1
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,450 |
一对多语音对讲 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >一对多语音对讲
# 一对多语音对讲
最近更新时间: 2022-07-06 12:01:49
# **描述**
## 语音采集和发送的demo，可以参考[一对一语音对讲 __](https://developer.qiniu.com/qvs/8158/voice-
call)
## **接口分两个步骤进行**
## **`步骤1`:首先获取发送音频的url**
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/talks`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
gbids | 否 | string数组 | 需要对讲的国标id列表
version | 否 | string | 对讲国标协议版本，取值"2014"或"2016"，默认为"2014"，例如大部分大华摄像头为GBT 28181-2014版本对讲模式
transProtocol | 否 | string | 取值"tcp"或"udp"，流传输模式，默认"udp"
# **响应参数**
参数名称 | 字段类型 | 说明
---|---|---
items | array | items结构的数组
items.audioSendAddrForHttp | string | 用来发送音频数据的http地址，请求报文格式见`音频发送报文格式`
items.audioSendAddrForHttps | string | 用来发送音频https地址，请求报文格式见`音频发送报文格式`
items.gbid | string | 国标id
**注意** ：此url地址列表在连续1min内没有收到语音数据时，地址无效，需要重新请求步骤1中`talks`接口，获取新地址
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/talks \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json'
**响应示例**
{
"items": [
{
"audioSendAddrForHttp":"http://1945028622.cloudvdn.com/api/v1/gb28181?action=append_audio_pcm&id=31011500991320003732&ssrc=1623567",
"audioSendAddrForHttps":"https://1945028622.cloudvdn.com/api/v1/gb28181?action=append_audio_pcm&id=31011500991320003732&ssrc=1623567"
"gbid": "31011500991320003732"
},
{
"audioSendAddrForHttp":"http://1945028622.cloudvdn.com/api/v1/gb28181?action=append_audio_pcm&id=31011500991320003733&ssrc=1623568",
"audioSendAddrForHttps":"https://1945028622.cloudvdn.com/api/v1/gb28181?action=append_audio_pcm&id=31011500991320003733&ssrc=1623568"
"gbid": "31011500991320003732"
}
]
}
## **`步骤2`:向第一步返回的url地址发送音频。`从语音采集端可直接向改地址发送数据,不需要代理`**
## **音频发送报文格式**
* 接口地址：`步骤1`中接口返回
* 请求方式：POST
# **请求参数**
**路径参数**
null
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
base64_pcm | 是 | string | `base64`编码后的`g711a`格式音频数据,音频采样率务必`8000`, base64数据中不能有换行符\n
# **示例**
**请求示例**
curl --request POST \
--url https://1945028622.cloudvdn.com/api/v1/gb28181?action=append_audio_pcm&id=31011500991320003732&ssrc=1623567 \
--header 'content-type: application/json'
--data-raw '{
"base64_pcm":"1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1VVVVdXV1dVVVVVVVVTV1dTV1FRV1NRQV9TU1dfWVlXX0VJW11RX0NFW199IfXRcWlHawc32"
}'
**响应示例**
{
"code":0
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >一对多语音对讲
# 一对多语音对讲
最近更新时间: 2022-07-06 12:01:49
# **描述**
## 语音采集和发送的demo，可以参考[一对一语音对讲 __](https://developer.qiniu.com/qvs/8158/voice-
call)
## **接口分两个步骤进行**
## **`步骤1`:首先获取发送音频的url**
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/talks`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
gbids | 否 | string数组 | 需要对讲的国标id列表
version | 否 | string | 对讲国标协议版本，取值"2014"或"2016"，默认为"2014"，例如大部分大华摄像头为GBT 28181-2014版本对讲模式
transProtocol | 否 | string | 取值"tcp"或"udp"，流传输模式，默认"udp"
# **响应参数**
参数名称 | 字段类型 | 说明
---|---|---
items | array | items结构的数组
items.audioSendAddrForHttp | string | 用来发送音频数据的http地址，请求报文格式见`音频发送报文格式`
items.audioSendAddrForHttps | string | 用来发送音频https地址，请求报文格式见`音频发送报文格式`
items.gbid | string | 国标id
**注意** ：此url地址列表在连续1min内没有收到语音数据时，地址无效，需要重新请求步骤1中`talks`接口，获取新地址
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/talks \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json'
**响应示例**
{
"items": [
{
"audioSendAddrForHttp":"http://1945028622.cloudvdn.com/api/v1/gb28181?action=append_audio_pcm&id=31011500991320003732&ssrc=1623567",
"audioSendAddrForHttps":"https://1945028622.cloudvdn.com/api/v1/gb28181?action=append_audio_pcm&id=31011500991320003732&ssrc=1623567"
"gbid": "31011500991320003732"
},
{
"audioSendAddrForHttp":"http://1945028622.cloudvdn.com/api/v1/gb28181?action=append_audio_pcm&id=31011500991320003733&ssrc=1623568",
"audioSendAddrForHttps":"https://1945028622.cloudvdn.com/api/v1/gb28181?action=append_audio_pcm&id=31011500991320003733&ssrc=1623568"
"gbid": "31011500991320003732"
}
]
}
## **`步骤2`:向第一步返回的url地址发送音频。`从语音采集端可直接向改地址发送数据,不需要代理`**
## **音频发送报文格式**
* 接口地址：`步骤1`中接口返回
* 请求方式：POST
# **请求参数**
**路径参数**
null
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
base64_pcm | 是 | string | `base64`编码后的`g711a`格式音频数据,音频采样率务必`8000`, base64数据中不能有换行符\n
# **示例**
**请求示例**
curl --request POST \
--url https://1945028622.cloudvdn.com/api/v1/gb28181?action=append_audio_pcm&id=31011500991320003732&ssrc=1623567 \
--header 'content-type: application/json'
--data-raw '{
"base64_pcm":"1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1VVVVdXV1dVVVVVVVVTV1dTV1FRV1NRQV9TU1dfWVlXX0VJW11RX0NFW199IfXRcWlHawc32"
}'
**响应示例**
{
"code":0
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,453 |
私有信令透传 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >私有信令透传
# 私有信令透传
最近更新时间: 2022-02-15 15:41:54
# **描述**
本接口用于信令透传，用户可以同设备侧实现一些私有定制化的信令。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/devices/{gbId}/sipraw`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间Id
gbId | 是 | string | 设备国标Id
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
msg | 是 | string | 透传给设备的信令，可以是任意字符串
# **响应参数**
200
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/devices/31011500991320000028/sipraw \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json'
--data-raw '{
"msg":"MESSAGE sip:31011500991320000815@3101150000 SIP/2.0\r\nVia: SIP/2.0/UDP 127.0.0.1:5061;rport;branch=QvsGbB90055266\r\nFrom: <sip:[email protected]:5061>;tag=QvsGbF17394556\r\nTo: <sip:31011500991320000815@3101150000>\r\nCall-ID: 202076370427\r\nCSeq: 1618 MESSAGE\r\nContent-Type: Application/MANSCDP+xml\r\nMax-Forwards: 70\r\nUser-Agent: QVS/2.0.0(Lion)\r\nContent-Length: 149\r\n\r\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<Query>\r\n<CmdType>Catalog</CmdType>\r\n<SN>11112222</SN>\r\n<DeviceID>31011500991320000815</DeviceID>\r\n</Query>\r\n"
}'
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >私有信令透传
# 私有信令透传
最近更新时间: 2022-02-15 15:41:54
# **描述**
本接口用于信令透传，用户可以同设备侧实现一些私有定制化的信令。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/devices/{gbId}/sipraw`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间Id
gbId | 是 | string | 设备国标Id
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
msg | 是 | string | 透传给设备的信令，可以是任意字符串
# **响应参数**
200
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/devices/31011500991320000028/sipraw \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json'
--data-raw '{
"msg":"MESSAGE sip:31011500991320000815@3101150000 SIP/2.0\r\nVia: SIP/2.0/UDP 127.0.0.1:5061;rport;branch=QvsGbB90055266\r\nFrom: <sip:[email protected]:5061>;tag=QvsGbF17394556\r\nTo: <sip:31011500991320000815@3101150000>\r\nCall-ID: 202076370427\r\nCSeq: 1618 MESSAGE\r\nContent-Type: Application/MANSCDP+xml\r\nMax-Forwards: 70\r\nUser-Agent: QVS/2.0.0(Lion)\r\nContent-Length: 149\r\n\r\n<?xml version=\"1.0\" encoding=\"UTF-8\"?>\r\n<Query>\r\n<CmdType>Catalog</CmdType>\r\n<SN>11112222</SN>\r\n<DeviceID>31011500991320000815</DeviceID>\r\n</Query>\r\n"
}'
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,457 |
创建设备 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >创建设备
# 创建设备
最近更新时间: 2023-08-02 11:40:16
# **描述**
本接口用于创建设备。所有涉及设备的API，适用于接入类型为“GB/T 28181”或"onvif"的空间。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/devices`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
type | 是 | integer | 可选项为摄像头、平台两类，1：摄像头，2：平台。创建后不可修改，默认为1：摄像头
name | 是 | string | 设备名称（可包含 字母、数字、中划线、下划线，同时支持中文；1 ~ 100 个字符长）
gbId | 是 | string | 设备国标ID，要求全局唯一，该字段为空时，会自动创建gbid
username | 是 | string | 用户名，4 ~ 40位，可包含大写字母、小写字母、数字、中划线。当该字段为空时，默认值是设备国标ID
password | 是 | string | 密码，4 ~ 40位，可包含大写字母、小写字母、数字、中划线
pullIfRegister | 否 | boolean | 注册成功后启动拉流，默认关闭
desc | 否 | string | 关于设备的描述信息
alarmEnable | 否 | boolean | 是否开启设备报警，默认关闭
alarmMethods | 当空间类型为gb28181时需指定 | string | 接收报警类型列表。 alarmEnable为`True`时，此字段有效。多个报警类型以`,`分隔。
1为电话报警， 2为设备报警， 3为短信报警， 4为GPS报警， 5为视频报警， 6为设备故障报警，
7其他报警。例如同时接收`短信报警`和`视频报警`，传递参数为`"3,5"`, `alarmEnable`为`true`时,改字段`不`能为空
alarmTypesForRecord | 否 | string | alarmType列表，多个报警类型以`,`分隔，收到此列表中的任何一个报警类型，会触发录像。例如，如果希望收到`入侵检测报警`或者`运动目标检测报警`触发录像，则传递参数为`6,2`。关于报警类型的详细说明参考[报警类型说明 __](https://developer.qiniu.com/qvs/7775/gb-alarm-events-list#2)。对应的流需要先绑定`按需录制模板`。此配置项只针对alarmMethod为`5`时，即`视频报警`
recordTime | 当`alarmTypesForRecord`不为空时需指定 | int | 如果开启了收到报警触发录像，则需要传此参数设置录像的时长，单位为秒。
alarmTypesForSnap | 否 | string | alarmType列表，多个报警类型以`,`分隔，收到此列表中的任何一个报警类型，会触发截图。例如，如果希望收到`入侵检测报警`或者`运动目标检测报警`触发截图，则传递参数为`6,2`。关于报警类型的详细说明参考[报警类型说明 __](https://developer.qiniu.com/qvs/7775/gb-alarm-events-list#2)。对应的流需要先绑定`按需录制模板`。此配置项只针对alarmMethod为`5`时，即`视频报警`
localRecordPushEnable | 否 | boolean | 本地录像上传开关。如果关闭此开关，本地录像上传云端接口无效。默认false
localRecordTemplate | 否 | string | 录制模板ID；localRecordPushEnable为`True`时，此字段有效
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`时有效
deviceIp | 当空间类型为onvif时需指定 | string | 设备IP地址
onvifPort | 当空间类型为onvif时需指定 | integer | 设备onvif端口
onvifUsername | 当空间类型为onvif时需指定 | string | onvif用户名
onvifPasswd | 当空间类型为onvif时需指定 | string | onvif密码
onvifStreamPort | 当空间类型为onvif时需指定 | integer | onvif流地址映射到公网的端口号，默认值为554
rtpProtocol | 否 | string | 流传输协议，默认`tcp`协议，可选值`tcp`或`udp`
rtpAudio | 否 | boolean | 是否开启音频
rtpAudioTranscode | 否 | boolean | 是否开启音频转码
onDemandPull | 否 | boolean | 是否开启按需拉流
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
name | string | 设备名称
desc | string | 设备描述
nsId | string | 所属的空间ID
nsName | string | 所属的空间名称
gbId | string | 设备国标ID
state | string | 状态（offline：离线，online：在线，notReg：未注册，locked：锁定）
username | string | 用户名
password | string | 密码
pullIfRegister | boolean | 注册成功后启动拉流，默认关闭
channels | integer | 设备通道数
vendor | string | 厂商
createdAt | integer | 创建时间，Unix时间戳，秒
updatedAt | integer | 更新时间，Unix时间戳，秒
lastRegisterAt | integer | 上一次注册时间，Unix时间戳，秒
lastKeepaliveAt | integer | 上一次心跳时间，Unix时间戳，秒
deviceId | string | 设备ID
rtpAudio | boolean | 是否开启音频
rtpAudioTranscode | boolean | 是否开启音频转码
onDemandPull | boolean | 是否开启按需拉流
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/devices \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"name": "device1",
"desc": "test gb28181",
"username": "username",
"password": "password",
"location": {
"enable": true,
"type": 1,
"interval": 5
}
}'
**响应示例**
{
"name": "device1",
"desc": "test gb28181",
"nsId": "2akrarvzvyijd",
"nsName": "gbt",
"gbId": "31011500991320000028",
"state": "notReg",
"username": "username",
"password": "password",
"pullIfRegister": false,
"createdAt": 1596166110,
"updatedAt": 1596166110,
"channels": 0,
"lastRegisterAt": 0,
"lastKeepaliveAt": 0,
"deviceId": "100000035",
}
**注意**
每个设备会创建一路流，普通设备以 GBId 作为stramId，平台设备以 设备国标ID_通道国标ID 作为streamId
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >创建设备
# 创建设备
最近更新时间: 2023-08-02 11:40:16
# **描述**
本接口用于创建设备。所有涉及设备的API，适用于接入类型为“GB/T 28181”或"onvif"的空间。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/devices`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
type | 是 | integer | 可选项为摄像头、平台两类，1：摄像头，2：平台。创建后不可修改，默认为1：摄像头
name | 是 | string | 设备名称（可包含 字母、数字、中划线、下划线，同时支持中文；1 ~ 100 个字符长）
gbId | 是 | string | 设备国标ID，要求全局唯一，该字段为空时，会自动创建gbid
username | 是 | string | 用户名，4 ~ 40位，可包含大写字母、小写字母、数字、中划线。当该字段为空时，默认值是设备国标ID
password | 是 | string | 密码，4 ~ 40位，可包含大写字母、小写字母、数字、中划线
pullIfRegister | 否 | boolean | 注册成功后启动拉流，默认关闭
desc | 否 | string | 关于设备的描述信息
alarmEnable | 否 | boolean | 是否开启设备报警，默认关闭
alarmMethods | 当空间类型为gb28181时需指定 | string | 接收报警类型列表。 alarmEnable为`True`时，此字段有效。多个报警类型以`,`分隔。
1为电话报警， 2为设备报警， 3为短信报警， 4为GPS报警， 5为视频报警， 6为设备故障报警，
7其他报警。例如同时接收`短信报警`和`视频报警`，传递参数为`"3,5"`, `alarmEnable`为`true`时,改字段`不`能为空
alarmTypesForRecord | 否 | string | alarmType列表，多个报警类型以`,`分隔，收到此列表中的任何一个报警类型，会触发录像。例如，如果希望收到`入侵检测报警`或者`运动目标检测报警`触发录像，则传递参数为`6,2`。关于报警类型的详细说明参考[报警类型说明 __](https://developer.qiniu.com/qvs/7775/gb-alarm-events-list#2)。对应的流需要先绑定`按需录制模板`。此配置项只针对alarmMethod为`5`时，即`视频报警`
recordTime | 当`alarmTypesForRecord`不为空时需指定 | int | 如果开启了收到报警触发录像，则需要传此参数设置录像的时长，单位为秒。
alarmTypesForSnap | 否 | string | alarmType列表，多个报警类型以`,`分隔，收到此列表中的任何一个报警类型，会触发截图。例如，如果希望收到`入侵检测报警`或者`运动目标检测报警`触发截图，则传递参数为`6,2`。关于报警类型的详细说明参考[报警类型说明 __](https://developer.qiniu.com/qvs/7775/gb-alarm-events-list#2)。对应的流需要先绑定`按需录制模板`。此配置项只针对alarmMethod为`5`时，即`视频报警`
localRecordPushEnable | 否 | boolean | 本地录像上传开关。如果关闭此开关，本地录像上传云端接口无效。默认false
localRecordTemplate | 否 | string | 录制模板ID；localRecordPushEnable为`True`时，此字段有效
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`时有效
deviceIp | 当空间类型为onvif时需指定 | string | 设备IP地址
onvifPort | 当空间类型为onvif时需指定 | integer | 设备onvif端口
onvifUsername | 当空间类型为onvif时需指定 | string | onvif用户名
onvifPasswd | 当空间类型为onvif时需指定 | string | onvif密码
onvifStreamPort | 当空间类型为onvif时需指定 | integer | onvif流地址映射到公网的端口号，默认值为554
rtpProtocol | 否 | string | 流传输协议，默认`tcp`协议，可选值`tcp`或`udp`
rtpAudio | 否 | boolean | 是否开启音频
rtpAudioTranscode | 否 | boolean | 是否开启音频转码
onDemandPull | 否 | boolean | 是否开启按需拉流
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
name | string | 设备名称
desc | string | 设备描述
nsId | string | 所属的空间ID
nsName | string | 所属的空间名称
gbId | string | 设备国标ID
state | string | 状态（offline：离线，online：在线，notReg：未注册，locked：锁定）
username | string | 用户名
password | string | 密码
pullIfRegister | boolean | 注册成功后启动拉流，默认关闭
channels | integer | 设备通道数
vendor | string | 厂商
createdAt | integer | 创建时间，Unix时间戳，秒
updatedAt | integer | 更新时间，Unix时间戳，秒
lastRegisterAt | integer | 上一次注册时间，Unix时间戳，秒
lastKeepaliveAt | integer | 上一次心跳时间，Unix时间戳，秒
deviceId | string | 设备ID
rtpAudio | boolean | 是否开启音频
rtpAudioTranscode | boolean | 是否开启音频转码
onDemandPull | boolean | 是否开启按需拉流
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/devices \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"name": "device1",
"desc": "test gb28181",
"username": "username",
"password": "password",
"location": {
"enable": true,
"type": 1,
"interval": 5
}
}'
**响应示例**
{
"name": "device1",
"desc": "test gb28181",
"nsId": "2akrarvzvyijd",
"nsName": "gbt",
"gbId": "31011500991320000028",
"state": "notReg",
"username": "username",
"password": "password",
"pullIfRegister": false,
"createdAt": 1596166110,
"updatedAt": 1596166110,
"channels": 0,
"lastRegisterAt": 0,
"lastKeepaliveAt": 0,
"deviceId": "100000035",
}
**注意**
每个设备会创建一路流，普通设备以 GBId 作为stramId，平台设备以 设备国标ID_通道国标ID 作为streamId
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,459 |
批量创建设备 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >批量创建设备
# 批量创建设备
最近更新时间: 2023-04-13 10:26:25
# **描述**
本接口用于批量创建设备。所有涉及设备的API，仅适用于接入类型为“GB/T 28181”的空间。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/batches`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
cameraNum | 是 | integer | 摄像头数量
platformNum | 是 | integer | 平台数量
BatchName | 是 | string | 批次名称
pullIfRegister | 是 | bool | 注册后是否启用拉流
alarmEnable | 是 | bool | 是否启用报警
autoCreate | 是 | bool | true：自动生成，false：批量上传（**目前仅支持自动生成方式，批量上传正在开发中** ）
alarmMethods | 否 | string | 报警的类型，当`alarmEnable`为true时需要
devices | 否 | array | 批量上传时需要的设备数组
devices.gbId | 是 | string | 设备国标id
devices.name | 是 | string | 设备名称
devices.username | 是 | string | 用户名
devices.password | 是 | string | 密码
devices.rtpAudio | 否 | boolean | 是否开启音频
devices.rtpAudioTranscode | 否 | boolean | 是否开启音频转码
devices.onDemandPull | 否 | boolean | 是否开启按需拉流
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
id | string | 批次ID
cameraNum | integer | 摄像头数量
platformNum | integer | 平台数量
batchName | string | 批次名称
autoCreate | bool | true：自动生成，false：批量上传
nsId | string | 空间ID
createTime | integer | 创建时间（单位秒）
rtpAudio | boolean | 是否开启音频
rtpAudioTranscode | boolean | 是否开启音频转码
onDemandPull | boolean | 是否开启按需拉流
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/batches \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data-raw '{
"cameraNum": 1,
"platformNum": 1,
"batchName": "batch_name",
"pullIfRegister": false,
"alarmEnable": false,
"autoCreate": true
}'
**响应示例**
{
"id": "3gzh7xdrfskl6",
"cameraNum": 1,
"platformNum": 1,
"batchName": "batch_name",
"nsId": "2akrarvzvyijd",
"createTime": 1637652453,
"autoCreate": true
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >批量创建设备
# 批量创建设备
最近更新时间: 2023-04-13 10:26:25
# **描述**
本接口用于批量创建设备。所有涉及设备的API，仅适用于接入类型为“GB/T 28181”的空间。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/batches`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
cameraNum | 是 | integer | 摄像头数量
platformNum | 是 | integer | 平台数量
BatchName | 是 | string | 批次名称
pullIfRegister | 是 | bool | 注册后是否启用拉流
alarmEnable | 是 | bool | 是否启用报警
autoCreate | 是 | bool | true：自动生成，false：批量上传（**目前仅支持自动生成方式，批量上传正在开发中** ）
alarmMethods | 否 | string | 报警的类型，当`alarmEnable`为true时需要
devices | 否 | array | 批量上传时需要的设备数组
devices.gbId | 是 | string | 设备国标id
devices.name | 是 | string | 设备名称
devices.username | 是 | string | 用户名
devices.password | 是 | string | 密码
devices.rtpAudio | 否 | boolean | 是否开启音频
devices.rtpAudioTranscode | 否 | boolean | 是否开启音频转码
devices.onDemandPull | 否 | boolean | 是否开启按需拉流
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
id | string | 批次ID
cameraNum | integer | 摄像头数量
platformNum | integer | 平台数量
batchName | string | 批次名称
autoCreate | bool | true：自动生成，false：批量上传
nsId | string | 空间ID
createTime | integer | 创建时间（单位秒）
rtpAudio | boolean | 是否开启音频
rtpAudioTranscode | boolean | 是否开启音频转码
onDemandPull | boolean | 是否开启按需拉流
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/batches \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data-raw '{
"cameraNum": 1,
"platformNum": 1,
"batchName": "batch_name",
"pullIfRegister": false,
"alarmEnable": false,
"autoCreate": true
}'
**响应示例**
{
"id": "3gzh7xdrfskl6",
"cameraNum": 1,
"platformNum": 1,
"batchName": "batch_name",
"nsId": "2akrarvzvyijd",
"createTime": 1637652453,
"autoCreate": true
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,468 |
获取批次列表 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >获取批次列表
# 获取批次列表
最近更新时间: 2022-08-10 11:17:55
# **描述**
本接口用于查询批次列表。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/namespaces/{namespaceId}/batches?offset=<offset>&line=<line>&name=<name>`
* 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 | 在全部批次中的偏移量, 当需要循环读取时, 第N次请求时offset = (N -1) * line
name | 否 | string | 搜索所有批次名包含`name`的批次
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
items | array | `Batch`结构的数组
items.id | string | 批次ID
items.cameraNum | integer | 摄像头数量
items.platformNum | integer | 平台数量
items.batchName | string | 批次名称
items.autoCreate | bool | true：自动生成，false：批量上传
items.nsId | string | 空间ID
items.createTime | integer | 创建时间(单位秒)
total | integer | 含有多少条
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/namespaces/2akras1vdttwy/batches \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
**响应示例**
{
"items": [
{
"id": "3gzh7xdrfskl6",
"cameraNum": 1,
"platformNum": 1,
"batchName": "batch_name",
"nsId": "2akras1vdttwy",
"createTime": 1637652453,
"autoCreate": true
}
],
"total": 1
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >获取批次列表
# 获取批次列表
最近更新时间: 2022-08-10 11:17:55
# **描述**
本接口用于查询批次列表。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/namespaces/{namespaceId}/batches?offset=<offset>&line=<line>&name=<name>`
* 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 | 在全部批次中的偏移量, 当需要循环读取时, 第N次请求时offset = (N -1) * line
name | 否 | string | 搜索所有批次名包含`name`的批次
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
items | array | `Batch`结构的数组
items.id | string | 批次ID
items.cameraNum | integer | 摄像头数量
items.platformNum | integer | 平台数量
items.batchName | string | 批次名称
items.autoCreate | bool | true：自动生成，false：批量上传
items.nsId | string | 空间ID
items.createTime | integer | 创建时间(单位秒)
total | integer | 含有多少条
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/namespaces/2akras1vdttwy/batches \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
**响应示例**
{
"items": [
{
"id": "3gzh7xdrfskl6",
"cameraNum": 1,
"platformNum": 1,
"batchName": "batch_name",
"nsId": "2akras1vdttwy",
"createTime": 1637652453,
"autoCreate": true
}
],
"total": 1
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,473 |
获取批次设备信息 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >获取批次设备信息
# 获取批次设备信息
最近更新时间: 2023-04-13 10:26:13
# 描述
本接口用于获取指定批次的所有设备信息。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/namespaces/{namespaceId}/batches/{id}/devices`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
id | 是 | string | 批次ID
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
devices | array | `device`类型数组，具体结构如下
devices.name | string | 设备名称
devices.desc | string | 设备描述
devices.type | integer | 类型, 1: 摄像头, 2: 平台
devices.nsId | string | 所属的空间ID
devices.nsName | string | 所属的空间名称
devices.gbId | string | 设备国标ID
devices.state | string | 状态（offline: 离线, online: 在线,notReg: 未注册, locked: 锁定）
devices.username | string | 用户名
devices.password | string | 密码
devices.pullIfRegister | boolean | 注册成功后启动拉流, 默认关闭
devices.vendor | string | 厂商
devices.createdAt | integer | 创建时间，Unix时间戳，秒
devices.updatedAt | integer | 更新时间，Unix时间戳，秒
devices.lastKeepaliveAt | integer | 最近心跳时间, Unix时间戳, 秒
devices.lastRegisterAt | integer | 最近注册时间, Unix时间戳, 秒
devices.alarmEnable | boolen | 是否开启国标报警
devices.alarmMethods | string | 接收报警类型列表。 alarmEnable为`True`时，此字段有效。多个报警类型以`,`分隔。
1为电话报警， 2为设备报警， 3为短信报警， 4为GPS报警， 5为视频报警， 6为设备故障报警，
7其他报警。例如同时接收`短信报警`和`视频报警`，传递参数为`"3,5"`
devices.localRecordPushEnable | boolean | 本地录像上传开关，默认关闭。如果关闭此开关，本地录像上传云端接口无效
devices.localRecordTemplate | string | 开启本地录像上传开关后，配置录制模板
devices.batchId | string | 所属的批次id
devices.rtpAudio | boolean | 是否开启音频
devices.rtpAudioTranscode | boolean | 是否开启音频转码
devices.onDemandPull | boolean | 是否开启按需拉流
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/namespaces/2akras1vdttwy/batches/3gzh7xdrfskl6/devices \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
**响应示例**
{
"devices": [
{
"name": "31011500991320000212",
"type": 1,
"nsId": "2akras1vdttwy",
"nsName": "gb-test1",
"gbId": "31011500991320000212",
"state": "notReg",
"username": "31011500991320000212",
"password": "iL-2",
"pullIfRegister": false,
"createdAt": 1637652453,
"updatedAt": 1637652453,
"channels": 1,
"lastRegisterAt": 0,
"lastKeepaliveAt": 0,
"cruiseGroups": [],
"alarmEnable": false,
"alarmMethods": "",
"localRecordPushEnable": false,
"localRecordTemplate": "",
"batchId": "3gzh7xdrfskl6"
}
]
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >获取批次设备信息
# 获取批次设备信息
最近更新时间: 2023-04-13 10:26:13
# 描述
本接口用于获取指定批次的所有设备信息。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/namespaces/{namespaceId}/batches/{id}/devices`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
id | 是 | string | 批次ID
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
devices | array | `device`类型数组，具体结构如下
devices.name | string | 设备名称
devices.desc | string | 设备描述
devices.type | integer | 类型, 1: 摄像头, 2: 平台
devices.nsId | string | 所属的空间ID
devices.nsName | string | 所属的空间名称
devices.gbId | string | 设备国标ID
devices.state | string | 状态（offline: 离线, online: 在线,notReg: 未注册, locked: 锁定）
devices.username | string | 用户名
devices.password | string | 密码
devices.pullIfRegister | boolean | 注册成功后启动拉流, 默认关闭
devices.vendor | string | 厂商
devices.createdAt | integer | 创建时间，Unix时间戳，秒
devices.updatedAt | integer | 更新时间，Unix时间戳，秒
devices.lastKeepaliveAt | integer | 最近心跳时间, Unix时间戳, 秒
devices.lastRegisterAt | integer | 最近注册时间, Unix时间戳, 秒
devices.alarmEnable | boolen | 是否开启国标报警
devices.alarmMethods | string | 接收报警类型列表。 alarmEnable为`True`时，此字段有效。多个报警类型以`,`分隔。
1为电话报警， 2为设备报警， 3为短信报警， 4为GPS报警， 5为视频报警， 6为设备故障报警，
7其他报警。例如同时接收`短信报警`和`视频报警`，传递参数为`"3,5"`
devices.localRecordPushEnable | boolean | 本地录像上传开关，默认关闭。如果关闭此开关，本地录像上传云端接口无效
devices.localRecordTemplate | string | 开启本地录像上传开关后，配置录制模板
devices.batchId | string | 所属的批次id
devices.rtpAudio | boolean | 是否开启音频
devices.rtpAudioTranscode | boolean | 是否开启音频转码
devices.onDemandPull | boolean | 是否开启按需拉流
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/namespaces/2akras1vdttwy/batches/3gzh7xdrfskl6/devices \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
**响应示例**
{
"devices": [
{
"name": "31011500991320000212",
"type": 1,
"nsId": "2akras1vdttwy",
"nsName": "gb-test1",
"gbId": "31011500991320000212",
"state": "notReg",
"username": "31011500991320000212",
"password": "iL-2",
"pullIfRegister": false,
"createdAt": 1637652453,
"updatedAt": 1637652453,
"channels": 1,
"lastRegisterAt": 0,
"lastKeepaliveAt": 0,
"cruiseGroups": [],
"alarmEnable": false,
"alarmMethods": "",
"localRecordPushEnable": false,
"localRecordTemplate": "",
"batchId": "3gzh7xdrfskl6"
}
]
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,476 |
删除批次 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >删除批次
# 删除批次
最近更新时间: 2021-11-23 17:25:59
# **描述**
本接口用于删除批次下的所有设备。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：DELETE
* 接口路径：`/v1/namespaces/{namespaceId}/batches/{id}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
id | 是 | string | 批次ID
# **响应参数**
无
# **示例**
**请求示例**
curl --request DELETE \
--url http://qvs.qiniuapi.com/v1/namespaces/2akras1vdttwy/batches/3gzh7xdhhwi9k \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >删除批次
# 删除批次
最近更新时间: 2021-11-23 17:25:59
# **描述**
本接口用于删除批次下的所有设备。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：DELETE
* 接口路径：`/v1/namespaces/{namespaceId}/batches/{id}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
id | 是 | string | 批次ID
# **响应参数**
无
# **示例**
**请求示例**
curl --request DELETE \
--url http://qvs.qiniuapi.com/v1/namespaces/2akras1vdttwy/batches/3gzh7xdhhwi9k \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,482 |
删除设备 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >删除设备
# 删除设备
最近更新时间: 2022-11-28 16:21:36
# **描述**
本接口用于删除设备。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：DELETE
* 接口路径：`/v1/namespaces/{namespaceId}/devices/{deviceId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
gbId | 是 | string | 设备Id
# **响应参数**
无
# **示例**
**请求示例**
curl --request DELETE \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/devices/31011500991320000028 \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >删除设备
# 删除设备
最近更新时间: 2022-11-28 16:21:36
# **描述**
本接口用于删除设备。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：DELETE
* 接口路径：`/v1/namespaces/{namespaceId}/devices/{deviceId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
gbId | 是 | string | 设备Id
# **响应参数**
无
# **示例**
**请求示例**
curl --request DELETE \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/devices/31011500991320000028 \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,484 |
更新设备 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >更新设备
# 更新设备
最近更新时间: 2023-08-02 11:40:22
# **描述**
本接口用于更新设备。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：PATCH
* 接口路径：`/v1/namespaces/{namespaceId}/devices/{deviceId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
deviceId | 是 | string | 设备Id
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations | 是 | op数组 | op集合，详见： _表一_
_表一：_ OP集合参数
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations.key | 是 | string | 要修改的参数
operations.op | 是 | string | op操作（目前支持replace和delete）
operations.value | 是 | object | 要修改的参数对应的value（当op为delete的时候可以忽略）
_表二：_ 可编辑参数说明
参数名称 | 字段类型 | 说明
---|---|---
name | string | 设备名称（可包含 字母、数字、中划线、下划线，同时支持中文；1 ~ 100 个字符长）
gbId | string | 设备国标ID
username | string | 用户名
password | string | 密码
deviceIp | string | 设备IP地址
onvifPort | integer | 设备onvif端口
onvifUsername | string | onvif用户名
onvifPasswd | string | onvif密码
onvifStreamPort | integer | onvif流地址映射到公网的端口号，默认值为554
desc | string | 设备描述
pullIfRegister | boolean | 注册成功后启动拉流
alarmEnable | boolen | 是否开启国标报警
alarmMethods | string | 接收报警类型。多个报警类型以`,`分隔。1:电话报警,2:设备报警,3:短信报警,4:GPS报警,5:视频报警,6:设备故障报警,7其他报警。例如同时接收短信报警和视频报警，传递参数为`"3,5"`.`alarmEnable`为`true`时,改字段`不`能为空
alarmTypesForRecord | string | alarmType列表，多个报警类型以`,`分隔，收到此列表中的任何一个报警类型，会触发录像。例如，如果希望收到`入侵检测报警`或者`运动目标检测报警`触发录像，则传递参数为`6,2`。关于报警类型的详细说明参考[报警类型说明 __](https://developer.qiniu.com/qvs/7775/gb-alarm-events-list#2)。对应的流需要先绑定`按需录制模板`。此配置项只针对alarmMethod为`5`时，即`视频报警`
recordTime | int | 如果开启了收到报警触发录像，则需要传此参数设置录像的时长，单位为秒。
alarmTypesForSnap | string | alarmType列表，多个报警类型以`,`分隔，收到此列表中的任何一个报警类型，会触发截图。例如，如果希望收到`入侵检测报警`或者`运动目标检测报警`触发截图，则传递参数为`6,2`。关于报警类型的详细说明参考[报警类型说明 __](https://developer.qiniu.com/qvs/7775/gb-alarm-events-list#2)。对应的流需要先绑定`按需录制模板`。此配置项只针对alarmMethod为`5`时，即`视频报警`
localRecordPushEnable | boolean | 本地录像上传开关，默认关闭。如果关闭此开关，本地录像上传云端接口无效
localRecordTemplate | string | 开启本地录像上传开关后，选择录制模板。`该参数为模板ID`
location | 地理位置参数 | 地理位置参数结构
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 | 是否开启音频
rtpProtocol | string | 流传输协议，默认`tcp`协议，可选值`tcp`或`udp`
rtpAudioTranscode | boolean | 是否开启音频转码
onDemandPull | boolean | 是否开启按需拉流
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
name | string | 设备名称
desc | string | 设备描述
nsId | string | 所属的空间ID
nsName | string | 所属的空间名称
gbId | string | 设备国标ID
state | string | 状态（offline：离线，online：在线，pushing：推流中，notReg：未注册，locked：锁定）
username | string | 用户名
password | string | 密码
pullIfRegister | boolean | 注册成功后启动拉流， 默认关闭
createdAt | integer | 创建时间，Unix时间戳，秒
updatedAt | integer | 更新时间，Unix时间戳，秒
lastKeepaliveAt | integer | 最近心跳时间，Unix时间戳，秒
lastRegisterAt | integer | 最近注册时间，Unix时间戳，秒
deviceId | string | 设备id
rtpAudio | boolean | 是否开启音频
rtpAudioTranscode | boolean | 是否开启音频转码
onDemandPull | boolean | 是否开启按需拉流
# **示例**
**请求示例**
curl --request PATCH \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/devices/31011500991320000028 \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"operations":[{
"key":"desc",
"op":"replace",
"value":"gb patch test"
}]
}'
**响应示例**
{
"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,
"deviceId":"31011500991320000028"
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >更新设备
# 更新设备
最近更新时间: 2023-08-02 11:40:22
# **描述**
本接口用于更新设备。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：PATCH
* 接口路径：`/v1/namespaces/{namespaceId}/devices/{deviceId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
deviceId | 是 | string | 设备Id
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations | 是 | op数组 | op集合，详见： _表一_
_表一：_ OP集合参数
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations.key | 是 | string | 要修改的参数
operations.op | 是 | string | op操作（目前支持replace和delete）
operations.value | 是 | object | 要修改的参数对应的value（当op为delete的时候可以忽略）
_表二：_ 可编辑参数说明
参数名称 | 字段类型 | 说明
---|---|---
name | string | 设备名称（可包含 字母、数字、中划线、下划线，同时支持中文；1 ~ 100 个字符长）
gbId | string | 设备国标ID
username | string | 用户名
password | string | 密码
deviceIp | string | 设备IP地址
onvifPort | integer | 设备onvif端口
onvifUsername | string | onvif用户名
onvifPasswd | string | onvif密码
onvifStreamPort | integer | onvif流地址映射到公网的端口号，默认值为554
desc | string | 设备描述
pullIfRegister | boolean | 注册成功后启动拉流
alarmEnable | boolen | 是否开启国标报警
alarmMethods | string | 接收报警类型。多个报警类型以`,`分隔。1:电话报警,2:设备报警,3:短信报警,4:GPS报警,5:视频报警,6:设备故障报警,7其他报警。例如同时接收短信报警和视频报警，传递参数为`"3,5"`.`alarmEnable`为`true`时,改字段`不`能为空
alarmTypesForRecord | string | alarmType列表，多个报警类型以`,`分隔，收到此列表中的任何一个报警类型，会触发录像。例如，如果希望收到`入侵检测报警`或者`运动目标检测报警`触发录像，则传递参数为`6,2`。关于报警类型的详细说明参考[报警类型说明 __](https://developer.qiniu.com/qvs/7775/gb-alarm-events-list#2)。对应的流需要先绑定`按需录制模板`。此配置项只针对alarmMethod为`5`时，即`视频报警`
recordTime | int | 如果开启了收到报警触发录像，则需要传此参数设置录像的时长，单位为秒。
alarmTypesForSnap | string | alarmType列表，多个报警类型以`,`分隔，收到此列表中的任何一个报警类型，会触发截图。例如，如果希望收到`入侵检测报警`或者`运动目标检测报警`触发截图，则传递参数为`6,2`。关于报警类型的详细说明参考[报警类型说明 __](https://developer.qiniu.com/qvs/7775/gb-alarm-events-list#2)。对应的流需要先绑定`按需录制模板`。此配置项只针对alarmMethod为`5`时，即`视频报警`
localRecordPushEnable | boolean | 本地录像上传开关，默认关闭。如果关闭此开关，本地录像上传云端接口无效
localRecordTemplate | string | 开启本地录像上传开关后，选择录制模板。`该参数为模板ID`
location | 地理位置参数 | 地理位置参数结构
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 | 是否开启音频
rtpProtocol | string | 流传输协议，默认`tcp`协议，可选值`tcp`或`udp`
rtpAudioTranscode | boolean | 是否开启音频转码
onDemandPull | boolean | 是否开启按需拉流
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
name | string | 设备名称
desc | string | 设备描述
nsId | string | 所属的空间ID
nsName | string | 所属的空间名称
gbId | string | 设备国标ID
state | string | 状态（offline：离线，online：在线，pushing：推流中，notReg：未注册，locked：锁定）
username | string | 用户名
password | string | 密码
pullIfRegister | boolean | 注册成功后启动拉流， 默认关闭
createdAt | integer | 创建时间，Unix时间戳，秒
updatedAt | integer | 更新时间，Unix时间戳，秒
lastKeepaliveAt | integer | 最近心跳时间，Unix时间戳，秒
lastRegisterAt | integer | 最近注册时间，Unix时间戳，秒
deviceId | string | 设备id
rtpAudio | boolean | 是否开启音频
rtpAudioTranscode | boolean | 是否开启音频转码
onDemandPull | boolean | 是否开启按需拉流
# **示例**
**请求示例**
curl --request PATCH \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/devices/31011500991320000028 \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"operations":[{
"key":"desc",
"op":"replace",
"value":"gb patch test"
}]
}'
**响应示例**
{
"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,
"deviceId":"31011500991320000028"
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,486 |
查询设备信息 | 视频监控 | [视频监控](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 | 是否开启按需拉流
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](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 | 是否开启按需拉流
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,495 |
获取设备列表 | 视频监控 | [视频监控](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
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](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
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,500 |
获取通道列表 | 视频监控 | [视频监控](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
},
]
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](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
},
]
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,506 |
删除通道 | 视频监控 | [视频监控](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
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](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
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,510 |
启动设备拉流 | 视频监控 | [视频监控](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
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](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
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,512 |
停止设备拉流 | 视频监控 | [视频监控](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
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](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
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,515 |
语音对讲 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >语音对讲
# 语音对讲
最近更新时间: 2024-07-26 16:00:31
# **描述**
## 前置说明
### 1.本接口要求设备具备音频的输入和外放能力，`且以gb28181`的方式接入。
### 2.发送的音频数据编码格式为g711a，可以参考如下前端音频采集的demo。
* 前端web语音对讲demo [web示例 __](https://public.qnlinking.com/%E5%89%8D%E7%AB%AF%E9%87%87%E9%9B%86g711a%E9%9F%B3%E9%A2%91sample.zip)
* ios语音对讲demo [ios示例 __](https://public.qnlinking.com/IOSTalk2.0.zip)
* android语音对讲demo [android示例 __](https://public.qnlinking.com/AndroidTalk.zip)
* 微信小程序语音对讲demo [微信小程序示例 __](https://public.qnlinking.com/WxTalks.zip)
### 3.目前已验证支持`gb28181公网`对讲的摄像头厂商:
大华、华为、睿瞳科技、京目科技、凯锐视讯、TPLINK、天地伟业、部分海康型号(比如iDS-2DF8S433IX-A、DS-2CD3T47FWDP2-LS、iDS-
MCD202-G)。
## **接口分两个步骤进行**
## **`步骤1`:首先获取发送音频的url**
* 接口请求域名：qvs.qiniuapi.com
* 请求方式：POST
* 接口路径：/v1/namespaces/{namespaceId}/devices/{deviceId}/talk
## **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
deviceId | 是 | string | 设备ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
isV2 | 是 | bool | 该字段为true时，启用低延迟版本，收到返回地址后在发送语音数据
channels | 否 | string数组 | 设备类型为`平台`时，需指定通道ID
version | 否 | string | 对讲国标协议版本，取值"2014"或"2016"，默认为2014，例如大部分大华摄像头为GBT 28181-2014版本对讲模式
transProtocol | 否 | string | 取值"tcp"或"udp"，流传输模式，默认udp
## **响应参数**
参数名称 | 字段类型 | 说明
---|---|---
audioSendAddrForHttp | string | 用来发送音频数据的http地址
audioSendAddrForHttps | string | 用来发送音频https地址
streamUri | string | onvif流地址(`onvif设备`在步骤2会用到这个参数)
**注意** `当连续1min没有向该地址发送语音, 则需重新执行本接口,获取新的地址,`
## **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/devices/31011500991320000028/talk \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json'
--data-raw '{
"isV2": true
}'
**响应示例**
{
"audioSendAddrForHttp":"http://1945028622.cloudvdn.com/api/v1/gb28181?action=append_audio_pcm&id=31011500991320003732&ssrc=1623567",
"audioSendAddrForHttps":"https://1945028622.cloudvdn.com/api/v1/gb28181?action=append_audio_pcm&id=31011500991320003732&ssrc=1623567"
}
## **`步骤2`:向第一步返回的url地址发送音频。`从语音采集端可直接向改地址发送数据,不需要代理`**
## **音频发送报文格式**
* 接口地址：`步骤1`中接口返回
* 请求方式：POST
## **请求参数**
**路径参数**
null
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
base64_pcm | 是 | string | `base64`编码的`g711a`格式音频数据, 音频采样率务必`8000`,base64数据中不能有换行符\n
deviceId | 当设备类型为onvif时必须 | string | 设备id
streamUri | 当设备类型为onvif时必须 | string | onvif流地址(步骤1返回)
## **示例**
**请求示例**
curl --request POST \
--url https://1945028622.cloudvdn.com/api/v1/gb28181?action=append_audio_pcm&id=31011500991320003732&ssrc=1623567 \
--header 'content-type: application/json'
--data-raw '{
"base64_pcm":"1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1VVVVdXV1dVVVVVVVVTV1dTV1FRV1NRQV9TU1dfWVlXX0VJW11RX0NFW199IfXRcWlHawc32"
}'
**响应示例**
{
// 当code为0,请求成功; code为6002,请求失败。失败原因: 当连续1min, 没有向该地址发送语音,需要重新执行步骤1，获取新的url
"code": Number
}
```{
// 当code为0,请求成功; code为6002,请求失败。失败原因: 当连续1min, 没有向该地址发送语音,需要重新执行步骤1，获取新的url
"code": Number
}
````{
// 当code为0,请求成功; code为6002,请求失败。失败原因: 当连续1min, 没有向该地址发送语音,需要重新执行步骤1，获取新的url
"code": Number
}
```{
// 当code为0,请求成功; code为6002,请求失败。失败原因: 当连续1min, 没有向该地址发送语音,需要重新执行步骤1，获取新的url
"code": Number
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 设备管理相关接口 >语音对讲
# 语音对讲
最近更新时间: 2024-07-26 16:00:31
# **描述**
## 前置说明
### 1.本接口要求设备具备音频的输入和外放能力，`且以gb28181`的方式接入。
### 2.发送的音频数据编码格式为g711a，可以参考如下前端音频采集的demo。
* 前端web语音对讲demo [web示例 __](https://public.qnlinking.com/%E5%89%8D%E7%AB%AF%E9%87%87%E9%9B%86g711a%E9%9F%B3%E9%A2%91sample.zip)
* ios语音对讲demo [ios示例 __](https://public.qnlinking.com/IOSTalk2.0.zip)
* android语音对讲demo [android示例 __](https://public.qnlinking.com/AndroidTalk.zip)
* 微信小程序语音对讲demo [微信小程序示例 __](https://public.qnlinking.com/WxTalks.zip)
### 3.目前已验证支持`gb28181公网`对讲的摄像头厂商:
大华、华为、睿瞳科技、京目科技、凯锐视讯、TPLINK、天地伟业、部分海康型号(比如iDS-2DF8S433IX-A、DS-2CD3T47FWDP2-LS、iDS-
MCD202-G)。
## **接口分两个步骤进行**
## **`步骤1`:首先获取发送音频的url**
* 接口请求域名：qvs.qiniuapi.com
* 请求方式：POST
* 接口路径：/v1/namespaces/{namespaceId}/devices/{deviceId}/talk
## **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
deviceId | 是 | string | 设备ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
isV2 | 是 | bool | 该字段为true时，启用低延迟版本，收到返回地址后在发送语音数据
channels | 否 | string数组 | 设备类型为`平台`时，需指定通道ID
version | 否 | string | 对讲国标协议版本，取值"2014"或"2016"，默认为2014，例如大部分大华摄像头为GBT 28181-2014版本对讲模式
transProtocol | 否 | string | 取值"tcp"或"udp"，流传输模式，默认udp
## **响应参数**
参数名称 | 字段类型 | 说明
---|---|---
audioSendAddrForHttp | string | 用来发送音频数据的http地址
audioSendAddrForHttps | string | 用来发送音频https地址
streamUri | string | onvif流地址(`onvif设备`在步骤2会用到这个参数)
**注意** `当连续1min没有向该地址发送语音, 则需重新执行本接口,获取新的地址,`
## **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/devices/31011500991320000028/talk \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json'
--data-raw '{
"isV2": true
}'
**响应示例**
{
"audioSendAddrForHttp":"http://1945028622.cloudvdn.com/api/v1/gb28181?action=append_audio_pcm&id=31011500991320003732&ssrc=1623567",
"audioSendAddrForHttps":"https://1945028622.cloudvdn.com/api/v1/gb28181?action=append_audio_pcm&id=31011500991320003732&ssrc=1623567"
}
## **`步骤2`:向第一步返回的url地址发送音频。`从语音采集端可直接向改地址发送数据,不需要代理`**
## **音频发送报文格式**
* 接口地址：`步骤1`中接口返回
* 请求方式：POST
## **请求参数**
**路径参数**
null
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
base64_pcm | 是 | string | `base64`编码的`g711a`格式音频数据, 音频采样率务必`8000`,base64数据中不能有换行符\n
deviceId | 当设备类型为onvif时必须 | string | 设备id
streamUri | 当设备类型为onvif时必须 | string | onvif流地址(步骤1返回)
## **示例**
**请求示例**
curl --request POST \
--url https://1945028622.cloudvdn.com/api/v1/gb28181?action=append_audio_pcm&id=31011500991320003732&ssrc=1623567 \
--header 'content-type: application/json'
--data-raw '{
"base64_pcm":"1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1dXV1VVVVdXV1dVVVVVVVVTV1dTV1FRV1NRQV9TU1dfWVlXX0VJW11RX0NFW199IfXRcWlHawc32"
}'
**响应示例**
{
// 当code为0,请求成功; code为6002,请求失败。失败原因: 当连续1min, 没有向该地址发送语音,需要重新执行步骤1，获取新的url
"code": Number
}
```{
// 当code为0,请求成功; code为6002,请求失败。失败原因: 当连续1min, 没有向该地址发送语音,需要重新执行步骤1，获取新的url
"code": Number
}
````{
// 当code为0,请求成功; code为6002,请求失败。失败原因: 当连续1min, 没有向该地址发送语音,需要重新执行步骤1，获取新的url
"code": Number
}
```{
// 当code为0,请求成功; code为6002,请求失败。失败原因: 当连续1min, 没有向该地址发送语音,需要重新执行步骤1，获取新的url
"code": Number
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,517 |
停止语音对讲 | 视频监控 | [视频监控](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
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](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
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,522 |
获取设备地理位置 | 视频监控 | [视频监控](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
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](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
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,524 |
AI模板 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口 >AI模板
# AI模板
最近更新时间: 2022-12-12 12:10:34
AI
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口 >AI模板
# AI模板
最近更新时间: 2022-12-12 12:10:34
AI
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,526 |
获取AI模版结构化数据 | 视频监控 | [视频监控](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": ["李四","王二"]
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](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": ["李四","王二"]
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,527 |
删除AI模板 | 视频监控 | [视频监控](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
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](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
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,531 |
按需模式下开启AI分析 | 视频监控 | [视频监控](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
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](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
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,533 |
按需模式下停止AI分析 | 视频监控 | [视频监控](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
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](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
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,535 |
更新AI模板 | 视频监控 | [视频监控](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
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](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
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,537 |
创建AI模板 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[AI模板](https://developer.qiniu.com/qvs/api/12179/ai-template) > 创建AI模板
# 创建AI模板
最近更新时间: 2022-12-13 11:44:47
# **描述**
本接口用于创建新的模版。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/aitemplates`
# **请求参数**
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
name | 是 | string | 模版名称，格式为1~100个字符，可包含字母、数字、中划线、下划线
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分析
aiTimeRanges | 否 | TimeRange数组 | AI工作时间范围, 默认数组为空,代表24小时生效；否则按照实际区间段，支持多个区间段
timeRange.start | TimeRange数组元素 | string | AI每天开始时间。形式为00:00:00
timeRange.end | TimeRange数组元素 | string | AI每天结束时间。形式为00:00:00
aiImageLib | 否 | stirng | 依赖的基础图像库ID，例如当算法为人脸识别时，需要指定一个基础的图像库。也可以新建一个基础图像库。
aiNeedCallback | 否 | boolean | 是否回调ai计算结果。
aiSaveResult | 否 | boolean | 是否保存ai识别的结构化数据，默认为false。若不保存，可以通过回调的方式得到结构化数据。
desc | 否 | string | 模版描述
bucket | 是 | string | 模版对应的对象存储的bucket
deleteAfterDays | 是 | integer | 存储过期时间，默认永久不过期
fileType | 是 | integer | 文件存储类型，取值：0（普通存储），1（低频存储）
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
name | string | 模版名称
algorithms | int数组 | 算法数组。算法可选 1:安全帽识别 2: 人脸识别; 数组{1, 2} 代表同时选择了1和2, 两种算法
aiFrameInterval | integer | 截帧频率, 当aiInput选择0时有效，默认为1, 代表每秒截取1帧进行AI计算。有效范围 500ms~ 3600s
confidencee | integer | 置信度。默认 60, 有效范围是1～100
runningMode | integer | 运行模式。0:只要视频流在线就开始AI分析 1: 通过API控制AI分析的开始和结束 2: 自定义区间段内开始AI分析
aiTimeRanges | TimeRange数组 | AI工作时间范围, 默认数组为空,代表24小时生效；否则按照实际区间段，支持多个区间段
timeRange.start | string | AI每天开始时间。形式为00:00:00
timeRange.end | string | AI每天结束时间。形式为00:00:00
aiImageLib | stirng | 依赖的基础图像库ID，例如当算法为人脸识别时，需要指定一个基础的图像库。也可以新建一个基础图像库。
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 POST \
--url http://qvs.qiniuapi.com/v1/aitemplates \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"name":"test0013",
"desc":"this is a test",
"algorithms":[1],
"confidence":60,
"runningMode":0,
"aiFrameInterval":5,
"aiSaveResult":true,
"bucket":"bucket-test1",
"deleteAfterDays":7,
"fileType":0
}'
**响应示例**
{
"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
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[AI模板](https://developer.qiniu.com/qvs/api/12179/ai-template) > 创建AI模板
# 创建AI模板
最近更新时间: 2022-12-13 11:44:47
# **描述**
本接口用于创建新的模版。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/aitemplates`
# **请求参数**
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
name | 是 | string | 模版名称，格式为1~100个字符，可包含字母、数字、中划线、下划线
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分析
aiTimeRanges | 否 | TimeRange数组 | AI工作时间范围, 默认数组为空,代表24小时生效；否则按照实际区间段，支持多个区间段
timeRange.start | TimeRange数组元素 | string | AI每天开始时间。形式为00:00:00
timeRange.end | TimeRange数组元素 | string | AI每天结束时间。形式为00:00:00
aiImageLib | 否 | stirng | 依赖的基础图像库ID，例如当算法为人脸识别时，需要指定一个基础的图像库。也可以新建一个基础图像库。
aiNeedCallback | 否 | boolean | 是否回调ai计算结果。
aiSaveResult | 否 | boolean | 是否保存ai识别的结构化数据，默认为false。若不保存，可以通过回调的方式得到结构化数据。
desc | 否 | string | 模版描述
bucket | 是 | string | 模版对应的对象存储的bucket
deleteAfterDays | 是 | integer | 存储过期时间，默认永久不过期
fileType | 是 | integer | 文件存储类型，取值：0（普通存储），1（低频存储）
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
name | string | 模版名称
algorithms | int数组 | 算法数组。算法可选 1:安全帽识别 2: 人脸识别; 数组{1, 2} 代表同时选择了1和2, 两种算法
aiFrameInterval | integer | 截帧频率, 当aiInput选择0时有效，默认为1, 代表每秒截取1帧进行AI计算。有效范围 500ms~ 3600s
confidencee | integer | 置信度。默认 60, 有效范围是1～100
runningMode | integer | 运行模式。0:只要视频流在线就开始AI分析 1: 通过API控制AI分析的开始和结束 2: 自定义区间段内开始AI分析
aiTimeRanges | TimeRange数组 | AI工作时间范围, 默认数组为空,代表24小时生效；否则按照实际区间段，支持多个区间段
timeRange.start | string | AI每天开始时间。形式为00:00:00
timeRange.end | string | AI每天结束时间。形式为00:00:00
aiImageLib | stirng | 依赖的基础图像库ID，例如当算法为人脸识别时，需要指定一个基础的图像库。也可以新建一个基础图像库。
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 POST \
--url http://qvs.qiniuapi.com/v1/aitemplates \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"name":"test0013",
"desc":"this is a test",
"algorithms":[1],
"confidence":60,
"runningMode":0,
"aiFrameInterval":5,
"aiSaveResult":true,
"bucket":"bucket-test1",
"deleteAfterDays":7,
"fileType":0
}'
**响应示例**
{
"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
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,542 |
查询AI模板 | 视频监控 | [视频监控](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
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](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
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,549 |
AI模板列表 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[AI模板](https://developer.qiniu.com/qvs/api/12179/ai-template) > AI模板列表
# AI模板列表
最近更新时间: 2022-12-13 11:44:34
# **描述**
本接口用于获取模板列表。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/aitemplates?offset=<offset>&line=<line>&match=<match>&sortBy=<sortBy>&zone=<zone>`
* Get请求，通过`非SDK`方式调用的客户，http头部Content-Type,`要么设置为application/x-www-form-urlencoded`,`要么置空`, `要么不要携带`; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
line | 否 | integer | 一次返回多少条，最多1000,当超过1000条时，需要结合offset 循环读取。
offset | 否 | integer | 偏移量，当需要循环读取时,初始值offset = 0, 第N次请求时offset = (N -1) * line
sortBy | 否 | string | 默认按创建时间降序排列，sortBy由"asc/desc"和可参与排序的字段组成，其中 asc 表示升序，desc 表示降序，可参与排序的字段有createdAt，updatedAt。asc:updatedAt表示更新时间从小到大排序，desc:updatedAt表示更新时间从大到小排序
match | 否 | string | 模糊匹配查询(模版名称包含match串时返回)
zone | 否 | string | zone为服务区域，可根据服务区域筛选出对应区域的下模板，可选项为z0，z1，z2，cn-east-2。z0表示华东、z1表示华北、z2表示华南、cn-east-2表示华东-浙江2
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
items | 模版数组 | 模版数组
items.id | string | 模版id
items.name | string | 模版名称
items.algorithms | int数组 | 算法数组。算法可选 1:安全帽识别 2: 人脸识别; 数组{1, 2} 代表同时选择了1和2, 两种算法
items.aiFrameInterval | integer | 截帧间隔, 默认为1, 代表每1秒截取1帧进行AI计算。有效范围 500ms~ 3600s
items.confidence | integer | 置信度。默认 60, 有效范围是1～100
items.runningMode | integer | 运行模式。0:只要视频流在线就开始AI分析 1: 通过API控制AI分析的开始和结束 2: 自定义区间段内开始AI分析
items.aiImageLib | stirng | 依赖的基础图像库ID，例如当算法为人脸识别时，需要指定一个基础的图像库。也可以新建一个基础图像库。
items.aiTimeRanges | TimeRange数组 | AI工作时间范围, 默认数组为空,代表24小时生效；否则按照实际区间段，支持多个区间段
timeRange.start | string | AI每天开始时间。形式为00:00:00
timeRange.end | string | AI每天结束时间。形式为00:00:00
items.aiNeedCallback | boolean | 是否回调ai计算结果。默认true
items.aiSaveResult | boolean | 是否保存ai识别的结构化数据，默认为false。若不保存，可以通过回调的方式得到结构化数据。
items.desc | string | 模版描述
items.zone | string | 模版对应的bucket区域
items.bucket | string | 模版对应的对象存储的bucket,
items.deleteAfterDays | integer | 存储过期时间，默认永久不过期
items.fileType | integer | 文件存储类型，取值：0（普通存储），1（低频存储）
items.createdAt | integer | 模板创建时间
items.updatedAt | integer | 模板更新时间
total | integer | 模版总数量
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/aitemplates \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"items": [
{
"id": "2akrars5b81f5",
"name": "test0016",
"desc":"this is a test",
"algorithms":[1],
"confidence":60,
"runningMode":0,
"aiFrameInterval":5,
"aiSaveResult":true,
"zone":"z1",
"bucket":"bucket-test1",
"deleteAfterDays":7,
"fileType":0,
"createdAt": 1586847620,
"updatedAt": 1586847620
},
{
"id": "d102sns2mwhd",
"name": "test009",
"desc":"this is a test",
"algorithms":[1],
"confidence":60,
"runningMode":0,
"aiFrameInterval":5,
"aiSaveResult":true,
"zone":"z1",
"bucket":"bucket-test1",
"deleteAfterDays":7,
"fileType":0,
"createdAt": 1586847620,
"updatedAt": 1586847620
}
],
"total": 2
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[AI模板](https://developer.qiniu.com/qvs/api/12179/ai-template) > AI模板列表
# AI模板列表
最近更新时间: 2022-12-13 11:44:34
# **描述**
本接口用于获取模板列表。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/aitemplates?offset=<offset>&line=<line>&match=<match>&sortBy=<sortBy>&zone=<zone>`
* Get请求，通过`非SDK`方式调用的客户，http头部Content-Type,`要么设置为application/x-www-form-urlencoded`,`要么置空`, `要么不要携带`; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
line | 否 | integer | 一次返回多少条，最多1000,当超过1000条时，需要结合offset 循环读取。
offset | 否 | integer | 偏移量，当需要循环读取时,初始值offset = 0, 第N次请求时offset = (N -1) * line
sortBy | 否 | string | 默认按创建时间降序排列，sortBy由"asc/desc"和可参与排序的字段组成，其中 asc 表示升序，desc 表示降序，可参与排序的字段有createdAt，updatedAt。asc:updatedAt表示更新时间从小到大排序，desc:updatedAt表示更新时间从大到小排序
match | 否 | string | 模糊匹配查询(模版名称包含match串时返回)
zone | 否 | string | zone为服务区域，可根据服务区域筛选出对应区域的下模板，可选项为z0，z1，z2，cn-east-2。z0表示华东、z1表示华北、z2表示华南、cn-east-2表示华东-浙江2
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
items | 模版数组 | 模版数组
items.id | string | 模版id
items.name | string | 模版名称
items.algorithms | int数组 | 算法数组。算法可选 1:安全帽识别 2: 人脸识别; 数组{1, 2} 代表同时选择了1和2, 两种算法
items.aiFrameInterval | integer | 截帧间隔, 默认为1, 代表每1秒截取1帧进行AI计算。有效范围 500ms~ 3600s
items.confidence | integer | 置信度。默认 60, 有效范围是1～100
items.runningMode | integer | 运行模式。0:只要视频流在线就开始AI分析 1: 通过API控制AI分析的开始和结束 2: 自定义区间段内开始AI分析
items.aiImageLib | stirng | 依赖的基础图像库ID，例如当算法为人脸识别时，需要指定一个基础的图像库。也可以新建一个基础图像库。
items.aiTimeRanges | TimeRange数组 | AI工作时间范围, 默认数组为空,代表24小时生效；否则按照实际区间段，支持多个区间段
timeRange.start | string | AI每天开始时间。形式为00:00:00
timeRange.end | string | AI每天结束时间。形式为00:00:00
items.aiNeedCallback | boolean | 是否回调ai计算结果。默认true
items.aiSaveResult | boolean | 是否保存ai识别的结构化数据，默认为false。若不保存，可以通过回调的方式得到结构化数据。
items.desc | string | 模版描述
items.zone | string | 模版对应的bucket区域
items.bucket | string | 模版对应的对象存储的bucket,
items.deleteAfterDays | integer | 存储过期时间，默认永久不过期
items.fileType | integer | 文件存储类型，取值：0（普通存储），1（低频存储）
items.createdAt | integer | 模板创建时间
items.updatedAt | integer | 模板更新时间
total | integer | 模版总数量
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/aitemplates \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"items": [
{
"id": "2akrars5b81f5",
"name": "test0016",
"desc":"this is a test",
"algorithms":[1],
"confidence":60,
"runningMode":0,
"aiFrameInterval":5,
"aiSaveResult":true,
"zone":"z1",
"bucket":"bucket-test1",
"deleteAfterDays":7,
"fileType":0,
"createdAt": 1586847620,
"updatedAt": 1586847620
},
{
"id": "d102sns2mwhd",
"name": "test009",
"desc":"this is a test",
"algorithms":[1],
"confidence":60,
"runningMode":0,
"aiFrameInterval":5,
"aiSaveResult":true,
"zone":"z1",
"bucket":"bucket-test1",
"deleteAfterDays":7,
"fileType":0,
"createdAt": 1586847620,
"updatedAt": 1586847620
}
],
"total": 2
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,554 |
图像底库 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口 >图像底库
# 图像底库
最近更新时间: 2022-08-17 17:51:04
图像底库
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口 >图像底库
# 图像底库
最近更新时间: 2022-08-17 17:51:04
图像底库
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,560 |
查询实体 | 视频监控 | [视频监控](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
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](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
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,561 |
更新实体 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 更新实体
# 更新实体
最近更新时间: 2022-12-12 11:48:34
# **描述**
本接口用于更新某个实体信息。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：PATCH
* 接口路径：`/v1/imagelibs/{libId}/entities/{entityId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
libId | 是 | string | 库ID
entityId | 是 | string | 实体ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations | 是 | op数组 | op集合，详见： _表一_
_表一：_ OP集合参数
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations.key | 是 | string | 要修改的参数
operations.op | 是 | string | op操作(目前支持replace)
operations.value | 是 | object | 要修改的参数对应的value
_表二：_ 可编辑参数说明
参数名称 | 字段类型 | 说明
---|---|---
name | string | 姓名
gender | string | 性别 male 或 female
phoneNum | string | 手机号
certNum | string | 证件号
addr | string | 地址
desc | string | 备注描述
# **响应参数**
响应参数与查询实体一致，请参阅**查询实体**[响应参数
__](https://developer.qiniu.io/qvs/api/12180/query-entity)
# **示例**
**请求示例**
curl --request PATCH \
--url http://qvs.qiniuapi.com//v1/imagelibs/xxx/entities/yyy \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{"operations":[{"op":"replace", "key":"name","value":"newName"}, {"op":"replace", "key":"addr","value":"sh"}]
}'
**响应示例**
{
"libId": "xxx",
"id": "yyy",
"name": "test009",
....
"createdAt": 1585104103
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 更新实体
# 更新实体
最近更新时间: 2022-12-12 11:48:34
# **描述**
本接口用于更新某个实体信息。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：PATCH
* 接口路径：`/v1/imagelibs/{libId}/entities/{entityId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
libId | 是 | string | 库ID
entityId | 是 | string | 实体ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations | 是 | op数组 | op集合，详见： _表一_
_表一：_ OP集合参数
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations.key | 是 | string | 要修改的参数
operations.op | 是 | string | op操作(目前支持replace)
operations.value | 是 | object | 要修改的参数对应的value
_表二：_ 可编辑参数说明
参数名称 | 字段类型 | 说明
---|---|---
name | string | 姓名
gender | string | 性别 male 或 female
phoneNum | string | 手机号
certNum | string | 证件号
addr | string | 地址
desc | string | 备注描述
# **响应参数**
响应参数与查询实体一致，请参阅**查询实体**[响应参数
__](https://developer.qiniu.io/qvs/api/12180/query-entity)
# **示例**
**请求示例**
curl --request PATCH \
--url http://qvs.qiniuapi.com//v1/imagelibs/xxx/entities/yyy \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{"operations":[{"op":"replace", "key":"name","value":"newName"}, {"op":"replace", "key":"addr","value":"sh"}]
}'
**响应示例**
{
"libId": "xxx",
"id": "yyy",
"name": "test009",
....
"createdAt": 1585104103
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,564 |
删除实体里的图片 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 删除实体里的图片
# 删除实体里的图片
最近更新时间: 2022-12-12 11:49:09
# **描述**
本接口用于删除某个实体里已上传的图片，该接口调用后会自动更新实体的图片数组，无需再手动更新实体的图片数组。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：DELETE
* 接口路径：`/v1/imagelibs/{libId}/entities/{entityId}/images`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
libId | 是 | string | 图像库ID
entityId | 是 | string | 实体ID
**请求 body参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
url | 是 | string | 需要删除的图片地址
# **响应参数**
无
# **示例**
**请求示例**
curl --request DELETE \
--url http://qvs.qiniuapi.com/v1/imagelibs/xxxx/entities/yyyy/images\
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--data '{
"url":"http://qvs.com/1.jpg"
}'
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 删除实体里的图片
# 删除实体里的图片
最近更新时间: 2022-12-12 11:49:09
# **描述**
本接口用于删除某个实体里已上传的图片，该接口调用后会自动更新实体的图片数组，无需再手动更新实体的图片数组。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：DELETE
* 接口路径：`/v1/imagelibs/{libId}/entities/{entityId}/images`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
libId | 是 | string | 图像库ID
entityId | 是 | string | 实体ID
**请求 body参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
url | 是 | string | 需要删除的图片地址
# **响应参数**
无
# **示例**
**请求示例**
curl --request DELETE \
--url http://qvs.qiniuapi.com/v1/imagelibs/xxxx/entities/yyyy/images\
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--data '{
"url":"http://qvs.com/1.jpg"
}'
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,567 |
向实体中添加新图片 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 向实体中添加新图片
# 向实体中添加新图片
最近更新时间: 2022-12-12 11:48:58
# **描述**
本接口用于向实体中添加新的图片,每个实体最多上传10张图片，该接口调用后会自动更新实体的图片数组，无需再手动更新实体的图片数组。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/imagelibs/{libId}/entities/{entityId}/images`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
libId | 是 | string | 图像库ID
entityId | 是 | string | 实体ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
imageData | 是 | string | 图片的base64编码
# **响应参数**
参数名称 | 字段类型 | 说明
---|---|---
url | string | 图片的url
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/imagelibs/xxxx/entities/yyyy/images \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"imageData":"YWRzYWRhc2Q="
}'
**响应示例**
{
"url": asdu2wns.hd-bkt.clouddn.com/1626352621.jpg
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 向实体中添加新图片
# 向实体中添加新图片
最近更新时间: 2022-12-12 11:48:58
# **描述**
本接口用于向实体中添加新的图片,每个实体最多上传10张图片，该接口调用后会自动更新实体的图片数组，无需再手动更新实体的图片数组。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/imagelibs/{libId}/entities/{entityId}/images`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
libId | 是 | string | 图像库ID
entityId | 是 | string | 实体ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
imageData | 是 | string | 图片的base64编码
# **响应参数**
参数名称 | 字段类型 | 说明
---|---|---
url | string | 图片的url
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/imagelibs/xxxx/entities/yyyy/images \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"imageData":"YWRzYWRhc2Q="
}'
**响应示例**
{
"url": asdu2wns.hd-bkt.clouddn.com/1626352621.jpg
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,569 |
图像底库列表 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 图像底库列表
# 图像底库列表
最近更新时间: 2022-12-22 11:25:49
# **描述**
本接口用于获取图像底库列表。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/imagelibs?offset=<offset>&line=<line>&match=<match>&sortBy=<sortBy>`
* Get请求，通过`非SDK`方式调用的客户，http头部Content-Type,`要么设置为application/x-www-form-urlencoded`,`要么置空`, `要么不要携带`; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
line | 否 | integer | 一次返回多少条，最多1000,当超过1000条时，需要结合offset 循环读取。
offset | 否 | integer | 偏移量，当需要循环读取时,初始值offset = 0, 第N次请求时offset = (N -1) * line
sortBy | 否 | string | 默认按创建时间降序排列，sortBy由"asc/desc"和可参与排序的字段组成，其中 asc 表示升序，desc 表示降序
match | 否 | string | 模糊匹配查询(库名称包含match串时返回)
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
items | 库数组 | 库数组
items.id | string | 库id
items.name | string | 库名称
items.desc | string | 备注描述
items.createdAt | integer | 库创建时间
total | integer | 总数量
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/imagelibs \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"items": [
{
"id": "2akrars5b81f5",
"name": "test0016",
"desc": "this is a test",
"createdAt": 1586850533
},
{
"id": "d102sns2mwhd",
"name": "test009",
"createdAt": 1585104103
}
],
"total": 2
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 图像底库列表
# 图像底库列表
最近更新时间: 2022-12-22 11:25:49
# **描述**
本接口用于获取图像底库列表。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/imagelibs?offset=<offset>&line=<line>&match=<match>&sortBy=<sortBy>`
* Get请求，通过`非SDK`方式调用的客户，http头部Content-Type,`要么设置为application/x-www-form-urlencoded`,`要么置空`, `要么不要携带`; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
line | 否 | integer | 一次返回多少条，最多1000,当超过1000条时，需要结合offset 循环读取。
offset | 否 | integer | 偏移量，当需要循环读取时,初始值offset = 0, 第N次请求时offset = (N -1) * line
sortBy | 否 | string | 默认按创建时间降序排列，sortBy由"asc/desc"和可参与排序的字段组成，其中 asc 表示升序，desc 表示降序
match | 否 | string | 模糊匹配查询(库名称包含match串时返回)
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
items | 库数组 | 库数组
items.id | string | 库id
items.name | string | 库名称
items.desc | string | 备注描述
items.createdAt | integer | 库创建时间
total | integer | 总数量
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/imagelibs \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"items": [
{
"id": "2akrars5b81f5",
"name": "test0016",
"desc": "this is a test",
"createdAt": 1586850533
},
{
"id": "d102sns2mwhd",
"name": "test009",
"createdAt": 1585104103
}
],
"total": 2
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,572 |
创建实体 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 创建实体
# 创建实体
最近更新时间: 2022-12-12 11:48:19
# **描述**
实体隶属于图像库。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/imagelibs/{libId}/entities`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
libId | 是 | string | 图像库ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
name | 是 | string | 实体所属姓名,可包含中文、字母、数字、中划线、下划线
gender | 否 | string | 性别, 可选项为 male 或 female, 默认 male.
phoneNum | 否 | string | 手机号
certNum | 否 | string | 证件号
addr | 否 | string | 地址
desc | 否 | string | 备注
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
libId | string | 所属的库ID
id | string | 实体id
urls | string数组 | 实体的图片数组，实体创建后为空，可以调用添加图片接口给实体添加图片
name | string | 实体所属姓名,可包含字母、数字、中划线、下划线
gender | string | 性别, 可选项为 male 或 female, 默认 male.
phoneNum | string | 手机号
certNum | string | 证件号
addr | string | 地址
desc | string | 备注
createdAt | integer | 创建时间
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com//v1/imagelibs/xxxx/entities \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"name":"test0013",
"desc":"this is a test"
}'
**响应示例**
{
"libId": "xxxx",
"id": "2akrars59hm2l",
"name": "test0013",
"urls": [],
"desc": "this is a test",
"createdAt": 1586847620
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 创建实体
# 创建实体
最近更新时间: 2022-12-12 11:48:19
# **描述**
实体隶属于图像库。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/imagelibs/{libId}/entities`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
libId | 是 | string | 图像库ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
name | 是 | string | 实体所属姓名,可包含中文、字母、数字、中划线、下划线
gender | 否 | string | 性别, 可选项为 male 或 female, 默认 male.
phoneNum | 否 | string | 手机号
certNum | 否 | string | 证件号
addr | 否 | string | 地址
desc | 否 | string | 备注
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
libId | string | 所属的库ID
id | string | 实体id
urls | string数组 | 实体的图片数组，实体创建后为空，可以调用添加图片接口给实体添加图片
name | string | 实体所属姓名,可包含字母、数字、中划线、下划线
gender | string | 性别, 可选项为 male 或 female, 默认 male.
phoneNum | string | 手机号
certNum | string | 证件号
addr | string | 地址
desc | string | 备注
createdAt | integer | 创建时间
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com//v1/imagelibs/xxxx/entities \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"name":"test0013",
"desc":"this is a test"
}'
**响应示例**
{
"libId": "xxxx",
"id": "2akrars59hm2l",
"name": "test0013",
"urls": [],
"desc": "this is a test",
"createdAt": 1586847620
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,575 |
删除实体 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 删除实体
# 删除实体
最近更新时间: 2022-12-12 11:48:42
# **描述**
本接口用于删除某个图像库里的实体信息。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：DELETE
* 接口路径：`/v1/imagelibs/{libId}/entities`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
libId | 是 | string | 图像库ID
**请求 body参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
entityIds | 是 | string数组 | 需要删除的实体ID列表, 从API(实体列表)获取
# **响应参数**
无
# **示例**
**请求示例**
curl --request DELETE \
--url http://qvs.qiniuapi.com/v1/imagelibs/xxxx/entities\
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--data '{
"entityIds":["id1","id2"]
}'
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 删除实体
# 删除实体
最近更新时间: 2022-12-12 11:48:42
# **描述**
本接口用于删除某个图像库里的实体信息。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：DELETE
* 接口路径：`/v1/imagelibs/{libId}/entities`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
libId | 是 | string | 图像库ID
**请求 body参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
entityIds | 是 | string数组 | 需要删除的实体ID列表, 从API(实体列表)获取
# **响应参数**
无
# **示例**
**请求示例**
curl --request DELETE \
--url http://qvs.qiniuapi.com/v1/imagelibs/xxxx/entities\
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--data '{
"entityIds":["id1","id2"]
}'
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,579 |
删除图像底库 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 删除图像底库
# 删除图像底库
最近更新时间: 2022-12-12 11:48:04
# **描述**
本接口用于删除图像库，图像库里所有图片也会被一并删除
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：DELETE
* 接口路径：`/v1/imagelibs`
# **请求参数**
**请求 body参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
libIds | 是 | string数组 | 需要删除的库ID列表
# **响应参数**
无
# **示例**
**请求示例**
curl --request DELETE \
--url http://qvs.qiniuapi.com/v1/imagelibs\
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--data '{
"libIds":["xxx1","yyy2"]
}'
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 删除图像底库
# 删除图像底库
最近更新时间: 2022-12-12 11:48:04
# **描述**
本接口用于删除图像库，图像库里所有图片也会被一并删除
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：DELETE
* 接口路径：`/v1/imagelibs`
# **请求参数**
**请求 body参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
libIds | 是 | string数组 | 需要删除的库ID列表
# **响应参数**
无
# **示例**
**请求示例**
curl --request DELETE \
--url http://qvs.qiniuapi.com/v1/imagelibs\
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--data '{
"libIds":["xxx1","yyy2"]
}'
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,581 |
查询图像底库 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 查询图像底库
# 查询图像底库
最近更新时间: 2022-12-12 11:47:42
# **描述**
本接口用于获取图像底库列表。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/imagelibs/{libId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
libId | 是 | string | 图像库ID。
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
id | string | 库id
name | string | 库名称
desc | string | 备注描述
createdAt | integer | 库创建时间
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/imagelibs/xxxx \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"id": "xxxx",
"name": "test0016",
"desc": "this is a test",
"createdAt": 1586850533
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 查询图像底库
# 查询图像底库
最近更新时间: 2022-12-12 11:47:42
# **描述**
本接口用于获取图像底库列表。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/imagelibs/{libId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
libId | 是 | string | 图像库ID。
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
id | string | 库id
name | string | 库名称
desc | string | 备注描述
createdAt | integer | 库创建时间
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/imagelibs/xxxx \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"id": "xxxx",
"name": "test0016",
"desc": "this is a test",
"createdAt": 1586850533
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,583 |
更新图像底库 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 更新图像底库
# 更新图像底库
最近更新时间: 2022-12-12 11:47:55
# **描述**
本接口用于更新图像库信息。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：PATCH
* 接口路径：`/v1/imagelibs/{libId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
libId | 是 | string | 库ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations | 是 | op数组 | op集合，详见： _表一_
_表一：_ OP集合参数
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations.key | 是 | string | 要修改的参数
operations.op | 是 | string | op操作(目前支持replace和delete)
operations.value | 是 | object | 要修改的参数对应的value(当op为delete的时候可以忽略)
_表二：_ 可编辑参数说明
参数名称 | 字段类型 | 说明
---|---|---
name | string | 图像库名称
desc | string | 图像库描述
# **示例**
**请求示例**
curl --request PATCH \
--url http://qvs.qiniuapi.com/v1/imagelibs/d102sns2mwhd \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{"operations":[{"key":"name","op":"replace","value":"123"}]
}'
**响应示例**
{
"id": "d102sns2mwhd",
"name": "123",
"desc": "hello",
"createdAt": 1585104103
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 更新图像底库
# 更新图像底库
最近更新时间: 2022-12-12 11:47:55
# **描述**
本接口用于更新图像库信息。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：PATCH
* 接口路径：`/v1/imagelibs/{libId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
libId | 是 | string | 库ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations | 是 | op数组 | op集合，详见： _表一_
_表一：_ OP集合参数
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations.key | 是 | string | 要修改的参数
operations.op | 是 | string | op操作(目前支持replace和delete)
operations.value | 是 | object | 要修改的参数对应的value(当op为delete的时候可以忽略)
_表二：_ 可编辑参数说明
参数名称 | 字段类型 | 说明
---|---|---
name | string | 图像库名称
desc | string | 图像库描述
# **示例**
**请求示例**
curl --request PATCH \
--url http://qvs.qiniuapi.com/v1/imagelibs/d102sns2mwhd \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{"operations":[{"key":"name","op":"replace","value":"123"}]
}'
**响应示例**
{
"id": "d102sns2mwhd",
"name": "123",
"desc": "hello",
"createdAt": 1585104103
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,585 |
创建图像底库 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 创建图像底库
# 创建图像底库
最近更新时间: 2022-12-12 11:47:49
# **描述**
图像底库是一组图像的集合, 和AI模板配合使用。 AI模板里的某些算法，需要依赖图像底库进行比对，例如人脸识别。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/imagelibs`
# **请求参数**
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
name | 是 | string | 库名称，可包含字母、数字、中划线、下划线
desc | 否 | string | 备注
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
name | string | 库名称
id | string | 库ID
desc | string | 描述
createdAt | integer | 创建时间
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/imagelibs \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"name":"test0013",
"desc":"this is a test"
}'
**响应示例**
{
"id": "2akrars59hm2l",
"name": "test0013",
"desc": "this is a test",
"createdAt": 1586847620
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 创建图像底库
# 创建图像底库
最近更新时间: 2022-12-12 11:47:49
# **描述**
图像底库是一组图像的集合, 和AI模板配合使用。 AI模板里的某些算法，需要依赖图像底库进行比对，例如人脸识别。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/imagelibs`
# **请求参数**
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
name | 是 | string | 库名称，可包含字母、数字、中划线、下划线
desc | 否 | string | 备注
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
name | string | 库名称
id | string | 库ID
desc | string | 描述
createdAt | integer | 创建时间
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/imagelibs \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"name":"test0013",
"desc":"this is a test"
}'
**响应示例**
{
"id": "2akrars59hm2l",
"name": "test0013",
"desc": "this is a test",
"createdAt": 1586847620
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,588 |
实体列表 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 实体列表
# 实体列表
最近更新时间: 2022-12-22 11:25:59
# **描述**
本接口用于获取图像库里的所有实体信息。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/imagelibs/{libId}/entities?offset=<offset>&line=<line>&match=<match>&sortBy=<sortBy>`
* Get请求，通过`非SDK`方式调用的客户，http头部Content-Type,`要么设置为application/x-www-form-urlencoded`,`要么置空`, `要么不要携带`; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
libId | 是 | string | 图像库ID
line | 否 | integer | 一次返回多少条，最多1000,当超过1000条时，需要结合offset 循环读取
offset | 否 | integer | 偏移量，当需要循环读取时,初始值offset = 0, 第N次请求时offset = (N -1) * line
sort | 否 | string | 默认按创建时间降序排列，sort由"asc/desc"和可参与排序的字段组成，其中 asc 表示升序，desc 表示降序
match | 否 | string | 模糊匹配查询(名称或者证件号包含{match})
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
libId | string | 库id
name | string | 库名称
desc | string | 备注描述
createdAt | integer | 库创建时间
items | 图像库里的所有实体 | 数组
items.id | string | 实体id
items.urls | 数组 | 实体的图像地址的数组
items.name | string | 姓名
items.gender | string | 性别 male 或 female
items.phoneNum | string | 手机号
items.certNum | string | 证件号
items.Addr | string | 地址
items.desc | string | 备注描述
items.createdAt | integer | 图像创建时间
total | integer | 总数量
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/imagelibs/xxx/entities \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"items": [
"libId":"xxx",
"name":"imagelib",
{
"id": "2akrars5b81f5",
"urls":["https://yyy/yy/yy"],
"name": "test0016",
"desc": "this is a test",
"createdAt": 1586850533
},
{
"id": "d102sns2mwhd",
"urls":["https://ttt.com/rts"],
"name": "test009",
"createdAt": 1585104103
}
],
"total": 2
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口
>[图像底库](https://developer.qiniu.com/qvs/api/12173/the-bottom-of-the-image-
library) > 实体列表
# 实体列表
最近更新时间: 2022-12-22 11:25:59
# **描述**
本接口用于获取图像库里的所有实体信息。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/imagelibs/{libId}/entities?offset=<offset>&line=<line>&match=<match>&sortBy=<sortBy>`
* Get请求，通过`非SDK`方式调用的客户，http头部Content-Type,`要么设置为application/x-www-form-urlencoded`,`要么置空`, `要么不要携带`; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
libId | 是 | string | 图像库ID
line | 否 | integer | 一次返回多少条，最多1000,当超过1000条时，需要结合offset 循环读取
offset | 否 | integer | 偏移量，当需要循环读取时,初始值offset = 0, 第N次请求时offset = (N -1) * line
sort | 否 | string | 默认按创建时间降序排列，sort由"asc/desc"和可参与排序的字段组成，其中 asc 表示升序，desc 表示降序
match | 否 | string | 模糊匹配查询(名称或者证件号包含{match})
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
libId | string | 库id
name | string | 库名称
desc | string | 备注描述
createdAt | integer | 库创建时间
items | 图像库里的所有实体 | 数组
items.id | string | 实体id
items.urls | 数组 | 实体的图像地址的数组
items.name | string | 姓名
items.gender | string | 性别 male 或 female
items.phoneNum | string | 手机号
items.certNum | string | 证件号
items.Addr | string | 地址
items.desc | string | 备注描述
items.createdAt | integer | 图像创建时间
total | integer | 总数量
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/imagelibs/xxx/entities \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"items": [
"libId":"xxx",
"name":"imagelib",
{
"id": "2akrars5b81f5",
"urls":["https://yyy/yy/yy"],
"name": "test0016",
"desc": "this is a test",
"createdAt": 1586850533
},
{
"id": "d102sns2mwhd",
"urls":["https://ttt.com/rts"],
"name": "test009",
"createdAt": 1585104103
}
],
"total": 2
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,591 |
创建模板 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口 >创建模板
# 创建模板
最近更新时间: 2022-03-11 15:42:18
# **描述**
本接口用于创建新的模版。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/templates`
# **请求参数**
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
name | 是 | string | 模版名称，格式为1~100个字符，可包含小写字母、数字、中划线
desc | 否 | string | 模版描述
bucket | 是 | string | 模版对应的对象存储的bucket
deleteAfterDays | 是 | integer | 存储过期时间，默认永久不过期
fileType | 是 | integer | 文件存储类型，取值：0（普通存储），1（低频存储）
recordFileFormat | 是 | integer | 录制文件存储格式(多选)，范围：1(001)～7(111)，从左往右的三位二进制数分别代表MP4，FLV，M3U8；0代表不选择该格式，1代表选择；例如：2(010)代表选择FLV格式，6(110)代表选择MP4和FLV格式，1(001)代表选择M3U8格式，7(111)代表三种格式均选择
templateType | 是 | integer | 模板类型，取值：0（录制模版），1（截图模版）
recordType | templateType为0时必须 | integer | 录制模式，0（不录制），1（实时录制），2(按需录制)
jpgOverwriteStatus | templateType为1时须指定 | boolean | 开启覆盖式截图(一般用于流封面)
jpgSequenceStatus | templateType为1时须指定 | boolean | 开启实时截图
jpgOnDemandStatus | templateType为1时须指定 | boolean | 开启按需截图
recordInterval | 否 | integer | 录制文件时长 单位为秒，600~3600
snapInterval | 否 | integer | 截图间隔，单位为秒，1~600，按需截图可以忽略
_说明：当templateType为1时，jpgOverwriteStatus,jpgSequenceStatus,jpgOnDemandStatus三个参数至少指定一项_
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
name | string | 模版名称
desc | string | 模版描述
bucket | string | 模版对应的对象存储的bucket
deleteAfterDays | integer | 存储过期时间，默认永久不过期
fileType | integer | 文件存储类型，取值：0（普通存储），1（低频存储）
recordFileFormat | integer | 录制文件存储格式(多选)，范围：1(001)～7(111), 从左往右的三位二进制数分别代表MP4，FLV，M3U8；0代表不选择该格式，1代表选择；例如：2(010)代表选择FLV格式，6(110)代表选择MP4和FLV格式，1(001)代表选择M3U8格式，7(111)代表三种格式均选择
templateType | integer | 模板类型，取值：0（录制模版），1（截图模版）
recordType | integer | 录制模式，取值：0（不录制），1（实时录制）
jpgOverwriteStatus | boolean | 开启覆盖式截图(一般用于流封面)
jpgSequenceStatus | boolean | 开启实时截图
jpgOnDemandStatus | boolean | 开启按需截图
tsFileNameTemplate | string | ts文件命名格式
m3u8FileNameTemplate | string | m3u8文件命名格式
flvFileNameTemplate | string | flv文件命名格式
mp4FileNameTemplate | string | mp4文件命名格式
jpgOverwriteFileNameTemplate | string | 覆盖式截图文件命名格式
jpgSequenceFileNameTemplate | string | 实时截图文件命名格式
recordInterval | integer | 录制文件时长(单位为秒)
snapInterval | integer | 截图间隔(单位为秒)，按需截图可以忽略
createdAt | integer | 模板创建时间
updatedAt | integer | 模板更新时间
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/templates \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"name":"test0013",
"desc":"this is a test",
"deleteAfterDays":6,
"interval":5,
"templateType":1,
"bucket":"bucket-test1",
"jpgOverwriteStatus": true,
"jpgSequenceStatus": true,
"jpgOnDemandStatus": true
}'
**响应示例**
{
"id": "2akrars59hm2l",
"name": "test0013",
"desc": "this is a test",
"bucket": "bucket-test1",
"deleteAfterDays": 0,
"templateType": 1,
"fileType": 0,
"recordType": 0,
"recordFileFormat": 0,
"jpgOverwriteStatus": true,
"jpgSequenceStatus": true,
"jpgOnDemandStatus": true,
"jpgOverwriteFileNameTemplate": "snapshot/jpg/${namespaceId}/${streamId}.jpg",
"jpgSequenceFileNameTemplate": "snapshot/jpg/${namespaceId}/${streamId}/${startMs}.jpg",
"jpgOnDemandFileNameTemplate": "snapshot/jpg/${namespaceId}/${streamId}/ondemand/${startMs}.jpg",
"snapInterval": 10,
"createdAt": 1586847620,
"updatedAt": 1586847620
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口 >创建模板
# 创建模板
最近更新时间: 2022-03-11 15:42:18
# **描述**
本接口用于创建新的模版。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/templates`
# **请求参数**
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
name | 是 | string | 模版名称，格式为1~100个字符，可包含小写字母、数字、中划线
desc | 否 | string | 模版描述
bucket | 是 | string | 模版对应的对象存储的bucket
deleteAfterDays | 是 | integer | 存储过期时间，默认永久不过期
fileType | 是 | integer | 文件存储类型，取值：0（普通存储），1（低频存储）
recordFileFormat | 是 | integer | 录制文件存储格式(多选)，范围：1(001)～7(111)，从左往右的三位二进制数分别代表MP4，FLV，M3U8；0代表不选择该格式，1代表选择；例如：2(010)代表选择FLV格式，6(110)代表选择MP4和FLV格式，1(001)代表选择M3U8格式，7(111)代表三种格式均选择
templateType | 是 | integer | 模板类型，取值：0（录制模版），1（截图模版）
recordType | templateType为0时必须 | integer | 录制模式，0（不录制），1（实时录制），2(按需录制)
jpgOverwriteStatus | templateType为1时须指定 | boolean | 开启覆盖式截图(一般用于流封面)
jpgSequenceStatus | templateType为1时须指定 | boolean | 开启实时截图
jpgOnDemandStatus | templateType为1时须指定 | boolean | 开启按需截图
recordInterval | 否 | integer | 录制文件时长 单位为秒，600~3600
snapInterval | 否 | integer | 截图间隔，单位为秒，1~600，按需截图可以忽略
_说明：当templateType为1时，jpgOverwriteStatus,jpgSequenceStatus,jpgOnDemandStatus三个参数至少指定一项_
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
name | string | 模版名称
desc | string | 模版描述
bucket | string | 模版对应的对象存储的bucket
deleteAfterDays | integer | 存储过期时间，默认永久不过期
fileType | integer | 文件存储类型，取值：0（普通存储），1（低频存储）
recordFileFormat | integer | 录制文件存储格式(多选)，范围：1(001)～7(111), 从左往右的三位二进制数分别代表MP4，FLV，M3U8；0代表不选择该格式，1代表选择；例如：2(010)代表选择FLV格式，6(110)代表选择MP4和FLV格式，1(001)代表选择M3U8格式，7(111)代表三种格式均选择
templateType | integer | 模板类型，取值：0（录制模版），1（截图模版）
recordType | integer | 录制模式，取值：0（不录制），1（实时录制）
jpgOverwriteStatus | boolean | 开启覆盖式截图(一般用于流封面)
jpgSequenceStatus | boolean | 开启实时截图
jpgOnDemandStatus | boolean | 开启按需截图
tsFileNameTemplate | string | ts文件命名格式
m3u8FileNameTemplate | string | m3u8文件命名格式
flvFileNameTemplate | string | flv文件命名格式
mp4FileNameTemplate | string | mp4文件命名格式
jpgOverwriteFileNameTemplate | string | 覆盖式截图文件命名格式
jpgSequenceFileNameTemplate | string | 实时截图文件命名格式
recordInterval | integer | 录制文件时长(单位为秒)
snapInterval | integer | 截图间隔(单位为秒)，按需截图可以忽略
createdAt | integer | 模板创建时间
updatedAt | integer | 模板更新时间
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/templates \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc=' \
--header 'content-type: application/json' \
--data '{
"name":"test0013",
"desc":"this is a test",
"deleteAfterDays":6,
"interval":5,
"templateType":1,
"bucket":"bucket-test1",
"jpgOverwriteStatus": true,
"jpgSequenceStatus": true,
"jpgOnDemandStatus": true
}'
**响应示例**
{
"id": "2akrars59hm2l",
"name": "test0013",
"desc": "this is a test",
"bucket": "bucket-test1",
"deleteAfterDays": 0,
"templateType": 1,
"fileType": 0,
"recordType": 0,
"recordFileFormat": 0,
"jpgOverwriteStatus": true,
"jpgSequenceStatus": true,
"jpgOnDemandStatus": true,
"jpgOverwriteFileNameTemplate": "snapshot/jpg/${namespaceId}/${streamId}.jpg",
"jpgSequenceFileNameTemplate": "snapshot/jpg/${namespaceId}/${streamId}/${startMs}.jpg",
"jpgOnDemandFileNameTemplate": "snapshot/jpg/${namespaceId}/${streamId}/ondemand/${startMs}.jpg",
"snapInterval": 10,
"createdAt": 1586847620,
"updatedAt": 1586847620
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,595 |
删除模板 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口 >删除模板
# 删除模板
最近更新时间: 2020-05-06 15:31:41
# **描述**
本接口用于删除模版
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：DELETE
* 接口路径：`/v1/templates/{templateId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
templateId | 是 | string | 模版ID
# **响应参数**
无
# **示例**
**请求示例**
curl --request DELETE \
--url http://qvs.qiniuapi.com/v1/templates/2akrars59hm2l \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口 >删除模板
# 删除模板
最近更新时间: 2020-05-06 15:31:41
# **描述**
本接口用于删除模版
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：DELETE
* 接口路径：`/v1/templates/{templateId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
templateId | 是 | string | 模版ID
# **响应参数**
无
# **示例**
**请求示例**
curl --request DELETE \
--url http://qvs.qiniuapi.com/v1/templates/2akrars59hm2l \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,602 |
更新模板 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口 >更新模板
# 更新模板
最近更新时间: 2022-03-11 15:43:42
# **描述**
本接口用于更新模版信息。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：PATCH
* 接口路径：`/v1/templates/{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 | 模版名称
desc | string | 模版描述
bucket | string | 模版对应的对象存储的bucket
deleteAfterDays | integer | 存储过期时间，默认永久不过期
fileType | integer | 文件存储类型，取值：0（普通存储），1（低频存储）
recordType | integer | 录制模式，取值：0（不录制），1（实时录制），2(按需录制)
jpgOverwriteStatus | boolean | 开启覆盖式截图(一般用于流封面)
recordInterval | integer | 录制文件时长，单位为秒，600~7200
snapInterval | integer | 截图间隔，单位为秒，1~600，按需截图可以忽略
jpgSequenceStatus | boolean | 开启实时截图
jpgOnDemandStatus | boolean | 开启按需截图
recordFileFormat | integer | 录制文件存储格式(多选)，范围：1(001)～7(111), 从左往右的三位二进制数分别代表MP4，FLV，M3U8；0代表不选择该格式，1代表选择；例如：2(010)代表选择FLV格式，6(110)代表选择MP4和FLV格式，1(001)代表选择M3U8格式，7(111)代表三种格式均选择
# **响应参数**
响应参数与创建模板一致，请参阅**创建模板**[响应参数
__](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":"recordType","op":"replace","value":1}]
}'
**响应示例**
{
"id": "d102sns2mwhd",
"name": "test009",
"bucket": "bucket-test1",
"deleteAfterDays": 0,
"templateType": 0,
"fileType": 0,
"recordType": 1,
"recordFileFormat": 1,
"tsFileNameTemplate": "record/ts/${namespaceId}/${streamId}/${startMs}-${endMs}.ts",
"recordSnapFileNameTemplate": "record/snap/${namespaceId}/${streamId}/${startMs}.jpg",
"jpgOverwriteStatus": false,
"jpgSequenceStatus": false,
"jpgOnDemandStatus": false,
"snapInterval": 10,
"createdAt": 1585104103,
"updatedAt": 1586849432
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口 >更新模板
# 更新模板
最近更新时间: 2022-03-11 15:43:42
# **描述**
本接口用于更新模版信息。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：PATCH
* 接口路径：`/v1/templates/{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 | 模版名称
desc | string | 模版描述
bucket | string | 模版对应的对象存储的bucket
deleteAfterDays | integer | 存储过期时间，默认永久不过期
fileType | integer | 文件存储类型，取值：0（普通存储），1（低频存储）
recordType | integer | 录制模式，取值：0（不录制），1（实时录制），2(按需录制)
jpgOverwriteStatus | boolean | 开启覆盖式截图(一般用于流封面)
recordInterval | integer | 录制文件时长，单位为秒，600~7200
snapInterval | integer | 截图间隔，单位为秒，1~600，按需截图可以忽略
jpgSequenceStatus | boolean | 开启实时截图
jpgOnDemandStatus | boolean | 开启按需截图
recordFileFormat | integer | 录制文件存储格式(多选)，范围：1(001)～7(111), 从左往右的三位二进制数分别代表MP4，FLV，M3U8；0代表不选择该格式，1代表选择；例如：2(010)代表选择FLV格式，6(110)代表选择MP4和FLV格式，1(001)代表选择M3U8格式，7(111)代表三种格式均选择
# **响应参数**
响应参数与创建模板一致，请参阅**创建模板**[响应参数
__](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":"recordType","op":"replace","value":1}]
}'
**响应示例**
{
"id": "d102sns2mwhd",
"name": "test009",
"bucket": "bucket-test1",
"deleteAfterDays": 0,
"templateType": 0,
"fileType": 0,
"recordType": 1,
"recordFileFormat": 1,
"tsFileNameTemplate": "record/ts/${namespaceId}/${streamId}/${startMs}-${endMs}.ts",
"recordSnapFileNameTemplate": "record/snap/${namespaceId}/${streamId}/${startMs}.jpg",
"jpgOverwriteStatus": false,
"jpgSequenceStatus": false,
"jpgOnDemandStatus": false,
"snapInterval": 10,
"createdAt": 1585104103,
"updatedAt": 1586849432
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,604 |
查询模板信息 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口 >查询模板信息
# 查询模板信息
最近更新时间: 2022-03-11 15:45:08
# **描述**
本接口用于查询模版。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/templates/{templateId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
templateId | 是 | string | 模版ID
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
name | string | 模版名称
desc | string | 模版描述
bucket | string | 模版对应的对象存储的bucket
deleteAfterDays | integer | 存储过期时间，默认永久不过期
fileType | integer | 文件存储类型，取值：0（普通存储），1（低频存储）
recordFileFormat | integer | 录制文件存储格式(多选)，范围：1(001)～7(111)，从左往右的三位二进制数分别代表MP4，FLV，M3U8；0代表不选择该格式，1代表选择；例如：2(010)代表选择FLV格式，6(110)代表选择MP4和FLV格式，1(001)代表选择M3U8格式，7(111)代表三种格式均选择
templateType | integer | 模板类型，取值：0（录制模版），1（截图模版）
recordType | integer | 录制模式，取值：0（不录制），1（实时录制），2（按需录制）
jpgOverwriteStatus | boolean | 开启覆盖式截图(一般用于流封面)
jpgSequenceStatus | boolean | 开启实时截图
jpgOnDemandStatus | boolean | 开启按需截图
tsFileNameTemplate | string | ts文件命名格式
m3u8FileNameTemplate | string | m3u8文件命名格式
flvFileNameTemplate | string | flv文件命名格式
mp4FileNameTemplate | string | mp4文件命名格式
jpgOverwriteFileNameTemplate | string | 覆盖式截图文件命名格式
jpgSequenceFileNameTemplate | string | 实时截图文件命名格式
recordInterval | integer | 录制文件时长，单位为秒，600~7200
snapInterval | integer | 截图间隔，单位为秒，1~600，按需截图可以忽略
createdAt | integer | 模板创建时间
updatedAt | integer | 模板更新时间
zone | string | 模板的bucket区域
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/templates/2akrars59hm2l \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"id": "2akrars59hm2l",
"name": "test0013",
"desc": "this is a test",
"bucket": "bucket-test1",
"deleteAfterDays": 0,
"templateType": 1,
"fileType": 0,
"recordType": 0,
"recordFileFormat": 0,
"jpgOverwriteStatus": true,
"jpgSequenceStatus": true,
"jpgOnDemandStatus": true,
"jpgOverwriteFileNameTemplate": "snapshot/jpg/${namespaceId}/${streamId}.jpg",
"jpgSequenceFileNameTemplate": "snapshot/jpg/${namespaceId}/${streamId}/${startMs}.jpg",
"jpgOnDemandFileNameTemplate": "snapshot/jpg/${namespaceId}/${streamId}/ondemand/${startMs}.jpg",
"createdAt": 1586847620,
"updatedAt": 1586847620,
"snapInterval": 5,
"zone": "z1"
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口 >查询模板信息
# 查询模板信息
最近更新时间: 2022-03-11 15:45:08
# **描述**
本接口用于查询模版。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/templates/{templateId}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
templateId | 是 | string | 模版ID
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
name | string | 模版名称
desc | string | 模版描述
bucket | string | 模版对应的对象存储的bucket
deleteAfterDays | integer | 存储过期时间，默认永久不过期
fileType | integer | 文件存储类型，取值：0（普通存储），1（低频存储）
recordFileFormat | integer | 录制文件存储格式(多选)，范围：1(001)～7(111)，从左往右的三位二进制数分别代表MP4，FLV，M3U8；0代表不选择该格式，1代表选择；例如：2(010)代表选择FLV格式，6(110)代表选择MP4和FLV格式，1(001)代表选择M3U8格式，7(111)代表三种格式均选择
templateType | integer | 模板类型，取值：0（录制模版），1（截图模版）
recordType | integer | 录制模式，取值：0（不录制），1（实时录制），2（按需录制）
jpgOverwriteStatus | boolean | 开启覆盖式截图(一般用于流封面)
jpgSequenceStatus | boolean | 开启实时截图
jpgOnDemandStatus | boolean | 开启按需截图
tsFileNameTemplate | string | ts文件命名格式
m3u8FileNameTemplate | string | m3u8文件命名格式
flvFileNameTemplate | string | flv文件命名格式
mp4FileNameTemplate | string | mp4文件命名格式
jpgOverwriteFileNameTemplate | string | 覆盖式截图文件命名格式
jpgSequenceFileNameTemplate | string | 实时截图文件命名格式
recordInterval | integer | 录制文件时长，单位为秒，600~7200
snapInterval | integer | 截图间隔，单位为秒，1~600，按需截图可以忽略
createdAt | integer | 模板创建时间
updatedAt | integer | 模板更新时间
zone | string | 模板的bucket区域
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/templates/2akrars59hm2l \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"id": "2akrars59hm2l",
"name": "test0013",
"desc": "this is a test",
"bucket": "bucket-test1",
"deleteAfterDays": 0,
"templateType": 1,
"fileType": 0,
"recordType": 0,
"recordFileFormat": 0,
"jpgOverwriteStatus": true,
"jpgSequenceStatus": true,
"jpgOnDemandStatus": true,
"jpgOverwriteFileNameTemplate": "snapshot/jpg/${namespaceId}/${streamId}.jpg",
"jpgSequenceFileNameTemplate": "snapshot/jpg/${namespaceId}/${streamId}/${startMs}.jpg",
"jpgOnDemandFileNameTemplate": "snapshot/jpg/${namespaceId}/${streamId}/ondemand/${startMs}.jpg",
"createdAt": 1586847620,
"updatedAt": 1586847620,
"snapInterval": 5,
"zone": "z1"
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,609 |
获取模板列表 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口 >获取模板列表
# 获取模板列表
最近更新时间: 2022-08-10 11:18:12
# **描述**
本接口用于获取模板列表。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/templates?offset=<offset>&line=<line>&templateType=<templateType>&match=<match>&sortBy=<sortBy>&zone=<zone>`
* Get请求，通过`非SDK`方式调用的客户，http头部Content-Type,`要么设置为application/x-www-form-urlencoded`,`要么置空`, `要么不要携带`; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
line | 否 | integer | 一次返回多少条，最多1000,当超过1000条时，需要结合offset 循环读取。
offset | 否 | integer | 偏移量，当需要循环读取时,初始值offset = 0, 第N次请求时offset = (N -1) * line
sortBy | 否 | string | 默认按创建时间降序排列，sortBy由"asc/desc"和可参与排序的字段组成，其中 asc 表示升序，desc 表示降序，可参与排序的字段有createdAt，updatedAt。asc:updatedAt表示更新时间从小到大排序，desc:updatedAt表示更新时间从大到小排序
templateType | 否 | integer | 模板类型，取值：0（录制模版），1（截图模版）3（AI模版）
match | 否 | string | 模糊匹配查询(模版名称包含match串时返回)
zone | 否 | string | zone为服务区域，可根据服务区域筛选出对应区域的下模板，可选项为z0，z1，z2。z0表示华东、z1表示华北、z2表示华南
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
items | 模版数组 | 模版数组
items.name | string | 模版名称
items.desc | string | 模版描述
items.bucket | string | 模版对应的对象存储的bucket
items.deleteAfterDays | integer | 存储过期时间，默认永久不过期
items.fileType | integer | 文件存储类型，取值：0（普通存储），1（低频存储）
items.recordFileFormat | integer | 录制文件存储格式(多选)，范围：1(001)～7(111)，从左往右的三位二进制数分别代表MP4,LV，M3U8；0代表不选择该格式，1代表选择；例如：2(010)代表选择FLV格式，6(110)代表选择MP4和FLV格式，1(001)代表选择M3U8格式，7(111)代表三种格式均选择
items.templateType | integer | 模板类型，取值：0（录制模版），1（截图模版）, 3（AI模版）
items.recordType | integer | 录制模式，取值：0（不录制），1（实时录制）
items.jpgOverwriteStatus | boolean | 开启覆盖式截图(一般用于流封面)
items.jpgSequenceStatus | boolean | 开启实时截图
items.recordInterval | integer | 录制文件时长，单位为秒，600~7200
items.snapInterval | integer | 截图间隔，单位为秒，1~600，按需截图可以忽略
items.tsFileNameTemplate | string | ts文件命名格式
items.m3u8FileNameTemplate | string | m3u8文件命名格式
items.flvFileNameTemplate | string | flv文件命名格式
items.mp4FileNameTemplate | string | mp4文件命名格式
items.jpgOverwriteFileNameTemplate | string | 覆盖式截图文件命名格式
items.jpgSequenceFileNameTemplate | string | 实时截图文件命名格式
items.createdAt | integer | 模版创建时间
items.updatedAt | integer | 模版更新时间
items.zone | string | 模版对应的bucket区域
total | integer | 模版总数量
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/templates?templateType=0 \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"items": [
{
"id": "2akrars5b81f5",
"name": "test0016",
"desc": "this is a test",
"bucket": "bucket-test1",
"deleteAfterDays": 0,
"templateType": 0,
"fileType": 0,
"recordType": 0,
"recordFileFormat": 1,
"tsFileNameTemplate": "record/ts/${namespaceId}/${streamId}/${startMs}-${endMs}.ts",
"recordSnapFileNameTemplate": "record/snap/${namespaceId}/${streamId}/${startMs}.jpg",
"createdAt": 1586850533,
"updatedAt": 1586850533,
"interval": 10,
"zone": "z1"
},
{
"id": "d102sns2mwhd",
"name": "test009",
"bucket": "bucket-test1",
"deleteAfterDays": 0,
"templateType": 0,
"fileType": 0,
"interval": 5,
"recordType": 1,
"recordFileFormat": 1,
"tsFileNameTemplate": "record/ts/${namespaceId}/${streamId}/${startMs}-${endMs}.ts",
"recordSnapFileNameTemplate": "record/snap/${namespaceId}/${streamId}/${startMs}.jpg",
"createdAt": 1585104103,
"updatedAt": 1586849432,
"interval": 10,
"zone": "z1"
}
],
"total": 2
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 模板管理相关接口 >获取模板列表
# 获取模板列表
最近更新时间: 2022-08-10 11:18:12
# **描述**
本接口用于获取模板列表。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/templates?offset=<offset>&line=<line>&templateType=<templateType>&match=<match>&sortBy=<sortBy>&zone=<zone>`
* Get请求，通过`非SDK`方式调用的客户，http头部Content-Type,`要么设置为application/x-www-form-urlencoded`,`要么置空`, `要么不要携带`; [公共http header说明 __](https://developer.qiniu.com/qvs/6709/qvs-http-headers)
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
line | 否 | integer | 一次返回多少条，最多1000,当超过1000条时，需要结合offset 循环读取。
offset | 否 | integer | 偏移量，当需要循环读取时,初始值offset = 0, 第N次请求时offset = (N -1) * line
sortBy | 否 | string | 默认按创建时间降序排列，sortBy由"asc/desc"和可参与排序的字段组成，其中 asc 表示升序，desc 表示降序，可参与排序的字段有createdAt，updatedAt。asc:updatedAt表示更新时间从小到大排序，desc:updatedAt表示更新时间从大到小排序
templateType | 否 | integer | 模板类型，取值：0（录制模版），1（截图模版）3（AI模版）
match | 否 | string | 模糊匹配查询(模版名称包含match串时返回)
zone | 否 | string | zone为服务区域，可根据服务区域筛选出对应区域的下模板，可选项为z0，z1，z2。z0表示华东、z1表示华北、z2表示华南
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
items | 模版数组 | 模版数组
items.name | string | 模版名称
items.desc | string | 模版描述
items.bucket | string | 模版对应的对象存储的bucket
items.deleteAfterDays | integer | 存储过期时间，默认永久不过期
items.fileType | integer | 文件存储类型，取值：0（普通存储），1（低频存储）
items.recordFileFormat | integer | 录制文件存储格式(多选)，范围：1(001)～7(111)，从左往右的三位二进制数分别代表MP4,LV，M3U8；0代表不选择该格式，1代表选择；例如：2(010)代表选择FLV格式，6(110)代表选择MP4和FLV格式，1(001)代表选择M3U8格式，7(111)代表三种格式均选择
items.templateType | integer | 模板类型，取值：0（录制模版），1（截图模版）, 3（AI模版）
items.recordType | integer | 录制模式，取值：0（不录制），1（实时录制）
items.jpgOverwriteStatus | boolean | 开启覆盖式截图(一般用于流封面)
items.jpgSequenceStatus | boolean | 开启实时截图
items.recordInterval | integer | 录制文件时长，单位为秒，600~7200
items.snapInterval | integer | 截图间隔，单位为秒，1~600，按需截图可以忽略
items.tsFileNameTemplate | string | ts文件命名格式
items.m3u8FileNameTemplate | string | m3u8文件命名格式
items.flvFileNameTemplate | string | flv文件命名格式
items.mp4FileNameTemplate | string | mp4文件命名格式
items.jpgOverwriteFileNameTemplate | string | 覆盖式截图文件命名格式
items.jpgSequenceFileNameTemplate | string | 实时截图文件命名格式
items.createdAt | integer | 模版创建时间
items.updatedAt | integer | 模版更新时间
items.zone | string | 模版对应的bucket区域
total | integer | 模版总数量
# **示例**
**请求示例**
curl --request GET \
--url http://qvs.qiniuapi.com/v1/templates?templateType=0 \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"items": [
{
"id": "2akrars5b81f5",
"name": "test0016",
"desc": "this is a test",
"bucket": "bucket-test1",
"deleteAfterDays": 0,
"templateType": 0,
"fileType": 0,
"recordType": 0,
"recordFileFormat": 1,
"tsFileNameTemplate": "record/ts/${namespaceId}/${streamId}/${startMs}-${endMs}.ts",
"recordSnapFileNameTemplate": "record/snap/${namespaceId}/${streamId}/${startMs}.jpg",
"createdAt": 1586850533,
"updatedAt": 1586850533,
"interval": 10,
"zone": "z1"
},
{
"id": "d102sns2mwhd",
"name": "test009",
"bucket": "bucket-test1",
"deleteAfterDays": 0,
"templateType": 0,
"fileType": 0,
"interval": 5,
"recordType": 1,
"recordFileFormat": 1,
"tsFileNameTemplate": "record/ts/${namespaceId}/${streamId}/${startMs}-${endMs}.ts",
"recordSnapFileNameTemplate": "record/snap/${namespaceId}/${streamId}/${startMs}.jpg",
"createdAt": 1585104103,
"updatedAt": 1586849432,
"interval": 10,
"zone": "z1"
}
],
"total": 2
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,614 |
更新域名信息 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 域名管理相关接口 >更新域名信息
# 更新域名信息
最近更新时间: 2022-01-14 10:43:59
# **描述**
本接口用于更新域名信息
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：PATCH
* 接口路径：`/v1/namespaces/{namespaceId}/domains/{domain}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间名称ID
domain | 是 | string | 域名
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations | 是 | op数组 | op集合，详见： _表一_
_表一：_ OP集合参数
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations.key | 是 | string | 要修改的参数
operations.op | 是 | string | op操作(目前支持replace和delete)
operations.value | 是 | object | 要修改的参数对应的value(当op为delete的时候可以忽略)
_表二：_ 可编辑参数说明
参数名称 | 字段类型 | 说明
---|---|---
isDefault | boolean | 是否默认域名
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
domain | Object | 域名信息
domain.domain | string | 域名
domain.type | string | 域名类型 “publishRtmp”:rtmp推流, “liveRtmp”: rtmp播放, “liveHls”: HLS, “liveHdl”: HDL, “liveWebrtc”: webrtc, “live”: 统一播放
domain.cname | integer | cname
domain.state | integer | 0: 未配置CNAME，1: 可用，2: 不可用
domain.isDefault | boolean | 是否默认域名
domain.createdAt | integer | 创建时间
domain.playSecurity | object | 时间戳防盗链
domain.playSecurity.open | boolean | 时间戳防盗链开关
domain.playSecurity.expireAfter | integer | 时间戳过期时长，单位：秒
domain.playSecurity.primary | string | 主KEY
domain.playSecurity.secondary | string | 备用KEY
domain.httpsSwitch | object | https开关
domain.httpsSwitch.certid | string | 证书id
domain.httpsSwitch.httpsOpen | boolean | https开关
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 域名管理相关接口 >更新域名信息
# 更新域名信息
最近更新时间: 2022-01-14 10:43:59
# **描述**
本接口用于更新域名信息
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：PATCH
* 接口路径：`/v1/namespaces/{namespaceId}/domains/{domain}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间名称ID
domain | 是 | string | 域名
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations | 是 | op数组 | op集合，详见： _表一_
_表一：_ OP集合参数
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
operations.key | 是 | string | 要修改的参数
operations.op | 是 | string | op操作(目前支持replace和delete)
operations.value | 是 | object | 要修改的参数对应的value(当op为delete的时候可以忽略)
_表二：_ 可编辑参数说明
参数名称 | 字段类型 | 说明
---|---|---
isDefault | boolean | 是否默认域名
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
domain | Object | 域名信息
domain.domain | string | 域名
domain.type | string | 域名类型 “publishRtmp”:rtmp推流, “liveRtmp”: rtmp播放, “liveHls”: HLS, “liveHdl”: HDL, “liveWebrtc”: webrtc, “live”: 统一播放
domain.cname | integer | cname
domain.state | integer | 0: 未配置CNAME，1: 可用，2: 不可用
domain.isDefault | boolean | 是否默认域名
domain.createdAt | integer | 创建时间
domain.playSecurity | object | 时间戳防盗链
domain.playSecurity.open | boolean | 时间戳防盗链开关
domain.playSecurity.expireAfter | integer | 时间戳过期时长，单位：秒
domain.playSecurity.primary | string | 主KEY
domain.playSecurity.secondary | string | 备用KEY
domain.httpsSwitch | object | https开关
domain.httpsSwitch.certid | string | 证书id
domain.httpsSwitch.httpsOpen | boolean | https开关
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,620 |
删除域名 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 域名管理相关接口 >删除域名
# 删除域名
最近更新时间: 2022-04-29 12:20:50
# **描述**
本接口用于创建域名相关信息, 仅适用于空间模式为`静态地址`的空间。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：DELETE
* 接口路径：`/v1/namespaces/{namespaceId}/domains/{domain}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
domain | 是 | string | 要删除的域名
# **响应参数**
{
"code": 200
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 域名管理相关接口 >删除域名
# 删除域名
最近更新时间: 2022-04-29 12:20:50
# **描述**
本接口用于创建域名相关信息, 仅适用于空间模式为`静态地址`的空间。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：DELETE
* 接口路径：`/v1/namespaces/{namespaceId}/domains/{domain}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
domain | 是 | string | 要删除的域名
# **响应参数**
{
"code": 200
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,624 |
修改域名时间戳防盗链配置 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 域名管理相关接口 >修改域名时间戳防盗链配置
# 修改域名时间戳防盗链配置
最近更新时间: 2022-09-26 10:41:39
本接口用于修改时间戳防盗链配置
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/domains/{domain}/playsecurity`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间名称ID
domain | 是 | string | 域名
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
open | 是 | boolean | 时间戳防盗链开关
expireAfter | 是 | integer | 防盗链过期时长（单位：秒）
primary | 是 | string | 主KEY
secondary | 是 | string | 备用KEY
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/3nm4x0vyz7xlu/domains/qvs-live-webrtc1.vs.qnlinking.com/playsecurity \
--header 'authorization: Qiniu your_authorization_token' \
--header 'content-type: application/json' \
--data '{"open":true,"expireAfter":3600,"primary":"your_primary_key","secondary":"your_sencondary_key"}'
**响应示例**
{"code":200}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 域名管理相关接口 >修改域名时间戳防盗链配置
# 修改域名时间戳防盗链配置
最近更新时间: 2022-09-26 10:41:39
本接口用于修改时间戳防盗链配置
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/domains/{domain}/playsecurity`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间名称ID
domain | 是 | string | 域名
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
open | 是 | boolean | 时间戳防盗链开关
expireAfter | 是 | integer | 防盗链过期时长（单位：秒）
primary | 是 | string | 主KEY
secondary | 是 | string | 备用KEY
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/3nm4x0vyz7xlu/domains/qvs-live-webrtc1.vs.qnlinking.com/playsecurity \
--header 'authorization: Qiniu your_authorization_token' \
--header 'content-type: application/json' \
--data '{"open":true,"expireAfter":3600,"primary":"your_primary_key","secondary":"your_sencondary_key"}'
**响应示例**
{"code":200}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,625 |
创建域名 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 域名管理相关接口 >创建域名
# 创建域名
最近更新时间: 2022-04-29 12:21:25
# **描述**
本接口用于创建域名相关信息, 仅适用于空间模式为`静态地址`的空间。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/domains`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
domain | 是 | string | 域名
type | 是 | string | 类型,"publishRtmp"代表域名用于推流(`仅适用RTMP类型空间`), "live"代表域名用于播放(`适用所有类型的空间`)
# **响应参数**
{
"code": 200
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 域名管理相关接口 >创建域名
# 创建域名
最近更新时间: 2022-04-29 12:21:25
# **描述**
本接口用于创建域名相关信息, 仅适用于空间模式为`静态地址`的空间。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/domains`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
domain | 是 | string | 域名
type | 是 | string | 类型,"publishRtmp"代表域名用于推流(`仅适用RTMP类型空间`), "live"代表域名用于播放(`适用所有类型的空间`)
# **响应参数**
{
"code": 200
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,627 |
获取域名列表 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 域名管理相关接口 >获取域名列表
# 获取域名列表
最近更新时间: 2022-01-14 10:38:20
# **描述**
本接口用于获取域名列表
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/namespaces/{namespaceId}/domains`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间名称ID
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
items | 域名数组 | 域名数组
items.domain | string | 域名
items.type | string | 域名类型
items.cname | string | cname
items.state | integer | 0: 未配置CNAME，1: 可用，2: 不可用
items.isDefault | boolean | 是否默认域名
items.createdAt | integer | 创建时间，Unix时间戳，秒
items.playSecurity | playSecurity | 时间戳防盗链
items.playSecurity.open | boolean | 时间戳防盗链开关
items.playSecurity.primary | string | 时间戳防盗链主KEY
items.playSecurity.secondary | string | 时间戳防盗链备用KEY
items.playSecurity.expireAfter | integer | 防盗链过期时长（单位：秒）
items.httpsSwitch | httpsSwitch | https开关
items.httpsSwitch.httpsOpen | boolean | https开关
items.httpsSwitch.certid | string | 证书id
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 域名管理相关接口 >获取域名列表
# 获取域名列表
最近更新时间: 2022-01-14 10:38:20
# **描述**
本接口用于获取域名列表
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/namespaces/{namespaceId}/domains`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间名称ID
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
items | 域名数组 | 域名数组
items.domain | string | 域名
items.type | string | 域名类型
items.cname | string | cname
items.state | integer | 0: 未配置CNAME，1: 可用，2: 不可用
items.isDefault | boolean | 是否默认域名
items.createdAt | integer | 创建时间，Unix时间戳，秒
items.playSecurity | playSecurity | 时间戳防盗链
items.playSecurity.open | boolean | 时间戳防盗链开关
items.playSecurity.primary | string | 时间戳防盗链主KEY
items.playSecurity.secondary | string | 时间戳防盗链备用KEY
items.playSecurity.expireAfter | integer | 防盗链过期时长（单位：秒）
items.httpsSwitch | httpsSwitch | https开关
items.httpsSwitch.httpsOpen | boolean | https开关
items.httpsSwitch.certid | string | 证书id
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,629 |
获取证书列表 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 域名管理相关接口 >获取证书列表
# 获取证书列表
最近更新时间: 2020-07-06 11:32:40
# **描述**
本接口用于查询用户已购买或已上传的自有证书的列表
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/namespaces/{namespaceId}/domains/{domain}/certs`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间名称ID
domain | 是 | string | 域名
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
items | 证书数组 | 证书数组
items.certid | string | 证书id
items.name | string | 证书名称
items.notBefore | int64 | 证书有效期起始时间
items.notAfter | int64 | 证书有效期截止时间
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 域名管理相关接口 >获取证书列表
# 获取证书列表
最近更新时间: 2020-07-06 11:32:40
# **描述**
本接口用于查询用户已购买或已上传的自有证书的列表
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/namespaces/{namespaceId}/domains/{domain}/certs`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间名称ID
domain | 是 | string | 域名
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
items | 证书数组 | 证书数组
items.certid | string | 证书id
items.name | string | 证书名称
items.notBefore | int64 | 证书有效期起始时间
items.notAfter | int64 | 证书有效期截止时间
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,632 |
域名对应的HTTPs开关 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 域名管理相关接口 >域名对应的HTTPs开关
# 域名对应的HTTPs开关
最近更新时间: 2020-07-08 14:41:27
# **描述**
本接口用于开启或关闭域名对应的HTTPs开关
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/domains/{domain}/ssls`
* 使用场景：当用户有安全需求时，可通过此开关开启或关闭HTTPs保证安全可靠
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间名称ID
domain | 是 | string | 域名
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
certid | 是 | string | 证书Id
httpsOpen | 是 | boolen | https开关
# **响应参数**
200
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 域名管理相关接口 >域名对应的HTTPs开关
# 域名对应的HTTPs开关
最近更新时间: 2020-07-08 14:41:27
# **描述**
本接口用于开启或关闭域名对应的HTTPs开关
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/domains/{domain}/ssls`
* 使用场景：当用户有安全需求时，可通过此开关开启或关闭HTTPs保证安全可靠
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间名称ID
domain | 是 | string | 域名
**Body**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
certid | 是 | string | 证书Id
httpsOpen | 是 | boolen | https开关
# **响应参数**
200
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,634 |
获取域名信息 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 域名管理相关接口 >获取域名信息
# 获取域名信息
最近更新时间: 2020-12-16 12:05:21
# **描述**
本接口用于查询域名相关信息(cname，时间戳防盗链，https配置)。涉及域名的API，仅适用于空间模式为“静态地址”的空间。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/namespaces/{namespaceId}/domains/{domain}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间名称ID
domain | 是 | string | 域名
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
domain | Object | 域名信息
domain.domain | string | 域名
domain.type | string | 域名类型 "publishRtmp":rtmp推流, "liveRtmp": rtmp播放, "liveHls": HLS, "liveHdl": HDL
domain.cname | integer | cname
domain.state | integer | 0: 未配置CNAME，1: 可用，2: 不可用
domain.isDefault | boolean | 是否默认域名
domain.createdAt | integer | 创建时间
domain.playSecurity | object | 时间戳防盗链
domain.playSecurity.open | boolean | 时间戳防盗链开关
domain.playSecurity.primary | string | 主KEY
domain.playSecurity.secondary | string | 备用KEY
domain.httpsSwitch | object | https开关
domain.httpsSwitch.certid | string | 证书id
domain.httpsSwitch.httpsOpen | boolean | https开关
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 域名管理相关接口 >获取域名信息
# 获取域名信息
最近更新时间: 2020-12-16 12:05:21
# **描述**
本接口用于查询域名相关信息(cname，时间戳防盗链，https配置)。涉及域名的API，仅适用于空间模式为“静态地址”的空间。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：GET
* 接口路径：`/v1/namespaces/{namespaceId}/domains/{domain}`
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间名称ID
domain | 是 | string | 域名
# **响应参数**
参数名称 | 类型 | 说明
---|---|---
domain | Object | 域名信息
domain.domain | string | 域名
domain.type | string | 域名类型 "publishRtmp":rtmp推流, "liveRtmp": rtmp播放, "liveHls": HLS, "liveHdl": HDL
domain.cname | integer | cname
domain.state | integer | 0: 未配置CNAME，1: 可用，2: 不可用
domain.isDefault | boolean | 是否默认域名
domain.createdAt | integer | 创建时间
domain.playSecurity | object | 时间戳防盗链
domain.playSecurity.open | boolean | 时间戳防盗链开关
domain.playSecurity.primary | string | 主KEY
domain.playSecurity.secondary | string | 备用KEY
domain.httpsSwitch | object | https开关
domain.httpsSwitch.certid | string | 证书id
domain.httpsSwitch.httpsOpen | boolean | https开关
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,636 |
启动按需录制 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 录制管理相关接口 >启动按需录制
# 启动按需录制
最近更新时间: 2022-05-10 18:31:33
# **描述**
本接口用于对指定流启动按需录制。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}/record/start`
* 本接口需要空间绑定`按需录制`类型的模板，或者流本身绑定`按需录制`模板。当用户想在每天9：00到12：00进行流录制，可分别在对应时间点通过本接口和[停止按需录制 __](https://developer.qiniu.com/qvs/6744/stop-record-stream)组合使用。
* 本接口的效果，包含了2步，[`启动设备拉流` __](https://developer.qiniu.com/qvs/6907/start-device)+`开始录像`；所以调用了本接口，不需要在调用`启动设备拉流`API
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
streamId | 是 | string | 流Id
# **响应参数**
200
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/streams/31011500991320000028/record/start \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 录制管理相关接口 >启动按需录制
# 启动按需录制
最近更新时间: 2022-05-10 18:31:33
# **描述**
本接口用于对指定流启动按需录制。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}/record/start`
* 本接口需要空间绑定`按需录制`类型的模板，或者流本身绑定`按需录制`模板。当用户想在每天9：00到12：00进行流录制，可分别在对应时间点通过本接口和[停止按需录制 __](https://developer.qiniu.com/qvs/6744/stop-record-stream)组合使用。
* 本接口的效果，包含了2步，[`启动设备拉流` __](https://developer.qiniu.com/qvs/6907/start-device)+`开始录像`；所以调用了本接口，不需要在调用`启动设备拉流`API
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
streamId | 是 | string | 流Id
# **响应参数**
200
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/streams/31011500991320000028/record/start \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,639 |
停止按需录制 | 视频监控 | [视频监控](https://developer.qiniu.com/qvs) > API 文档 > 录制管理相关接口 >停止按需录制
# 停止按需录制
最近更新时间: 2023-05-05 15:16:41
# **描述**
本接口用于对指定流停止按需录制， 和[开始按需录制 __](https://developer.qiniu.com/qvs/6743/start-
record-stream)配套使用。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}/record/stop`
* 本接口需要空间绑定`"按需录制"类型的模板`，或者流本身绑定`按需录制`模板。当用户想在每天9：00到12：00进行流录制，可分别在对应时间点通过[启动按需录制 __](https://developer.qiniu.com/qvs/6743/start-record-stream)和本接口组合使用。
* 如果在停止按需录制后，需要终止设备推流，可以在调用[终止设备推流 __](https://developer.qiniu.com/qvs/6908/stop-device)
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
streamId | 是 | string | 流Id
# **响应参数**
200
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/streams/31011500991320000028/record/stop \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
| * __
* __
* __
* __
* __
[视频监控](https://developer.qiniu.com/qvs) > API 文档 > 录制管理相关接口 >停止按需录制
# 停止按需录制
最近更新时间: 2023-05-05 15:16:41
# **描述**
本接口用于对指定流停止按需录制， 和[开始按需录制 __](https://developer.qiniu.com/qvs/6743/start-
record-stream)配套使用。
* 接口请求域名：`qvs.qiniuapi.com`
* 请求方式：POST
* 接口路径：`/v1/namespaces/{namespaceId}/streams/{streamId}/record/stop`
* 本接口需要空间绑定`"按需录制"类型的模板`，或者流本身绑定`按需录制`模板。当用户想在每天9：00到12：00进行流录制，可分别在对应时间点通过[启动按需录制 __](https://developer.qiniu.com/qvs/6743/start-record-stream)和本接口组合使用。
* 如果在停止按需录制后，需要终止设备推流，可以在调用[终止设备推流 __](https://developer.qiniu.com/qvs/6908/stop-device)
# **请求参数**
**路径参数**
参数名称 | 必填 | 字段类型 | 说明
---|---|---|---
namespaceId | 是 | string | 空间ID
streamId | 是 | string | 流Id
# **响应参数**
200
# **示例**
**请求示例**
curl --request POST \
--url http://qvs.qiniuapi.com/v1/namespaces/2akrarvzvyijd/streams/31011500991320000028/record/stop \
--header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='
**响应示例**
{
"code": 200
}
以上内容是否对您有帮助？
* __
* __
* __
* __
* __
文档反馈 (如有产品使用问题，请[ 提交工单](https://support.qiniu.com/tickets/category))
提交
| 9,641 |
Subsets and Splits