视频监控 > API 文档 > 空间管理相关接口 >查询空间信息

查询空间信息

最近更新时间: 2023-12-22 15:11:47

描述

本接口用于查询空间信息

接口请求域名：qvs.qiniuapi.com
请求方式：GET
接口路径：/v1/namespaces/{namespaceId}

请求参数

路径参数

参数名称	必填	字段类型	说明
namespaceId	是	string	空间ID

响应参数

参数名称	类型	说明
id	string	空间ID
name	string	空间名称
domains	string数组	静态类型（域名方式）接入时的域名信息
accessType	string	接入类型,三种接入类型中的一种(rtmp,gb28181,pull,onvif)
~~rtmpUrlType~~(废弃,请使用urlMode)	integer	推拉流地址计算方式，1:static（域名方式）, 2:dynamic（API动态获取）
urlMode	integer	推拉流地址计算方式，1:static（域名方式）, 2:dynamic（API动态获取）
callBack	string	回调地址
zone	string	zone为服务区域, 可根据流媒体实时处理、视频录制、截图的存储需求选择对应的区域, 可选项为z0, z1, z2, 默认为z0. z0表示华东, z1表示华北、z2表示华南
hlsLowLatency	boolean	HLS低延时开关
recordTemplateId	string	录制模版ID
snapshotTemplateId	string	截图模版ID
aiTemplateId	string	AI模版ID
recordTemplateApplyAll	boolean	空间模版是否应用到全局
snapshotTemplateApplyAll	boolean	截图模版是否应用到全局
aiTemplateApplyAll	boolean	AI模版是否应用到全局
disabled	boolean	空间是否被禁用
deviceCount	integer	接入设备的数量
streamCount	integer	空间中流的数量
onlineStreamCount	integer	空间中在线流数量
disabledStreamCount	integer	空间中禁用流数量
sipAddrs	sip信息数组	sip信息数组, 建议:`同一个空间设备量较大时，可从该数组中随机选取地址，而不是固定一个`
sipAddrs.sipServerId	string	accessType为gb28181时sip服务器地址，地址前10位为对应sip域
sipAddrs.sipServerIP	string	accessType为gb28181时sip服务器IP
sipAddrs.sipServerPort	string数组	accessType为gb28181时sip服务器端口
createdAt	integer	空间创建时间
updatedAt	integer	空间更新时间
retryInterval	integer	accessType为"pull",即主动拉流时，代表拉流中断重连间隔，单位为秒
retryCount	integer	accessType为"pull",即主动拉流时，代表拉流中断重连次数，单位为次
rtpAudio	boolean	是否开启音频
rtpAudioTranscode	boolean	是否开启音频转码
desc	string	空间描述信息

示例

请求示例

curl --request GET \
  --url http://qvs.qiniuapi.com/v1/namespaces/2akrars3nkw3s \
  --header 'authorization: Qiniu j853F3bLkWl59I5BOkWm6q1Z1mZClpr9Z9CLfDE0:u372aQV0359mzwTVGxn22sRgFYc='

响应示例

{
  "id": "2akrars3nkw3s",
  "name": "test001235",
  "domains": [
    "qiniu.com"
  ],
  "accessType": "rtmp",
  "urlMode": 1,
  "zone": "z0",
  "hlsLowLatency": false,
  "createdAt": 1586750356,
  "updatedAt": 1586750356,
  "recordTemplateId": "2akrarrzr7rh5",
  "recordTemplateApplyAll": false,
  "snapshotTemplateApplyAll": false,
  "disabled": false,
  "streamCount":2,
  "onlineStreamCount":1,
  "disabledStreamCount":1
}

以上内容是否对您有帮助？