创建空间--慢直播-火山引擎

文档中心

立即注册

导航

创建空间

最近更新时间：2024.04.18 16:02:35首次发布时间：2021.11.25 17:12:51

创建空间。

请求说明

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

请求参数

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

Query

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

Body

参数	类型	是否必选	描述
SpaceName	String	是	空间名称
Description	String	否	空间描述
Region	String	是	服务区域，可选枚举值： cn-qingdao-a（华北）
AccessType	String	是	接入类型，可选枚举值： rtmp gb28181 rtmp-forward
GB	Object of GB	否	该空间使用 GB 协议接入设备，参考以下 GB 数据结构说明
HLSLowLatency	Boolean	否	是否开启 HLS 低延迟，默认为 false
CallbackURL	String	否	回调地址

GB

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

参数	类型	是否必选	示例值	描述
PullOnDemand	Boolean	是	`true`	是否开启按需拉流： true：开启 false：关闭按需拉流说明：用户在一段时间（约3~5分钟）内不使用视频流时，会将视频流断开，并将流状态置为stopped；再次观看时，需要启用视频流

PullOnDemand

Boolean

是

true

是否开启按需拉流：

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

返回参数

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

参数	类型	示例值	描述
ID	String		创建成功的空间 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"
    }
}

错误码

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