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

CreateWorkspace - 创建工作空间

最近更新时间2024.04.23 14:17:35

首次发布时间2023.02.10 20:00:02

创建工作空间

请求参数

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

参数
类型
是否必填
示例值
描述
Action
String

CreateWorkspace

要执行的操作,取值:CreateWorkspace。

Version
String

2021-03-04

API的版本,取值:2021-03-04。

S3Bucket
String

bioos-wcfxxxxxxxxxxx

对象存储桶名称,为空表示自动创建

CoverPath
String

template-cover/pic1.png

封面位于存储桶的路径,为空表示使用官方第一张图片

Labels
Array of String

["DNA"]

工作空间标签

Description
String

description

工作空间描述

Name
String

name

工作空间名称

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构

参数
类型
示例值
描述
ID
String

wcxxxxxxxxxxxxxxxxxxx

工作空间id

请求示例

POST /?Action=CreateWorkspace&Version=2021-03-04
Content-Type:application/json
{
    "Name": "name",
    "Description": "description",
    "Labels": ["DNA"]
}

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208xxxx",
        "Action": "CreateWorkspace",
        "Version": "2021-03-04",
        "Service": "bio",
        "Region": "cn-beijing"
    },
    "Result": {
        "ID": "wcxxxxxxxxxxxxxxxxxxx"
    }
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码
错误码
错误信息
说明
400
ParamErr
<透传错误内容>

参数错误

403
ForbiddenErr
<透传错误内容>

无权限

404
NotFoundErr
<资源类型>[<具体资源id>] not found

资源不存在

405
CanNotExecErr
<透传错误内容>

操作无法执行

409
AlreadyExistErr
<资源类型>[<具体资源名称>] already exist

资源已存在

500
InternalErr
<透传错误内容>

内部错误