GetWorkspace--托管 Prometheus-火山引擎

文档中心

立即注册

导航

GetWorkspace

最近更新时间：2025.05.23 14:52:51首次发布时间：2025.05.23 14:52:51

查询工作区详情。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	GetWorkspace	接口名称。当前 API 的名称为 `GetWorkspace`。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 `2021-03-03`。
Id	String	是	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	工作区 ID。可以调用 ListWorkspaces 接口，获取工作区 ID。

请求示例

POST https://open.volcengineapi.com/?Action=GetWorkspace&Version=2021-03-03
Content-Type: application/json
{
    "Id": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
}

返回参数

参数	类型	示例值	描述
Id	String	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	工作区 ID。
CreateTime	String	2022-01-01T00:00:00Z	工作区创建时间。
Name	String	workspace-demo	工作区名称。
Description	String	This is a workspace discription	工作区描述信息。
Status	String	Active	工作区状态，取值： Creating：创建中 Active：正常 Updating：更新中 Deleting：删除中 OverdueShutted：欠费关停 Resuming：恢复中 Error：错误
InstanceTypeId	String	vmp.standard.15d	工作区类型，取值： vmp.standard.15d：15 天存储时长工作区。 vmp.standard.30d：30 天存储时长工作区。 vmp.standard.90d：90 天存储时长工作区。 vmp.standard.180d：180 天存储时长工作区。 vmp.standard.1y：1 年存储时长工作区。
OverdueReclaimTime	String	2022-01-01T00:00:00Z	工作区预期欠费回收时间，RFC3339 格式。说明当账户欠费时，该字段才会有具体的值。
Username	String	admin	工作区 BasicAuth 用户名。
PrometheusWriteIntranetEndpoint	String	http://query.prometheus-cn-beijing.ivolces.com/workspaces/1d0***	工作区 RemoteWrite URL 地址。
PrometheusQueryIntranetEndpoint	String	http://write.prometheus-cn-beijing.ivolces.com/workspaces/1d0***	工作区 Query URL 地址。
DeleteProtectionEnabled	Boolean	true	是否开启工作区删除保护，取值： true：开启。 false：关闭。
Tags	Array of Tag	-	工作区标签。
ProjectName	String	default	项目名称。
PrometheusPushIntranetEndpoint	String	http://push.prometheus-cn-beijing.ivolces.com/workspaces/***/api/v1/push	工作区 Pushgateway URL 地址。
InstanceType	Object of WorkspaceInstanceType	-	工作区规格详情。
Quota	Object of WorkspaceQuota	-	工作区配额详情。

Tag

参数	类型	示例值	描述
Key	String	doc	标签的 Key。
Values	Array of String	demo	标签的 Value。

WorkspaceInstanceType

参数	类型	示例值	描述
Id	String	vmp.standard.15d	工作区类型。
ActiveSeries	Integer	10000000	最大活跃时序数。
QueryPerSecond	Integer	100	最大查询 QPS。
ReplicasPerZone	Integer	2	每个可用区（az）的数据副本数。
RetentionPeriod	String	360h	最长数据保留时间。
QueryConcurrency	Integer	10	最大查询并发数。
DownsamplingPeriods	Array of String	["90d:5m"]	降采样策略。
ScanSeriesPerSecond	Integer	20000	最大每秒扫描时序数。
ScanSamplesPerSecond	Long	200000000	最大每秒扫描样本数。
IngestSamplesPerSecond	Integer	1000000	最大每秒写入样本数。
AvailabilityZoneReplicas	Integer	2	可用区（az）数。

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。

返回示例

HTTP/1.1: 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "GetWorkspace",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-north-1"
    },
    "Result": {
        "Id": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c",
        "CreateTime": "2022-01-01T00:00:00Z",
        "Name": "workspace-demo",
        "Description": "This is a workspace discription",
        "Status": "Active",
        "InstanceTypeId": "vmp.standard.15d",
        "OverdueReclaimTime": "2022-01-01T00:00:00Z",
        "Username": "admin",
        "PrometheusWriteIntranetEndpoint": "http://query.prometheus-cn-beijing.ivolces.com/workspaces/1d0***",
        "PrometheusQueryIntranetEndpoint": "http://write.prometheus-cn-beijing.ivolces.com/workspaces/1d0***",
        "PrometheusPushIntranetEndpoint": "http://push.prometheus-cn-beijing.ivolces.com/workspaces/***/api/v1/push",
        "DeleteProtectionEnabled": true,
        "Tags": [
            {
                "Key": "",
                "Values": [
                    ""
                ]
            }
        ],
        "ProjectName": "default",
        "InstanceType": {
            "Id": "vmp.standard.15d",
            "Dedicated": false,
            "ActiveSeries": 10000000,
            "QueryPerSecond": 100,
            "ReplicasPerZone": 2,
            "RetentionPeriod": "360h",
            "QueryConcurrency": 10,
            "DownsamplingPeriods": [
                "90d:5m"
            ],
            "ScanSeriesPerSecond": 20000,
            "ScanSamplesPerSecond": 200000000,
            "IngestSamplesPerSecond": 1000000,
            "ModifiableInstanceTypes": [
                ""
            ],
            "AvailabilityZoneReplicas": 2
        },
        "Quota": {
            "ActiveSeries": 1000000,
            "QueryPerSecond": 100,
            "ScanSeriesPerSecond": 20000,
            "ScanSamplesPerSecond": 200000000,
            "IngestSamplesPerSecond": 1000000
        }
    }
}

错误码

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

HTTP 状态码	错误码	错误信息	说明
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 服务。
400	InvalidParameter.{{parameter}}	The specified parameter {{parameter}} is invalid.	输入不合法，如工作区名称不合法等。