最近更新时间:2022-10-21
修改空间信息
参数 | 是否必选 | 参数类型 | 描述 |
---|---|---|---|
Action | 是 | String | 系统规定参数。取值:UpdateGroup |
GroupId | 是 | String | 空间ID |
Name | 否 | String | 空间名称 |
EnableHls | 否 | Bool | 是否开启HLS,取值:true、false(不区分大小写) |
EnableAudio | 否 | Bool | 是否开启音频,取值:true、false(不区分大小写) 仅支持 gb28181 协议 |
PushPrivateKey | 否 | String | rtmp推流鉴权key,rtmp空间必填 |
Callback | 否 | String | 空间内设备状态、流状态更新时通知用户业务端的回调接口 当传入此参数时,CallbackEventFlags必填且至少开启一个回调事件。当此参数为空时,CallbackEventFlags不可开启回调事件。 |
ManageStatus | 否 | String | 空间状态(激活、停用)。取值:active,stop(不区分大小写) |
CallbackPrivateKey | 否 | String | 回调接口鉴权密钥。默认没有鉴权。 设置鉴权密钥的场景,鉴权方式如下: http://you.callback.com?AuthKey=timestamp-md5hash timestamp:回调接口调用时间戳,为UTC时间。md5hash:通过md5计算出的字符串,由0-9和小写字母a-z混合组成,固定长度32位。计算方法:sstring = "timestamp-CallbackPrivateKey" HashValue = md5sum(sstring) |
CallbackEventFlags | 否 | String | 回调事件标志串,格式:1100
当传入此参数且至少开启了一个回调事件,Callback必填。当此参数为空或未开启任何回调事件,Callback必须为空。 最大长度为4,不传时默认按照0000处理。 rtmp协议空间暂不支持设备状态回调事件 |
StoreDays | 是 | Long | 录像、截图等文件存储天数,单位天。取值:0~1825(5年:5*365天),0表示永久保存 |
Description | 否 | String | 描述信息 |
参数 | 是否必选 | 参数类型 | 描述 |
---|---|---|---|
RequestId | 是 | String | 该条接口请求ID |
Code | 是 | String | 0成功 其他失败 |
Message | 否 | String | 错误信息 |
Data | 否 | Object | 返回值,json对象结构 |
--GroupId | 否 | String | 空间ID |
请求示例:
GET https://api.unicloud.com/univms?
Action=UpdateGroup
&GroupId=uni0341122061059529433
&Name=修改名称
&EnableHls=false
&PushPrivateKey=testkey
&Callback=http://www.backback.com
&公共参数
响应示例:
{ "RequestId": "0e8267a3-46fa-41ae-b7d4-750bb9618418", "Code": "0", "Data": { "GroupId": "uni0341122061059529433" } } |
状态码 | 描述 |
---|---|
200 | OK |
400 | Bad Request |