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

更新空间信息

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

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

我的收藏

更新指定空间的配置信息。

请求方式

使用 POST 方式发起请求。

请求参数

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

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

Body 参数

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

Region

String

否

服务区域，可选枚举值：

  • cn-qingdao-a（华北）
GBArray of objects否（接入类型为 gb28181 时必填）该空间使用 GB 协议接入设备，参考以下 GB 数据结构说明
HLSLowLatencyBoolean否是否开启 HLS 低延迟，默认为 false
CallbackURLString否回调地址

GB 数据结构说明

字段
类型
必填
说明

PullOnDemand

Boolean

是

是否开启按需拉流：

  • true：开启
  • false：关闭

返回结果

返回参数说明

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

Result 字段包含以下参数：

字段
类型
说明
IDString更新成功的空间 ID

示例

请求示例

POST https://open.volcengineapi.com?Action=UpdateSpace
&Version=2021-01-01
&SpaceID=2db38a3a-2a9d-4bf7-afd9-7cdc13xxxxxx
&<公共请求参数>
{
    "SpaceName": "TestSpace",
    "Description": "Space for testing",
    "HLSLowLatency": false
}

返回示例

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