You need to enable JavaScript to run this app.
导航
CreateWorkspace
最近更新时间:2024.04.19 11:53:52首次发布时间:2023.06.30 15:23:33

创建工作区。

请求说明

  • 请求方式:POST
  • 请求地址:https://open.volcengineapi.com/?Action=CreateWorkspace&Version=2021-03-03

请求参数

参数名称类型是否必选示例值描述
ActionStringCreateWorkspace公共参数,本接口值:CreateWorkspace。
VersionString2021-03-03公共参数,本接口值:2021-03-03。

Name

String

test

工作区名称,字符串形式,长度限制为 1~100。

说明

一个英文、一个中文、一个符号都定义为一个字符。

Description

String

这是一段描述

工作区描述信息,字符串形式,长度限制为 0~200。

说明

一个英文、一个中文、一个符号都定义为一个字符。

Username

String

admin

工作区 BasicAuth 用户名:

  • 支持大写字母、小写字母、数字和下划线。
  • 用户名和密码必须同时配置或同时不配置。

Password

String

YWRtaW5AMTIzNA==

工作区 BasicAuth 密码:

  • 支持大写字母、小写字母、数字和特殊字符,并且至少包含三种字符组成。
  • 特殊字符包括 !@#$%^\*&()\_+-= 。

说明

调用该接口时,原始密码必须首先进行 Base64 编码处理,然后再填写到此处。例如:如果您的原始密码为admin@1234,则此处应填写经过 Base64 编码后的值,即YWRtaW5AMTIzNA==

InstanceTypeIdStringvmp.standard.15d工作区实例规格 ID,可选值参见 工作区规格 实例规格列。

DeleteProtectionEnabled

Boolean

true

是否开启工作区删除保护,取值:

  • true:开启工作区删除保护。
  • false: 不开启工作区删除保护。

请求示例

POST /?Action=CreateWorkspace&Version=2021-03-03
Content-Type:application/json
{
    "Name": "test",
    "Description": "这是一段描述",
    "Username": "admin",
    "Password": "YWRtaW4=",
    "InstanceTypeId": "vmp.standard.15d",
    "DeleteProtectionEnabled": true
}

返回参数

参数名称类型示例值描述
IdStringe28ae750-bbb8-4ff4-abf4-1e0e0f88808c工作区 ID。

返回示例

HTTP/1.1 200 OK
Content-Type:application/json
{
    "ResponseMetadata": {
        "RequestId": "202211302208xxxx",
        "Action": "CreateWorkspace",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-beijing"
    },
    "Result": {
        "Id": " e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
    }
}

错误码

本接口错误码如下表所示,公共错误码请参见 公共错误码

HTTP 状态码错误码错误信息描述
400Insufficient.BalanceYour account has run out of balance.当前账号已欠费。
400InvalidParameter.PasswordPassword cannot be empty when username is set.配置 BasicAuth 时,仅配置了用户名,未配置密码。
400InvalidParameter.UsernameUsername cannot be empty when password is set.配置 BasicAuth 时,仅配置了密码,未设置用户名。
400QuotaExceeded.WorkspaceCountWorkspace count has exceeded the quota.创建工作区数量达到上限。
403OperationDenied.OrderOperation is denied because no permission to place order.当前账号没有创建工作区实例的权限。
404NotFound.WorkspaceInstanceTypeThe specified WorkspaceInstanceType {{InstanceTypeId}} is not found.不支持该工作区类型。