UpdateWorkspace--托管 Prometheus-火山引擎

文档中心

立即注册

导航

UpdateWorkspace

最近更新时间：2024.09.03 15:42:17首次发布时间：2023.06.30 15:23:33

更新工作区。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	UpdateWorkspace	接口名称。当前 API 的名称为 `UpdateWorkspace`。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 `2021-03-03`。
Id	String	是	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	工作区 ID。可以调用 ListWorkspaces 接口，获取工作区 ID。
Name	String	否	workspace-demo	工作区名称，字符串形式，长度限制为 1～100。说明一个英文、一个中文、一个符号都定义为一个字符。
Description	String	否	这是一段描述	工作区描述信息，字符串形式，长度限制为 0～200。说明一个英文、一个中文、一个符号都定义为一个字符。
Username	String	否	admin	工作区 BasicAuth 用户名。支持大写字母、小写字母、数字和下划线。用户名和密码必须同时配置或同时不配置。
Password	String	否	YWRtaW5AMTIzNA==	工作区 BasicAuth 密码。支持大写字母、小写字母、数字和特殊字符，并且至少包含三种字符组成。特殊字符包括 !@#$%^*&()_+-= 。说明调用该接口时，原始密码必须首先进行 Base64 编码处理，然后再填写到此处。例如：如果您的原始密码为 `admin@1234`，则此处应填写经过 Base64 编码后的值，即 `YWRtaW5AMTIzNA==`。
DeleteProtectionEnabled	Boolean	否	true	是否开启删除保护，取值： true：开启工作区删除保护。 false：不开启工作区删除保护。

请求示例

POST https://open.volcengineapi.com/?Action=UpdateWorkspace&Version=2021-03-03
Content-Type: application/json
{
    "Id": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c",
    "Name": "workspace-demo",
    "Description": "这是一段描述",
    "Username": "admin",
    "Password": "YWRtaW5AMTIzNA==",
    "DeleteProtectionEnabled": true
}

返回参数

参数	类型	示例值	描述
Id	String	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	工作区 ID。

返回示例

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

错误码

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

HTTP 状态码	错误码	错误信息	说明
400	InvalidParameter.Username	Username cannot be empty when password is set.	设置 BasicAuth 时仅设置了密码未设置用户名。
400	InvalidParameter.Password	Password cannot be empty when username is set.	设置 BasicAuth 时仅设置了用户名未设置密码。
400	InvalidParameter.{{parameter}}	The specified parameter {{parameter}} is invalid.	指定的参数无效。
400	MissingParameter.{{parameter}}	The required parameter {{parameter}} is missing.	缺少必要的参数。
403	ProductUnsubscribed	You are not subscribed to the Volcengine Managed Service for Prometheus (VMP). Please go to the VMP console web page to subscribe to the service	当前账号未订阅 VMP 服务。
404	NotFound.Workspace	The specified Workspace {{id}} is not found.	未找到相应 ID 的工作区。