CreateWorkspace--托管 Prometheus-火山引擎

文档中心

立即注册

导航

CreateWorkspace

最近更新时间：2024.09.05 15:59:54首次发布时间：2023.06.30 15:23:33

创建工作区。

请求说明

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

请求参数

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

请求示例

POST https://open.volcengineapi.com/?Action=CreateWorkspace&Version=2021-03-03
Content-Type: application/json
{
    "Name": "workspace-demo",
    "Description": "这是一段描述",
    "Username": "admin",
    "Password": "YWRtaW5AMTIzNA==",
    "InstanceTypeId": "vmp.standard.15d",
    "DeleteProtectionEnabled": true,
    "ProjectName": "default"
}

返回参数

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

返回示例

HTTP/1.1: 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "CreateWorkspace",
        "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	Insufficient.Balance	Your account has run out of balance.	当前账号已欠费。
400	InvalidParameter.{{parameter}}	The specified parameter {{parameter}} is invalid.	指定的参数无效。
400	MissingParameter.{{parameter}}	The required parameter {{parameter}} is missing.	缺少必要的参数。
400	QuotaExceeded.WorkspaceCount	Workspace count has exceeded the quota.	创建工作区数量达到上限。
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 服务。
403	OperationDenied.Order	Operation is denied because no permission to place order.	当前账号没有购买当前工作区实例的权限。
404	NotFound.WorkspaceInstanceType	The specified WorkspaceInstanceType {{InstanceTypeId}} is not found.	不支持该工作区类型 ID。