最近更新时间：2022-10-21
查询业务空间的详细信息
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 系统规定参数。取值：QueryGroupInfo |
| GroupId | 是 | String | 按空间ID查询 |
参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
RequestId | 是 | String | 该条接口请求ID |
| Code | 是 | String | 0成功 其他失败 |
| Message | 否 | String | 错误信息 |
| Data | 否 | Object | 返回值，json对象结构 |
--GroupId | 是 | String | 空间ID |
| --Name | 是 | String | 空间名称 |
| --Region | 是 | String | 空间所属区域 |
--DeviceProtocol | 是 | String | 空间使用的接入协议。取值：rtmp、gb28181 |
--EnableHls | 是 | Bool | 是否开启HLS，取值：true、false |
| --EnableAudio | 否 | Bool | 是否开启音频 |
| --AppName | 是 | String | 空间使用的应用名称. |
| --PushDomain | 否 | String | 空间使用的推流域名。 |
| --PushDomainCName | 否 | String | 推流CName |
| --PlayDomain | 否 | String | 空间使用的播流域名。 |
| --PlayDomainCName | 否 | String | 播流CName |
| --Callback | 否 | String | 空间内设备状态、流状态更新时通知用户业务端的回调接口 |
--CallbackDeviceStatus | 否 | Bool | 设备回调状态 |
--CallbackStreamStatus | 否 | Bool | 流回调状态 |
--CallbackRecord | 否 | Bool | 录像回调状态 |
--CallbackSnapshot | 否 | Bool | 截图回调状态 |
| --CallbackPrivateKey | 否 | String | 回调接口鉴权密钥。 |
| --ManageStatus | 是 | String | 空间管理状态，取值：active、stop |
| --IsDeleted | 是 | Long | 是否已删除，取值：0（否），1（是） |
| --StoreDays | 是 | Long | 录像、截图等文件存储天数，单位天。取值：0～1825(5年：5*365天)，0表示永久保存 |
| --RtmpHost | 否 | String | 空间提供的rtmp推流地址 |
| --RtmpPort | 否 | String | 空间提供的rtmp推流端口 |
| --GbServerId | 否 | String | 空间提供的国标信令服务器ID |
| --GbServerDomain | 否 | String | 空间提供的国标信令服务器域 |
| --GbServerHost | 否 | String | 空间提供的国标信令服务器地址 |
--GbServerTcpPort | 否 | Long | 空间提供的国标信令服务器TCP端口 |
--GbServerUdpPort | 否 | Long | 空间提供的国标信令服务器UDP端口 |
--PushPrivateKey | 否 | String | 推流鉴权key |
| --CreateTime | 否 | String | 创建时间，格式如：yyyy-MM-ddTHH:mm:ssZ，UTC时间 |
| --UpdateTime | 否 | String | 最近一次更新时间，格式如：yyyy-MM-ddTHH:mm:ssZ，UTC时间 |
请求示例:
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"
}
} |
状态码 | 描述 |
|---|---|
200 | OK |
400 | Bad Request |
