ListWorkspaces--托管 Prometheus-火山引擎

文档中心

立即注册

导航

ListWorkspaces

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

获取工作区列表。

请求说明

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

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListWorkspaces	接口名称。当前 API 的名称为 `ListWorkspaces`。
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-1e0e0f88808c"]	按工作区 ID 过滤，精确查询。
Name	String	否	workspace-demo	按工作区名称过滤，模糊查询。
InstanceTypeIds	Array of String	否	["vmp.standard.15d"]	按工作区规格过滤，精准查询。可选值请参见工作区规格。

请求示例

POST https://open.volcengineapi.com/?Action=DeleteWorkspace&Version=2021-03-03
Content-Type: application/json
{
    "PageNumber": 1,
    "PageSize": 10,
    "Filters": {
        "Ids": [
            "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c"
        ],
        "Name": "test",
        "InstanceTypeIds": [
            "vmp.standard.15d"
        ]
    },
    "ProjectName": "default"
}

返回参数

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

Workspace

参数	类型	示例值	描述
Id	String	e28ae750-bbb8-4ff4-abf4-1e0e0f88808c	工作区 ID。
CreateTime	String	2022-01-01T00:00:00Z	工作区创建时间，RFC3339 格式。
Name	String	workspace-demo	工作区名称。
Description	String	这是一段描述	工作区描述。
Status	String	Active	工作区状态，取值： Creating：创建中 Active：正常 Updating：更新中 Deleting：删除中 OverdueShutted：欠费关停 Resuming：恢复中 Error：错误
InstanceTypeId	String	vmp.standard.15d	工作区规格。
OverdueReclaimTime	String	2022-01-01T00:00:00Z	工作区预期欠费回收时间，RFC3339 格式。说明当账户欠费时，该字段才会有具体的值。
Username	String	admin	工作区 BasicAuth 用户名。
PrometheusQueryIntranetEndpoint	String	http://query.prometheus-cn-beijing.ivolces.com/workspaces/1d0***	工作区 Query URL 地址。
PrometheusWriteIntranetEndpoint	String	http://write.prometheus-cn-beijing.ivolces.com/workspaces/1d0***/api/v1/write	工作区 RemoteWrite URL 地址。
DeleteProtectionEnabled	Boolean	true	是否开启工作区删除保护，取值： true：开启工作区删除保护。 false：不开启工作区删除保护。
ProjectName	String	default	项目名称。

返回示例

HTTP/1.1: 200 OK
Content-Type: application/json
{
    "ResponseMetadata": {
        "RequestId": "20230604110420****100232280022D31",
        "Action": "ListWorkspaces",
        "Version": "2021-03-03",
        "Service": "vmp",
        "Region": "cn-north-1"
    },
    "Result": {
        "Total": 100,
        "Items": [
            {
                "Id": "e28ae750-bbb8-4ff4-abf4-1e0e0f88808c",
                "Name": "workspace-demo",
                "Status": "Active",
                "Username": "admin",
                "CreateTime": "2022-01-01T00:00:00Z",
                "Description": "这是一段描述",
                "ProjectName": "default",
                "InstanceTypeId": "vmp.standard.15d",
                "OverdueReclaimTime": "2022-01-01T00:00:00Z",
                "DeleteProtectionEnabled": true,
                "PrometheusQueryIntranetEndpoint": "http://query.prometheus-cn-beijing.ivolces.com/workspaces/1d0***",
                "PrometheusWriteIntranetEndpoint": "http://write.prometheus-cn-beijing.ivolces.com/workspaces/1d0***/api/v1/write"
            }
        ]
    }
}

错误码

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

HTTP 状态码	错误码	错误信息	说明
400	InvalidParameter.{{parameter}}	The specified parameter {{parameter}} is invalid.	指定的参数无效。
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 服务。