You need to enable JavaScript to run this app.
导航
托管 Prometheus
  • 文档首页
    • /
  • 托管 Prometheus

UpdateWorkspace

最近更新时间：2024.04.19 11:53:53

首次发布时间：2023.06.30 15:23:33

我的收藏

更新工作区。

请求说明

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

请求参数

参数名称类型是否必选示例值描述
ActionString是UpdateWorkspace公共参数，本接口值：UpdateWorkspace。
VersionString是2021-03-03公共参数，本接口值：2021-03-03。
IdString是e28ae750-bbb8-4ff4-abf4-1e0e0f88808c工作区 ID。

Name

String

否

test

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

说明

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

Description

String

否

test

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

说明

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

Username

String

否

admin

工作区 BasicAuth 用户名：

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

Password

String

否

YWRtaW4=

工作区 BasicAuth 密码：

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

说明

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

DeleteProtectionEnabled

Boolean

否

true

是否开启删除保护，取值：

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

请求示例

POST /?Action=UpdateWorkspace&Version=2021-03-03
Content-Type:application/json
{
    "Id": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c",
    "Name": "test",
    "Description": "test",
    "Username": "admin",
    "Password": "YWRtaW4=",
    "DeleteProtectionEnabled": true
}

返回参数

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

返回示例

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

错误码

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

HTTP 状态码错误码错误信息描述
400InvalidParameter.PasswordPassword cannot be empty when username is set.设置 BasicAuth 时，仅设置了用户名，未设置密码。
400InvalidParameter.UsernameUsername cannot be empty when password is set.设置 BasicAuth 时，仅设置了密码，未设置用户名。
404NotFound.WorkspaceThe specified Workspace {{id}} is not found.未找到指定的工作区。