文档中心 > 查询空间
查询空间

最近更新时间:2022-09-08

1、功能介绍

查询业务空间

2、请求参数

参数

是否必选

参数类型

描述

ActionString系统规定参数。取值:QueryGroup

Region

String

按空间区域查询

GroupIdString按空间ID查询

Name

String

按空间名称查询

DeviceProtocol

String

按空间使用的接入协议查询。取值:rtmp、gb28181,不区分大小写。

ManageStatus
String

按空间状态查询

active 激活

stop 停用

(不区分大小写)

PageSizeLong

分页大小,默认为20

PageNumLong第几分页,默认为1

3、响应参数

参数

是否必选

参数类型

描述

RequestId

String

该条接口请求ID

CodeString

0成功

其他失败

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

--PageSize

Long

分页大小,默认为20

--PageNum

Long

第几分页,默认为1
--PageTotalLong分页总数,默认为1
--TotalCount

Long

空间数量
--GroupListarray of group objects空间列表


group定义(详细属性需调用查询空间详情接口,本接口只查询以下字段,其余字段返回空或默认值)

参数

是否必选

参数类型

描述

GroupId

String

空间ID

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

DeviceProtocol

String

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

EnableHls

Bool

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

CallbackString空间内设备状态、流状态更新时通知用户业务端的回调接口
CallbackDeviceStatusBool设备回调状态
CallbackStreamStatusBool流回调状态
CallbackRecordBool录像回调状态
CallbackSnapshotBool截图回调状态
CallbackPrivateKeyString回调接口鉴权密钥。
ManageStatusString空间管理状态,取值:active、stop
IsDeletedLong是否已删除,取值:0(否),1(是)
StoreDaysLong录像、截图等文件存储天数,单位天。取值:0~1825(5年:5*365天),0表示永久保存
CreateTimeString创建时间格式如:yyyy-MM-ddTHH:mm:ssZ,UTC时间
UpdateTimeString最近一次更新时间,格式如:yyyy-MM-ddTHH:mm:ssZ,UTC时间
DeviceNumLong空间下设备数


4、示例

请求示例:

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

Action=QueryGroup

&Name=测试

&公共请求参数


返回示例:

{
    "RequestId": "7a474b3c-80de-45e0-b2c4-8e55b3d379c7",
    "Code": "0",
    "Data": {
        "PageSize": 20,
        "PageNum": 1,
        "PageTotal": 1,
        "TotalCount": 2,
        "GroupList": [
            {
                "GroupId": "uni0341122060286924475",
                "Name": "测试国标空间",
                "Region": "cn-tianjin-test",
                "DeviceProtocol": "gb28181",
                "EnableHls": true,
                "Callback": "www.backback.com",
                "CallbackDeviceStatus": false,
                "CallbackStreamStatus": true,
                "CallbackRecord": false,
                "CallbackSnapshot": false,
                "CallbackPrivateKey": "callbackkey",
                "ManageStatus": "active",
                "IsDeleted": 0,
                "StoreDays": 0,
                "DeviceNum": 4,
                "CreateTime": "2022-06-22T07:59:51Z",
                "UpdateTime": "2022-06-22T08:08:19Z"
            },
            {
                "GroupId": "uni0341122061402596026",
                "Name": "测试rtmp空间",
                "Region": "cn-tianjin-test",
                "DeviceProtocol": "rtmp",
                "EnableHls": true,
                "Callback": "http://www.callbacktest.com",
                "CallbackDeviceStatus": false,
                "CallbackStreamStatus": true,
                "CallbackRecord": true,
                "CallbackSnapshot": true,
                "CallbackPrivateKey": "callbackkey",
                "ManageStatus": "active",
                "IsDeleted": 0,
                "StoreDays": 0,
                "DeviceNum": 0,
                "CreateTime": "2022-06-28T07:04:05Z",
                "UpdateTime": "2022-06-28T07:04:05Z"
            }
        ]
    }
}

5、状态码

状态码

描述

200

OK

400

Bad Request