文档首页/ AI开发平台ModelArts/ API参考/ 工作空间管理/ 创建工作空间
更新时间：2025-07-28 GMT+08:00
查看PDF
分享

创建工作空间

功能介绍

创建工作空间（"default"为系统预留的默认工作空间名称，不能使用）。该接口适用于以下场景：当需要为不同的业务目标、团队或项目创建独立的工作空间时，用户可通过此接口创建新的工作空间。使用该接口的前提条件是用户具备创建工作空间的权限，并且工作空间名称未被占用且不为"default"。创建成功后，系统将为该工作空间分配默认的访问控制策略，用户可在该工作空间中进行模型开发、管理和部署等操作。若工作空间名称已存在、名称为"default"或用户无权限操作，接口将返回相应的错误信息。

调试

您可以在API Explorer中调试该接口，支持自动认证鉴权。API Explorer可以自动生成SDK代码示例，并提供SDK代码示例调试功能。

URI

POST /v1/{project_id}/workspaces

表1 路径参数

参数

是否必选

参数类型

描述

project_id

是

String

参数解释：用户项目ID。获取方法请参见获取项目ID和名称。

约束限制：1 - 64字符，字母、数字和中划线。

取值范围：不涉及。

默认取值：不涉及。

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Auth-Token

是

String

参数解释：

调用接口的认证方式分为Token和AK/SK两种，如果您使用的Token方式，此参数为必填，请填写Token的值，获取方式请参见获取token。

约束限制：

不涉及。

取值范围：

不涉及。

默认取值：

不涉及。
表3 请求Body参数

参数

是否必选

参数类型

描述

grants

否

Array of grants objects

参数解释：

授权用户列表。

约束限制：

当且仅当"auth_type"的值为"INTERNAL"时才会生效，长度不超过500。

auth_type

否

String

参数解释：

授权类型。

约束限制：

不涉及。

取值范围：

  • PUBLIC：租户内部公开访问。

  • PRIVATE：仅创建者和主账号可访问。

  • INTERNAL：创建者、主账号、指定IAM子账号可访问，需要与grants参数配合使用。

默认取值：

PUBLIC。

enterprise_project_id

否

String

参数解释：

企业项目id，指定此参数会只返回该企业项目id下的工作空间。默认显示所有工作空间。

约束限制：

不涉及。

取值范围：

启用状态的企业项目ID。长度为36位，支持英文字母大小写，数字和中划线（-）。

默认取值：

不涉及。

name

是

String

参数解释：

工作空间名称。

约束限制：

用户无法自己创建名为'default'的工作空间，'default'为系统预留的默认工作空间名称。

取值范围：

长度限制为4-64字符，支持中文、大小写字母、数字、中划线和下划线。

默认取值：

不涉及。

description

否

String

参数解释：

工作空间描述。

约束限制：

不涉及。

取值范围：

长度限制为0-256字符，不得包含<、>、=、&、"、'、/特殊字符

默认取值：

空。
表4 grants

参数

是否必选

参数类型

描述

user_id

否

String

参数解释：

IAM用户ID。获取方法请参见获取用户ID和名称。

约束限制：

此参数与user_name必填一个。两者都填优先使用user_id。

取值范围：

不涉及。

默认取值：

不涉及。

user_name

否

String

参数解释：

IAM用户名称。

约束限制：

此参数与user_name必填一个。两者都填优先使用user_id。

取值范围：

不涉及。

默认取值：

不涉及。

响应参数

状态码：200

表5 响应Body参数

参数

参数类型

描述

owner

String

参数解释：

创建者名称。

取值范围：

不涉及。

auth_type

String

参数解释：

授权类型。

取值范围：

  • PUBLIC：租户内部公开访问。

  • PRIVATE：仅创建者和主账号可访问。

  • INTERNAL：创建者、主账号、指定IAM子账号可访问，需要与grants参数配合使用。

enterprise_project_id

String

参数解释：

企业项目ID。

取值范围：

启用状态的企业项目ID。长度为36位，支持英文字母大小写，数字和中划线（-）。

update_time

Integer

参数解释：

最后修改时间，UTC。

取值范围：

不涉及。

create_time

Integer

参数解释：

创建时间，UTC。

取值范围：

不涉及。

enterprise_project_name

String

参数解释：

企业项目名称。

取值范围：

响应参数enterprise_project_id对应的企业项目名称。

name

String

参数解释：

工作空间名称。

取值范围：

长度限制为4-64字符，支持中文、大小写字母、数字、中划线和下划线。

description

String

参数解释：

工作空间描述。

取值范围：

长度限制为0-256字符，不得包含<、>、=、&、"、'、/特殊字符。

id

String

参数解释：

工作空间ID。获取方法请参见查询工作空间列表。未创建工作空间时默认值为“0”，存在创建并使用的工作空间，以实际取值为准。

取值范围：

系统生成的32位UUID，不带橫线。

status

String

参数解释：

工作空间状态。

取值范围：

  • CREATE_FAILED：创建失败。

  • NORMAL：状态正常。

  • DELETING：正在删除。

  • DELETE_FAILED：删除失败。

status_info

String

参数解释：

状态描述，默认为空。该字段会补充显示状态的详细信息。如删除失败时，可通过该字段查看删除失败的原因。

取值范围：

不涉及。

grants

Array of grants objects

参数解释：

授权用户列表。默认为空。需要与“auth_type”参数配合使用，且仅当授权类型为“INTERNAL”时才会生效。
表6 grants

参数

参数类型

描述

user_id

String

参数解释：

IAM用户ID。获取方法请参见获取用户ID和名称。

取值范围：

不涉及。

user_name

String

参数解释：

IAM用户名称。

取值范围：

不涉及。

请求示例

创建工作空间。设置工作空间名称为“test-workspace”，授权类型为“internal”，授权的IAM用户名称为“test”。

POST https://{endpoint}/v1/{project_id}/workspaces

{
  "name" : "test-workspace",
  "description" : "It is a test project",
  "enterprise_project_id" : "***b0091-887f-4839-9929-cbc884f1e***",
  "auth_type" : "internal",
  "grants" : [ {
    "user_name" : "test"
  } ]
}

响应示例

状态码：200

创建工作空间成功的响应参数。

{
  "id" : "**d05d1a553b4e188ea878e7dcb85e**",
  "name" : "test-workspace",
  "description" : "It is a test project'",
  "owner" : "testUser",
  "create_time" : 1470000020000,
  "update_time" : 1470000030000,
  "enterprise_project_id" : "***b0091-887f-4839-9929-cbc884f1e***",
  "enterprise_project_name" : "test-eps",
  "auth_type" : "internal",
  "status" : "NORMAL",
  "status_info" : ""
}

状态码

状态码

描述

200

创建工作空间成功的响应参数。

错误码

请参见错误码。

父主题： 工作空间管理

相关文档