You need to enable JavaScript to run this app.
导航
视频点播
  • 文档首页
    • /
  • 视频点播

创建空间

最近更新时间：2024.04.08 15:13:24

首次发布时间：2022.06.21 14:21:36

我的收藏

此接口用于创建空间。

说明

默认情况下，单个账号支持创建最多 20 个空间。

请求说明

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

调试

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

请求参数

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

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

SpaceName

String

是

ch-test

空间名称。长度要求为 3 到 40 个字符。支持以下字符类型：

  • 小写字母
  • 数字
  • 中划线（-）

说明

  • 开头和结尾必须为小写字母或数字。
  • 空间创建成功后，空间名称和区域不支持变更。建议您使用能够标识业务的空间名。
ProjectNameString是default项目名称。项目是在火山引擎访问控制中资源分组的概念，您需要将空间加入某一个项目中。您可以在火山引擎控制台项目管理页面中获取项目名称。
DescriptionString否test空间描述。长度要求为 0 到 140 个字符。
RegionString是cn-north-1空间区域。目前仅支持设为 cn-north-1，表示华北区域。
UserNameString是test空间创建者的用户名称。

返回参数

本接口无特有的返回参数。具体请见公共返回参数。

请求示例

https://vod.volcengineapi.com?Action=CreateSpace&Version=2021-01-01&SpaceName=ch-test&ProjectName=default&Description=test&Region=cn-north-1&UserName=test

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20230103202323A1444CB2F66083DB****",
    "Action": "CreateSpace",
    "Version": "2021-01-01",
    "Service": "vod",
    "Region": "cn-north-1"
  }
}

错误码

下表列举了本接口特有的错误码。如需了解更多错误码，更多信息请见公共错误码。

状态码错误码错误信息说明

400

InvalidParameter.InvalidSpaceName

-

无效的空间名称。报错的原因如下所示。

  • 填写的长度有误。空间名称必须填写在 3～40 字符长度。
  • 填写的格式有误。格式必须满足小写字母、数字、中划线（-）组合，开头和结尾需为小写字母或数字。
400InvalidParameter.InvalidProjectName-无效的项目名称。
400InvalidParameter.InvalidDescription-无效的描述。
400InvalidParameter.InvalidRegion-无效的区域。
403RequestForbidden.AccessIsRestricted-账号访问受到限制。

服务端 SDK

点播 OpenAPI 提供了配套的服务端 SDK，支持多种编程语言，帮助您实现快速开发。建议使用服务端 SDK 来调用 API。此 API 各语言调用的示例代码，请参考如下：