修改空间配置
所有文档
menu

智能视联网平台 EVS

修改空间配置

产品详情立即开通

接口描述

本接口用于修改EVS空间配置。

请求(Request)

请求URI

PUT /v1/space/{spaceId}

参数名称 类型 是否必需 描述
spaceId Long 空间ID

请求头域

除公共头域外,无其它特殊头域。

请求体

参数名称 类型 是否必需 描述
spaceName String 空间名称,最大长度64个字符
description String 空间描述,最大长度512个字符
domains Array 空间自定义域名
+ domain String 自定义域名
+ type String 域名类型,推流:UPSTREAM,播放:DOWNSTREAM;GB28181空间无推流域名
upstreamAuth Object 推流鉴权;GB28181空间无推流鉴权
+ enabled Boolean 是否开启推流鉴权
+ key String 鉴权key
+ expire Integer 鉴权过期时间,单位:秒
downstreamAuth Object 播放鉴权
+ enabled Boolean 是否开启播放鉴权
+ key String 鉴权key
+ expire Integer 鉴权过期时间,单位:秒
recording Object 录制配置
+ enabled Boolean 是否开启录制
+ duration Integer 录制单文件时长,单位:秒
+ format String 存储格式,可选:MP4、FLV、M3U8
+ authEnabled Boolean 录制文件下载地址是否开启鉴权
+ authExpire Integer 鉴权URL有效时间,单位:秒
+ recordType String 录制类型,周期录制:PERIOD,循环定时录制:LOOP_TIMER,指定时间定时录制:SPECIAL_TIMER
+ effectiveTimes Array 录制时段,支持多个,录制类型为LOOP_TIMER时必填;输入东八区时间,从00:00:00开始,到23:59:59结束,每段间隔最小一小时
++ effectiveTimeStart String 录制开始时间,格式"HH: mm:ss"
++ effectiveTimeEnd String 录制结束时间,格式"HH: mm:ss"
+ effectiveDates Array 录制指定日期时段,支持多个,录制类型为SPECIAL_TIMER时必填;输入东八区时间,日期选择最大范围为1年,每段间隔最小一小时,最大7天
++ effectiveDateStart String 录制开始日期时间,格式"yyyy-MM-dd HH: mm:ss"
++ effectiveDateEnd String 录制结束日期时间,格式"yyyy-MM-dd HH: mm:ss"
thumbnail Object 截图配置
+ enabled Boolean 是否开启截图
+ bucket String 边缘存储bucket
+ interval Integer 截图周期,单位:秒
+ authEnabled Boolean 截图文件下载地址是否开启鉴权
+ authExpire Integer 鉴权URL有效时间,单位:秒
timeShift Object 时移配置
+ enabled Boolean 是否开启时移
+ range Integer 时移范围,单位:秒
callback Object 通知配置
+ enabled Boolean 是否开启通知
+ types Array 回调类型列表,支持多个,开启时必填;推流回调:ON_PUBLISH,断流回调:ON_UNPUBLISH,截图回调:ON_SNAPSHOT,播放回调:ON_PLAY,停播回调:ON_STOP
+ endpoint String 回调地址,开启时必填;支持http/https,https需用户自己检测域名证书链配置是否正确
+ authEnabled Boolean 回调是否验证签名,默认不验证false
+ key String 回调签名key,用于计算token
gbProperties Object 国标配置
+ inviteImmediate Boolean 立即拉流,默认是。否:只有播放时触发拉流;是:注册后立即拉流
+ streamType String 流类型。可选值:TCP,UDP, bvcp空间只支持TCP
+ codeStream String 码流类型。可选值:MAIN_STREAM,SUB_STREAM, 只有BVCP空间TD_3116B2_16P型号可支持
aiConfig Object AI分析配置
+ enabled Boolean 是否开启AI分析
+ configuration Array AI配置列表
++ type String AI检测类型,FACE:人脸, BODY:人体, ELECTRIC:电动车, CAR_ATTRIBUTE:车辆属性, CAR_MODEL:车型, CAR_PLATE:车牌
++ interval Integer AI截图间隔
++ strategy String AI分析结果入库策略,OPTIMAL:最优, FASTEST:最快, REGULAR:定时
++ effectiveTimes Array 检测生效时段,支持多个;输入东八区时间,从00:00:00开始,到23:59:59结束,每段间隔最小半小时
+++ effectiveTimeStart String 检测生效开始时间,格式"HH:mm:ss"
+++ effectiveTimeEnd String 检测生效结束时间,格式"HH:mm:ss"
+ ftpConfig Object Ftp图片流设置
++ enabled Boolean 是否开启Ftp图片流
++ password String ftp登录password,长度8-32位,支持字符a-zA-Z0-9-_^*
lifecycle Object 数据存储生命周期配置
+ recordLifecycle Integer 录制存储生命周期,默认7天
+ thumbnailLifecycle Integer 截图存储生命周期,默认7天
+ aiLifecycle Integer AI基础算子检测存储生命周期,默认7天
edgeId Long 空间对应的边缘ID
deviceMode String 设备型号,bvcp空间需要
clientSiteBase Object 基础端侧配置,bvcp空间可配置
+ preTime Integer 预录时间 0/3/6,单位:秒
+ stream String 录制码流,默认MAIN,可选值:MAIN/SUB
clientSiteRecording Object 录制端侧配置,bvcp空间可配置
+ enabled Boolean 是否开启录制
+ type String 录制类型,默认TIMING,可选值:TIMING/MOTION
+ effectiveTimes Array 录制时段,最多设置10段
++ effectiveTimeStart String 录制开始时间,格式"HH: mm"
++ effectiveTimeEnd String 录制结束时间,格式"HH: mm"
clientSiteThumbnail Object 截图端侧配置,bvcp空间可配置
+ enabled Boolean 是否开启截图配置
+ interval Integer 截图间隔,单位:秒,最大3600秒
clientSiteAi Object AI端侧配置,bvcp空间可配置
+ enabled Boolean 是否开启AI配置
+ configuration Array AI配置列表
++ type String AI检测类型,ELECTRIC_ELEVATOR
++ target Array 检测对象
+++ targetType String 检测对象类型,可选值:MOTOR, ELE_MOTOR, ELE_BICYCLE, BICYCLE, CHILD_BICYCLE, WHEELBARROW, SCOOTER, ELE_SCOOTER, ELE_TRICYCLE
+++ confidence Double 置信度,0-1
++ effectiveTimes Array 检测生效时段,支持多个;输入东八区时间,从00:00开始,到23:59结束,每段间隔最小半小时
+++ effectiveTimeStart String 检测生效开始时间,格式"HH: mm"
+++ effectiveTimeEnd String 检测生效结束时间,格式"HH: mm"
++ alarmOut Object 报警方式
+++ whiteLight Boolean 闪光报警
+++ trigger Boolean 阻梯信号报警
+++ audio Boolean 声音报警
+++ audioConfig Object 声音报警配置
++++ alarmName String 警戒声音名称,最大长度128字符
++++ audioId String 警戒音id, 自定义警戒音传
++++ times Integer 报警次数,最大50次
++ event Object 触发事件
+++ recordEvent Object 触发事件录像
++++ enabled Boolean 是否开启触发事件录像
+++ thumbnailEvent Object 触发事件抓图
++++ enabled Boolean 是否开启触发事件抓图
clientSiteVideo Object 视频端侧配置,bvcp空间可配置
+ streamConfigs Array 码流配置
++ streamType String 码流类型,主码流:MAIN,子码流:SUB
++ streamName String 码流名称,最大长度32字符
++ resolution String 分辨率,可选值:2592x1520, 2560x1440, 2304x1296, 1920x1080, 1280x720, 704x576, 480x240, 352x288
++ maxBitRate Integer 码率,可选值:8192, 6144, 4096, 3072, 2048, 1024, 768, 512, 256, 128
++ encodeType String 视频编码,可选值:h264, h265
clientSiteOSD Object On-screen Display 菜单端侧配置,bvcp空间可配置
+ time Object 时间戳配置
++ dateFormat String 时间格式,可选值:YYYY-MM-DD/MM-DD-YYYY/DD-MM-YYYY
++ x Integer 水印x坐标, 比例值 x 10000, 如 5000表示50%
++ y Integer 水印y坐标, 比例值 x 10000
+ channelName Object 设备名称配置
++ name String 设备名称,最大长度18字符
++ x Integer 水印x坐标, 比例值 x 10000
++ y Integer 水印y坐标, 比例值 x 10000
+ customs Array 自定义水印
++ value String 水印内容,如有两行使用"\r\n"间隔,最大长度15字符
++ x Integer 水印x坐标, 比例值 x 10000
++ y Integer 水印y坐标, 比例值 x 10000
## 响应(Response)

