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

创建空间

最近更新时间：2024.04.18 16:02:35

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

我的收藏

创建空间。

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com?Action=CreateSpace&Version=2021-01-01

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

Query

参数类型是否必选示例值描述
ActionString是CreateSpace接口名称。当前 API 的名称为 CreateSpace。
VersionString是2021-01-01接口版本。当前 API 的版本为 2021-01-01。

Body

参数类型是否必选示例值描述
SpaceNameString是空间名称
DescriptionString否空间描述

Region

String

是

服务区域，可选枚举值：

  • cn-qingdao-a（华北）

AccessType

String

是

接入类型，可选枚举值：

  • rtmp
  • gb28181
  • rtmp-forward
GBObject of GB否该空间使用 GB 协议接入设备，参考以下 GB 数据结构说明
HLSLowLatencyBoolean否是否开启 HLS 低延迟，默认为 false
CallbackURLString否回调地址

GB

参数类型是否必选示例值描述

PullOnDemand

Boolean

是

true

是否开启按需拉流：

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

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数类型示例值描述
IDString创建成功的空间 ID

请求示例

POST https://open.volcengineapi.com?Action=CreateSpace&Version=2021-01-01
{
    "SpaceName": "MySpace",
    "Description": "Sample Space",
    "Region": "cn-qingdao-a",
    "AccessType": "gb28181",
    "GB": {
        "PullOnDemand": true
    },
    "HLSLowLatency": true,
    "CallbackURL": "url"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "202112081002370102121980161E010387",
        "Action": "CreateSpace",
        "Version": "2021-01-01",
        "Service": "aiotvideo",
        "Region": "cn-north-1"
    },
    "Result": {
        "ID": "2db38a3a-2a9d-4bf7-afd9-7cdc13xxxxxx"
    }
}

错误码

您可访问公共错误码，获取更多错误码信息。