文档中心

托管 Prometheus

工作区

UpdateWorkspace

更新工作区。

请求说明

托管 Prometheus 已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地域，选择最合适的接入点。

请求方式：POST

请求地址：https://vmp.cn-beijing.volcengineapi.com?Action=UpdateWorkspace&Version=2021-03-03

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

WorkspaceQuota

参数	类型	是否必选	示例值	描述
ActiveSeries	Integer	否	1000000	最大活跃时序数。整数形式，默认取值范围为 1～50000000。
QueryPerSecond	Integer	否	100	最大查询 QPS。整数形式，默认取值范围为 1～500。
ScanSeriesPerSecond	Integer	否	20000	最大每秒扫描时序数。整数形式，默认取值范围为 1～200000。
ScanSamplesPerSecond	Long	否	200000000	最大每秒扫描样本数。整数形式，默认取值范围为 1～1000000000。
IngestSamplesPerSecond	Integer	否	1000000	指标摄入速率，即最大每秒写入样本数。整数形式，默认取值范围为 1～5000000。

说明

工作区规格的默认限额由配额中心控制，如果您需要修改的值超过了系统默认限额，请首先在配额中心申请更高的限额，然后在调用接口时配置对应参数的值。提高限额的方法，请参见如何提升配额（Quota）？

请求示例

POST https://vmp.cn-beijing.volcengineapi.com?Action=UpdateWorkspace&Version=2021-03-03​
Content-Type: application/json​
{​
    "Id": "e28ae750-bbb8-4ff4-abf4***",​
    "Name": "workspace-demo",​
    "Description": "This is a workspace discription",​
    "Username": "admin",​
    "Password": "YWRtaW5AMTIzNA==",​
    "DeleteProtectionEnabled": true,​
    "Quota": {​
        "ActiveSeries": 1000000,​
        "QueryPerSecond": 100,​
        "ScanSeriesPerSecond": 20000,​
        "ScanSamplesPerSecond": 200000000,​
        "IngestSamplesPerSecond": 1000000​
    },​
    "AuthType": "BearerToken",​
    "BearerToken": "token1"​
}

返回参数

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

返回示例

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

错误码

本接口无专有错误码，公共错误码请参见公共错误码。

最近更新时间：2025.12.26 16:17:37

这个页面对您有帮助吗？

有用

无用