文档中心

托管 Prometheus

工作区

ListWorkspaceStatus

获取工作区状态。

请求说明

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

请求方式：POST

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

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListWorkspaceStatus	接口名称。当前 API 的名称为 ListWorkspaceStatus。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 2021-03-03。
PageNumber	Long	否	1	当前页数，最小值或默认值均为 1。
PageSize	Long	否	10	单页数量：取值范围为 0 ~ 100。默认值为 10。
Filters	Object of WorkspaceFilter	否	-	工作区查询过滤条件。
ProjectName	String	否	default	工作区项目名称。

WorkspaceFilter

参数	类型	是否必选	示例值	描述
Ids	Array of String	否	["e28ae750-bbb8-4ff4-abf4***"]	按工作区 ID 过滤，精确查询。
Name	String	否	workspace-demo	按工作区名称过滤，模糊查询。
Statuses	Array of String	否	["Active"]	按工作区状态过滤，精确查询。取值： Creating：创建中 Active：正常 Updating：更新中 Deleting：删除中 OverdueShutted：欠费关停 Resuming：恢复中 Error：错误
InstanceTypeIds	Array of String	否	["vmp.standard.15d"]	按工作区类型过滤，精确查询。取值： vmp.standard.15d：15 天存储时长工作区。 vmp.standard.30d：30 天存储时长工作区。 vmp.standard.90d：90 天存储时长工作区。 vmp.standard.180d：180 天存储时长工作区。 vmp.standard.1y：1 年存储时长工作区。

请求示例

POST https://vmp.cn-beijing.volcengineapi.com?Action=ListWorkspaceStatus&Version=2021-03-03​
Content-Type: application/json​
{​
    "PageNumber": 1,​
    "PageSize": 10,​
    "Filters": {​
        "Ids": [​
            "e28ae750-bbb8-4ff4-abf4***"​
        ],​
        "Name": "workspace-demo",​
        "Statuses": [​
            "Active"​
        ],​
        "InstanceTypeIds": [​
            "vmp.standard.15d"​
        ]​
    },​
    "ProjectName": "default"​
}

返回参数

参数	类型	示例值	描述
Total	Long	100	工作区总数。
Items	Array of WorkspaceStatus	-	工作区列表。

WorkspaceStatus

参数	类型	示例值	描述
Id	String	e28ae750-bbb8-4ff4-abf4***	工作区 ID。
Name	String	workspace-demo	工作区名称。
Usage	Object of UsageStatus	-	工作区用量。
Status	String	Active	工作区状态，取值： Creating：创建中 Active：正常 Updating：更新中 Deleting：删除中 OverdueShutted：欠费关停 Resuming：恢复中 Error：错误
InstanceTypeId	String	vmp.standard.15d	工作区规格。

UsageStatus

参数	类型	示例值	描述
ActiveSeries	Long	10000	活跃时序数。
IngestedSamplesPerSecond	Double	3000.0	每秒写入样本数。

返回示例

HTTP/1.1: 200 OK​
Content-Type: application/json​
{​
    "ResponseMetadata": {​
        "RequestId": "20230604110420****100232280022D31",​
        "Action": "ListWorkspaceStatus",​
        "Version": "2021-03-03",​
        "Service": "vmp",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "Total": 100,​
        "Items": [​
            {​
                "Id": "e28ae750-bbb8-4ff4-abf4***",​
                "Name": "workspace-demo",​
                "Usage": {​
                    "ActiveSeries": 10000,​
                    "IngestedSamplesPerSecond": 3000​
                },​
                "Status": "Active",​
                "InstanceTypeId": "vmp.standard.15d"​
            }​
        ]​
    }​
}

错误码

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

HTTP 状态码	错误码	错误信息	说明
400	InvalidParameter.{{parameter}}	The specified parameter {{parameter}} is invalid.	输入不合法，如工作区名称不合法等。
403	ProductUnsubscribed	You are not subscribed to VMP. Please go to the VMP console web page to subscribe to the service	当前账号未订阅 VMP 服务。

最近更新时间：2025.11.05 17:12:26

这个页面对您有帮助吗？

有用

无用