响应头域

除公共头域外,无其它特殊头域。

响应体

示例

请求示例

PUT /v1/space/1000001 HTTP/1.1
x-bce-date: 2020-03-25T09:28:13Z
host: evs.bj.baidubce.com
content-type: application/json
authorization: bce-auth-v1/e8e4a9ced6794355a9a1b8a20b58d37b/2020-03-25T09:28:13Z/1800/content-type;host;x-date/4a1692dc4bab84f5801f79ea0c1fece3601cf73ecd94409d2a94b3942b971715
   
{
  "description": "evs_space_description",
  "upstreamAuth": {
        "enabled": true,
        "key": "evs_upstream_key",
        "expire": 3600
  },
  "downstreamAuth": {
        "enabled": true,
        "key": "evs_downstream_key",
        "expire": 3600
  },
  "recording": {
        "enabled": true,
        "bucket": "evs_bucket",
        "duration": 600,
        "format": "M3U8",
        "authEnabled": true,
        "authExpire": 3600
  },
  "thumbnail": {
        "enabled": true,
        "bucket": "evs_bucket",
        "interval": 10,
        "authEnabled": true,
        "authExpire": 3600
  }
}

响应示例

HTTP/1.1 200 OK
Transfer-Encoding: chunked
x-bce-request-id: 012b9747-f13a-4a2c-a488-02b221844dca
Cache-Control: no-cache
Server: BWS
Date: Tue, 24 Mar 202 013:34:07 GMT
Content-Type: application/json;charset=UTF-8

错误码

错误码(code) 消息(message) 描述 HTTP状态码
SpaceAlreadyExist space already exist, space name: XXX 空间名称已经存在 400
SpaceResourceUnready space resource unready, maybe your account is overdue, space id : XXX 空间资源正在准备中,如果长时间不可用,请检查你的账号额度 403
上一篇
启用空间
下一篇
查询空间信息