文档中心 > 创建空间
创建空间

最近更新时间:2022-07-05

1、功能介绍

创建新的业务空间

2、请求参数

参数

是否必选

参数类型

描述

Action

String

系统规定参数。取值:CreateGroup

Region

String

空间所属区域

Name

String

空间名称

DeviceProtocol

String

空间使用的接入协议。取值:

rtmp

gb28181

不区分大小写

EnableHls

Bool

是否开启HLS,取值:true、false(不区分大小写)

PushDomain

String

空间使用的推流域名。

由用户选择是否使用推流域名。rtmp此参数必填

PushPrivateKeyStringrtmp推流鉴权key,rtmp空间必填

Callback

String

空间内设备状态、流状态等事件更新时通知用户业务端的回调接口

当传入此参数时,CallbackEventFlags必填且至少开启一个回调事件。当此参数为空时,CallbackEventFlags不可开启回调事件。

CallbackPrivateKeyString

回调接口鉴权密钥。默认没有鉴权。

设置鉴权密钥的场景,鉴权方式如下:

http://you.callback.com?AuthKey=timestamp-md5hash

timestamp:回调接口调用时间戳,为UTC时间。
md5hash:通过md5计算出的字符串,由0-9和小写字母a-z混合组成,固定长度32位。计算方法:

sstring = "timestamp-CallbackPrivateKey"

HashValue = md5sum(sstring)

CallbackEventFlagsString

回调事件标志串,格式:1100

  • 从左到右,第一位表示设备状态,第二位表示流状态,第三位表示录像事件,第四位表示截图事件,其他事件依次向后扩展

  • 1表示开启事件回调,0表示不开启事件回调

当传入此参数且至少开启了一个回调事件,Callback必填。当此参数为空或未开启任何回调事件,Callback必须为空。

最大长度为4,不传时默认按照0000处理。

rtmp协议空间暂不支持设备状态回调事件

StoreDaysLong录像、截图等文件存储天数,单位天。取值:0~1825(5年:5*365天),0表示永久保存
DescriptionString描述信息

3、响应参数

参数

是否必选

参数类型

描述

RequestId

String

该条接口请求ID

CodeString

0成功

其他失败

MessageString错误信息
DataObject返回值,json对象结构

--GroupId

String

空间ID(uuid)

--RtmpHost

String

空间提供的rtmp推流地址

--RtmpPort

Long

空间提供的rtmp推流端口

--PushDomainCName

String推流CName

--PlayDomainCName

String播流CName

--GbServerId

String

空间提供的国标信令服务器ID

--GbServerDomain

String

空间提供的国标信令服务器域,暂时固定为GbServerId的前十位。

--GbServerHost

String

空间提供的国标信令服务器地址

--GbServerTcpPort

Long

空间提供的国标信令服务器TCP端口

--GbServerUdpPort

Long

空间提供的国标信令服务器UDP端口

--CreateTimeString创建时间,格式如:yyyy-MM-ddTHH:mm:ssZ,UTC时间


4、请求示例

请求示例:

创建国标空间:

GET https://api.unicloud.com/univms?

Action=CreateGroup

&Region=cn-tianjin-test

&Name=测试gb空间

&DeviceProtocol=gb28181

&EnableHls=true

&Callback=http://www.callbacktest.com

&CallbackPrivateKey=callbackkey

&CallbackEventFlags=1

&StoreDays=0

&Description=测试gb空间

&公共请求参数


创建RTMP空间:

GET https://api.unicloud.com/univms?

Action=CreateGroup

&Region=cn-tianjin-test

&Name=测试rtmp空间

&DeviceProtocol=RTMP

&EnableHls=true

&PushDomain=rtmp.pushdomian.param

&PushPrivateKey=pushprivatekey

&Callback=http://www.callbacktest.com

&CallbackPrivateKey=callbackkey

&CallbackEventFlags=0111

&StoreDays=0

&Description=测试rtmp空间

&公共请求参数


返回示例:


创建国标空间
{
    "RequestId": "d2b51f45-c0cb-420f-99a0-7c0f6d083548",
    "Code": "0",
    "Data": {
        "GroupId": "uni0341122061674179816",
        "PlayDomainCName": "",
        "GbServerId": "12000000002007840307",
        "GbServerDomain": "1200000000",
        "GbServerHost": "10.0.0.1",
        "GbServerTcpPort": "5080",
        "GbServerUdpPort": "5080",
        "CreateTime": "2022-06-28T09:06:03Z"
    }
}
创建rtmp空间
{
    "RequestId": "4a4bb360-9085-4164-8594-ab8c2d600ee9",
    "Code": "0",
    "Data": {
        "GroupId": "uni0341122060861651533",
        "PushDomainCName": "rtmp.pushdomian.param.gslb.zgycdn.com",
        "PlayDomainCName": "",
        "CreateTime": "2022-06-28T09:06:44Z"
    }
}


5、状态码

状态码

描述

200

OK

400

Bad Request