更新时间:2025-12-23 GMT+08:00
分享

创建空间 - CreateProject

功能介绍

创建空间。

授权信息

账号具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备调用API所需的权限,具体权限要求请参见权限和授权项。

URI

POST /v1/{project_id}/eihealth-projects

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释:

项目ID,您可以从获取项目ID中获取。

约束限制:

不涉及

取值范围:

仅支持字母、数字、中划线和下划线,长度为[1-128]个字符。

默认取值:

不涉及

最小长度:1

最大长度:128

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释:

用户Token。

Token认证就是在调用API的时候将Token加到请求消息头,从而通过身份认证,获得操作API的权限,获取Token接口响应消息头中X-Subject-Token的值即为Token。

约束限制:

不涉及

取值范围:

长度为[1-32768]个字符。

默认取值:

不涉及

最小长度:1

最大长度:32768

表3 请求Body参数

参数

是否必选

参数类型

描述

description

否

String

参数解释:

空间描述。

约束限制:

不涉及

取值范围:

长度范围为0到1024个字符。

默认取值:

不涉及

最小长度:0

最大长度:1024

name

是

String

参数解释:

空间名称。

约束限制:

不涉及

取值范围:

项目名称必须以小写字母或数字开头和结尾,且只能包含小写字母、数字、下划线(_)和中划线(-)。长度范围为3到45个字符。

默认取值:

不涉及

最小长度:3

最大长度:45

tags

否

Array of strings

参数解释:

标签。

约束限制:

不涉及

取值范围:

支持中文、字母、数字、下划线(_)和中划线(-),长度范围为1到32个字符,最多支持5个标签。

默认取值:

不涉及

最小长度:1

最大长度:32

数组长度:0 - 5

is_core

否

Boolean

参数解释:

是否核心空间。

约束限制:

不涉及

取值范围:

  • true:是核心空间。

  • false:不是核心空间。

默认取值:

true

缺省值:true

is_new_bucket

否

Boolean

参数解释:

是否新建桶。

约束限制:

不涉及

取值范围:

  • true:新建桶。

  • false:使用已有桶。

默认取值:

不涉及

bucket_name

否

String

参数解释:

桶名。

约束限制:

  • 禁止两个英文句号(.)相邻,禁止英文句号(.)和中划线(-)相邻,禁止以英文句号(.)和中划线(-)开头或结尾。

  • 禁止使用IP地址。

取值范围:

长度范围为3到63个字符,支持小写字母、数字、中划线(-)、英文句号(.)。

默认取值:

不涉及

最小长度:3

最大长度:63

storage_tenant

否

String

参数解释:

空间桶来源租户,TERMINATE表示最终租户桶。

约束限制:

不涉及

取值范围:

  • TERMINATE: 最终租户桶。

  • RESOURCE: 资源租户桶。

默认取值:

TERMINATE

响应参数

状态码:201

表4 响应Body参数

参数

参数类型

描述

id

String

参数解释:

空间ID,您可以从获取空间ID中获取。

约束限制:

不涉及

取值范围:

不涉及

默认取值:

不涉及

请求示例

创建空间,设置描述、名称、标签。

https://{endpoint}/v1/{project_id}/eihealth-projects

{
  "description" : "this is a demo project",
  "name" : "demo-project",
  "tags" : [ "labelA", "labelB", "labelC" ],
  "is_core" : false,
  "is_new_bucket" : false,
  "bucket_name" : "obsfs-name"
}

响应示例

状态码:201

CREATED

{
  "id" : "fce1376b-72f9-4d15-9f95-9b533cb96fda"
}

状态码

状态码

描述

201

CREATED

错误码

请参见错误码。

相关文档