You need to enable JavaScript to run this app.
导航

创建空间

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

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

创建空间。

请求方式

使用 POST 方式发起请求。

请求参数

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

字段
位置
类型
必填
说明
ActionQueryString公共参数,OpenAPI 接口名称CreateSpace
VersionQueryString公共参数,OpenAPI 接口版本2021-01-01

Body 参数

字段
类型
必填
说明
SpaceNameString空间名称
DescriptionString空间描述

Region

String

服务区域,可选枚举值:

  • cn-qingdao-a(华北)

AccessType

String

接入类型,可选枚举值:

  • rtmp
  • gb28181
GBArray of objects否(接入类型为 gb28181 时必填)该空间使用 GB 协议接入设备,参考以下 GB 数据结构说明
HLSLowLatencyBoolean是否开启 HLS 低延迟,默认为 false
CallbackURLString回调地址

GB 数据结构说明

字段
类型
必填
说明

PullOnDemand

Boolean

是否开启按需拉流:

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

返回结果

返回参数说明

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

Result 字段包含以下参数:

字段
类型
说明
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"
    }
}