文档中心 > 查询空间详细信息
查询空间详细信息

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

1、功能介绍

查询业务空间的详细信息

2、请求参数

参数

是否必选

参数类型

描述

ActionString系统规定参数。取值:QueryGroupInfo
GroupIdString按空间ID查询

3、响应参数

参数

是否必选

参数类型

描述

RequestId

String

该条接口请求ID

CodeString

0成功

其他失败

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

--GroupId

String

空间ID

--NameString空间名称
--RegionString空间所属区域

--DeviceProtocol

String

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

--EnableHls

Bool

是否开启HLS,取值:true、false

--AppName

String

空间使用的应用名称.
--PushDomain
String

空间使用的推流域名。

--PushDomainCNameString推流CName
--PlayDomainString空间使用的播流域名。
--PlayDomainCNameString播流CName
--CallbackString空间内设备状态、流状态更新时通知用户业务端的回调接口

--CallbackDeviceStatus

Bool
设备回调状态

--CallbackStreamStatus

Bool
流回调状态

--CallbackRecord

Bool
录像回调状态

--CallbackSnapshot

Bool
截图回调状态
--CallbackPrivateKeyString回调接口鉴权密钥。
--ManageStatusString空间管理状态,取值:active、stop
--IsDeletedLong是否已删除,取值:0(否),1(是)
--StoreDaysLong录像、截图等文件存储天数,单位天。取值:0~1825(5年:5*365天),0表示永久保存
--RtmpHostString空间提供的rtmp推流地址
--RtmpPortString空间提供的rtmp推流端口
--GbServerId

String

空间提供的国标信令服务器ID
--GbServerDomainString空间提供的国标信令服务器域
--GbServerHostString空间提供的国标信令服务器地址

--GbServerTcpPort

Long

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

--GbServerUdpPort

Long

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

--PushPrivateKey

String推流鉴权key
--CreateTimeString创建时间格式如:yyyy-MM-ddTHH:mm:ssZ,UTC时间
--UpdateTimeString最近一次更新时间格式如:yyyy-MM-ddTHH:mm:ssZ,UTC时间


4、示例

请求示例:

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

Action=QueryGroupInfo

&GroupId=uni0341122061169746505

&公共请求参数


返回示例:

国标空间:
{
    "RequestId": "f35979db-9cd3-493b-bcd5-8927ad90ced6",
    "Code": "0",
    "Data": {
        "GroupId": "uni0341122060415093097",
        "Name": "测试国标空间",
        "Region": "cn-tianjin-test",
        "DeviceProtocol": "gb28181",
        "EnableHls": true,
        "PushDomain": "",
        "PushDomainCName": "",
        "Callback": "http://www.callbacktest.com",
        "CallbackDeviceStatus": "true",
        "CallbackStreamStatus": "true",
        "CallbackRecord": "true",
        "CallbackSnapshot": "true",
        "CallbackPrivateKey": "callbackkey",
        "ManageStatus": "active",
        "IsDeleted": 0,
        "StoreDays": 0,
        "GbServerId": "12000000002007261675",
        "GbServerDomain": "1200000000",
        "GbServerHost": "10.0.0.1",
        "GbServerTcpPort": 5080,
        "GbServerUdpPort": 5080,
        "CreateTime": "2022-06-28T08:18:15Z",
        "UpdateTime": "2022-06-28T08:18:15Z"
    }
}
rtmp空间:
{
    "RequestId": "b262c531-0384-4483-97b9-9122af8850eb",
    "Code": "0",
    "Data": {
        "GroupId": "uni0341122061402596026",
        "Name": "测试rtmp空间",
        "Region": "cn-tianjin-test",
        "DeviceProtocol": "rtmp",
        "EnableHls": true,
        "PushDomain": "rtmp.pushdomian.param",
        "PushDomainCName": "rtmp.pushdomian.param.gslb.zgycdn.com",
        "Callback": "http://www.callbacktest.com",
        "CallbackDeviceStatus": "true",
        "CallbackStreamStatus": "true",
        "CallbackRecord": "true",
        "CallbackSnapshot": "true",
        "CallbackPrivateKey": "callbackkey",
        "ManageStatus": "active",
        "IsDeleted": 0,
        "StoreDays": 0,
        "GbServerId": "",
        "GbServerDomain": "",
        "GbServerHost": "",
        "GbServerTcpPort": 0,
        "GbServerUdpPort": 0,
        "PushPrivateKey": "pushprivatekey",
        "CreateTime": "2022-06-28T07:04:05Z",
        "UpdateTime": "2022-06-28T07:04:05Z"
    }
}

5、状态码

状态码

描述

200

OK

400

Bad Request