You need to enable JavaScript to run this app.
导航
慢直播
  • 文档首页
    • /
  • 慢直播

查看空间信息

最近更新时间：2022.08.31 17:13:11

首次发布时间：2021.11.25 17:12:51

我的收藏

查询指定空间的详细信息。

请求方式

使用 GET 方式发起请求。

请求参数

下表仅列出了接口特有的请求参数和部分公共参数。完整的公共参数列表，参考「公共参数」。

字段
位置
类型
必填
说明
值
ActionQueryString是公共参数，OpenAPI 接口名称GetSpace
VersionQueryString是公共参数，OpenAPI 接口版本2021-01-01
SpaceIDQueryString是需要查询的空间 ID可通过调用 ListSpaces 接口获取

返回结果

返回参数说明

通用返回参数，请参考 ResponseMetadata 结构体说明。

Result 字段包含以下参数：

字段
类型
说明
SpaceNameString空间名称
SpaceIDString空间 ID
DescriptionString空间描述

Region

String

服务区域：

  • cn-qingdao-a（华北）

AccessType

String

接入类型：

  • rtmp
  • gb28181
GBArray of objects当接入类型为 gb28181 时，返回数据；参考以下 GB 数据结构说明

Status

String

空间状态：

  • enabled：可用
  • disabled：已停用

HLSLowLatency

Boolean

是否已开启 HLS 低延迟：

  • true：开启
  • false：关闭
CallbackURLString回调地址
CreatedAtTimestamp空间创建时间
UpdatedAtTimestamp空间更新时间
TemplateArray of objects空间绑定的模板，参考以下 Template 数据结构说明
DomainsMap[String]空间域名，参考以下 SpaceDomain 数据结构说明
SipServerMap[String]SIP 服务器信息，参考以下 SIP Server数据结构说明

GB 数据结构说明

字段
类型
说明

PullOnDemand

Boolean

是否已开启按需拉流：

  • true：开启

  • false：关闭

按需拉流说明：用户在一段时间（约3~5分钟）内不使用视频流时，会将视频流断开，并将流状态置为stopped；再次观看时，需要启用视频流

Template 数据结构说明

字段
类型
说明
ScreenshotArray of objects截图模板，参考以下 Screenshot 数据结构说明
RecordArray of objects录制模板，参考以下 Record 数据结构说明
AIArray of objectsAI 模板，参考以下 AI 数据结构说明

Screenshot 数据结构说明

字段
类型
说明
TemplateIDString截图模板 ID
TemplateNameString模板名称
BindTimeString模板配置时间

Record 数据结构说明

字段
类型
说明
TemplateIDString录制模板 ID
TemplateNameString模板名称
BindTimeString模板配置时间

AI 数据结构说明

字段
类型
说明
TemplateIDStringAI 模板 ID
TemplateNameString模板名称
BindTimeString模板配置时间

SpaceDomain 数据结构说明

字段
类型
说明
DomainString域名
TypeString域名类型

Status

String

域名状态：

  • config：配置中
  • enabled：已启用
CNAMEStringCNAME

Default

Boolean

是否为默认域名：

  • true：是
  • false：否
HttpsArray of objects证书相关，参考以下 SpaceDomainHttps 数据结构说明
CreatedAtString创建时间
UpdatedAtString更新时间

TimeFlag

Boolean

是否开启时间鉴权：

  • true:：已开启
  • false：未开启
MainKeyString鉴权密钥（只能包含字母和数字）
SpareKeyString备选鉴权密钥，当主密钥为空时，会使用备选密钥
ValidDurationInt64有效时间，表示开启之后推拉流地址的有效时长，单位：分钟

SpaceDomainHttps 数据结构说明

字段
类型
说明

Enable

Boolean

是否配置证书：

  • true：已配置
  • false：未配置
CertificateIDString绑定的证书 ID

SIP Server 数据结构说明

字段
类型
说明
SipIdStringSIP 服务器 ID
SipDomainStringSIP 服务器域名
SipIpStringSIP 服务器 IP

SipPort

Map[Integer]

SIP 服务器端口号：

  • tcp
  • udp

示例

请求示例

GET https://open.volcengineapi.com?Action=GetSpace
&Version=2021-01-01
&SpaceID=2db38a3a-2a9d-4bf7-afd9-7cdc13xxxxxx
&<公共请求参数>

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022020719582701021119522919036C77",
        "Action": "GetSpace",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "SpaceName": "HyzGB01",
        "Description": "New space",
        "SpaceID": "517ff7ec-7700-4862-b1e7-7967a492df79",
        "Region": "cn-qingdao-a",
        "AccessType": "gb28181",
        "Status": "enabled",
        "GB": {
            "PullOnDemand": true
        },
        "HLSLowLatency": false,
        "CreatedAt": "2021-11-11T11:28:30+08:00",
        "UpdatedAt": "2021-12-04T15:52:13+08:00",
        "Domains": {
            "prcldt8wxxxxxxx.pull.xxxxxxx.com": {
                "Domain": "prcldt8wxxxxxxx.pull.xxxxxxx.com",
                "Type": "fcdn-pull",
                "Status": "enabled",
                "CNAME": "prcldtxxxxxxxxxx.pull.xxxxxxx.com.c.xxxxxxxx.com",
                "Default": true,
                "Https": {
                    "Enable": false,
                    "CertificateID": ""
                },
                "CreatedAt": "2021-11-11T11:28:28+08:00",
                "UpdatedAt": "",
                "TimeFlag": false,
                "MainKey": "",
                "SpareKey": "",
                "ValidDuration": 0
            }
        },
        "SipServer": {
            "SipId": "3402000000xxxxxxxxxx",
            "SipDomain": "xx.xx.xxxx.xx",
            "SipIp": "xx.xx.xxxx.xx",
            "SipPort": {
                "tcp": 0000,
                "udp": 0000
            }
        },
        "CallbackURL": "",
        "Template": {
            "Screenshot": {
                "TemplateID": "af991af9-fb07-4773-9ed1-c58e5b90a810",
                "TemplateName": "hyzsnap01",
                "BindTime": "2022-02-07T17:13:04+08:00"
            },
            "Record": {
                "TemplateID": "535aa5e6-3388-42e9-bd7d-a1ee6616040c",
                "TemplateName": "hyzrecord01",
                "BindTime": "2022-02-07T17:13:23+08:00"
            },
            "AI": {
                "TemplateID": "1c443146-8d6a-44d5-baf8-5efafc0e7275",
                "TemplateName": "car0121",
                "BindTime": "2022-02-07T17:19:39+08:00"
            }
        }
    }
}