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

文档中心

立即注册

导航

持续交付

UpdateWorkspace

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

更新工作区。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	UpdateWorkspace	接口名称。当前 API 的名称为 `UpdateWorkspace`。
Version	String	是	2023-05-01	接口版本。当前 API 的版本为 `2023-05-01`。
Id	String	是	18be9d623fba45a1aca409f5e19c****	工作区 ID。
Name	String	否	workspace-demo	工作区名称。支持任意字符，长度限制为2~50 个字符。同一个火山引擎账号下，名称唯一。
Description	String	否	这是一段描述	工作区描述，支持任意字符，长度限制为 0~256 个字符。
Visibility	String	否	Account	工作区成员可见方式。 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=UpdateWorkspace&Version=2023-05-01 HTTP/1.1
Content-Type: application/json
{
    "Id": "2c7a85e4ac034eb790b096705694****",
    "Name": "workspace-demo",
    "Description": "test",
    "Visibility": "Account"
}

返回参数

本接口无特有的返回参数。

返回示例

HTTP/1.1 200 OK
Content-Type: application/json
{
    "ResponseMetadata" : {
        "RequestId": "202404031138595E5D8BD124299EB9****",
        "Action": "UpdateWorkspace",
        "Version": "2023-05-01",
        "Service": "cp",
        "Region": "cn-beijing",
    },
    "Result": {}
}

错误码

当前接口暂无独立错误码，若接口调用返回异常，可参考公共错误码进行故障排查。