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

文档中心

立即注册

导航

CreateSpace - 创建空间

最近更新时间：2025.06.06 17:05:38首次发布时间：2021.11.25 17:12:51

创建空间。

请求说明

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

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	CreateSpace	要执行的操作，取值：CreateSpace。
Version	String	是	2021-01-01	API的版本，取值：2021-01-01。
Tags.N.Key	Array of String	否	1	标签key数组
Tags.N.Value	Array of String	否	1	标签value数组
SpaceName	String	是	spacename	空间名称
Description	String	否	descrption	空间描述
Region	String	是	cn-north-1	服务区域，可选枚举值： cn-qingdao-a（华北）
AccessType	String	是	rtmp	接入类型，可选枚举值： rtmp gb28181 rtmp-forward
GB	Object	否		该空间使用 GB 协议接入设备，参考以下 GB 数据结构说明
HLSLowLatency	Boolean	否	false	是否开启 HLS 低延迟，默认为 false
CallbackURL	String	否	http://callback_host/callback	回调地址

返回参数

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

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

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息
400	MissingParameter	The required parameter %s is missing.
400	InvalidParameter	The specified parameter %s is invalid.
400	OperationDenied	Operation is denied because the specified resource is in use.