CreateWorkspace--持续交付-火山引擎

文档中心

立即注册

导航

持续交付

CreateWorkspace

最近更新时间：2024.09.27 14:46:37首次发布时间：2024.07.02 21:03:12

创建工作区。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com/?Action=CreateWorkspace&Version=2023-05-01

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	CreateWorkspace	接口名称。当前 API 的名称为 `CreateWorkspace`。
Version	String	是	2023-05-01	接口版本。当前 API 的版本为 `2023-05-01`。
Name	String	是	workspace-demo	工作区名称。支持任意字符，长度限制为 2~50 个字符。同一个火山引擎账号下，名称唯一。
Description	String	否	这是一段描述	工作区描述，支持任意字符，长度限制为 0~256 个字符。
Visibility	String	是	Specified	工作区成员可见方式。 Account：所有用户可见 Specified：指定用户可见
VisibleUsers	Array of IAMUser	否	[ { "AccountId": 24506499****, "UserId": 0 } ]	可见用户列表。当工作区成员可见方式设置为 Specified 时，需进一步指定可见用户。必须包含火山引擎账号（主账号）。

IAMUser

参数	类型	是否必选	示例值	描述
AccountId	Long	否	210048****	火山引擎账号（主账号）ID。
UserId	Long	否	28****	子用户（IAM 用户）ID。

请求示例

POST https://open.volcengineapi.com/?Action=CreateWorkspace&Version=2023-05-01 HTTP/1.1
Content-Type: application/json
{
    "Name": "workspace-demo",
    "Description": "demo",
    "Visibility": "Specified",  
    "VisibleUsers": [
        {
            "AccountId": 24506499****,
            "UserId": 0
        }
    ]
}

返回参数

参数	类型	示例值	描述
Id	String	2c7a85e4ac034eb790b096705694****	工作区 ID。

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "2023060411042010023228002****",
        "Action": "CreateWorkspace",
        "Version": "2023-05-01",
        "Service": "cp",
        "Region": "cn-beijing"
    },
    "Result": {
        "Id": "2c7a85e4ac034eb790b096705694****"
    }
}

错误码

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

HTTP 状态码	错误码	错误信息	说明
403	Forbidden.{parameter}	The request is refused because it does not have access to Quota	创建工作区 Quota 不足，请购买资源包。