获取工作区列表。 ## 请求说明托管 Prometheus 已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 [服务地址](https://www.volcengine.com/docs/6731/1581726) 文档，根据业务所在地域，选择最合适的接入点。 * 请求方式：POST * 请求地址：https://vmp.cn\-beijing.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](#workspacefilter) |否 |\- |工作区过滤条件。 | |TagFilters |Array of [TagFilter](#tagfilter) |否 |\- |使用标签过滤工作区。 | |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 年存储时长工作区。 | ### TagFilter |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Key |String |是 |doc |标签的 Key。 | |Values |Array of String |否 |demo |标签的 Vlaue。 | ## 请求示例 ```JSON POST https://vmp.cn-beijing.volcengineapi.com?Action=ListWorkspaces&Version=2021-03-03 Content-Type: application/json { "PageNumber": 1, "PageSize": 10, "Filters": { "Ids": [ "e28ae750-bbb8-4ff4-abf4***" ], "Name": "workspace-demo", "Statuses": [ "Active" ], "CrossRegion": false, "CrossAccount": false, "InstanceTypeIds": [ "vmp.standard.15d" ] }, "TagFilters": [ { "Key": "doc", "Values": [ "" ] } ], "ProjectName": "default" } ``` ## 返回参数 |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Total |Long |100 |工作区总数。 | |Items |Array of [Workspace](#workspace) |\- |工作区总数。 | ### Workspace |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Id |String |e28ae750\-bbb8\-4ff4\-abf4\*\*\* |工作区 ID。 | |CreateTime |String |2022\-01\-01T00:00:00Z |工作区创建时间，RFC3339 格式。 | |Name |String |workspace\-demo |工作区名称。 | |Tags |Array of [Tag](#tag) |\- |工作区标签。 | |Description |String |This is a workspace discription |工作区描述。 | |Status |String |Active |工作区状态，取值：|\ | | | ||\ | | | |* **Creating**：创建中|\ | | | |* **Active**：正常|\ | | | |* **Updating**：更新中|\ | | | |* **Deleting**：删除中|\ | | | |* **OverdueShutted**：欠费关停|\ | | | |* **Resuming**：恢复中|\ | | | |* **Error**：错误 | |InstanceTypeId |String |vmp.standard.15d |工作区规格。 | |OverdueReclaimTime |String |2022\-01\-01T00:00:00Z |工作区预期欠费回收时间，RFC3339 格式。|\ | | | |:::tip|\ | | | |当账户欠费时，该字段才会有具体的值。|\ | | | ||\ | | | |:::| |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\*\*\* |工作区 RemoteWrite URL 地址。 | |PrometheusPushIntranetEndpoint |String |http://push.prometheus\-cn\-beijing.ivolces.com/workspaces/\*\*\*/api/v1/push |工作区 Push Gateway URL 地址。 | |DeleteProtectionEnabled |Boolean |true |是否开启工作区删除保护，取值：|\ | | | ||\ | | | |* **true**：开启。|\ | | | |* **false**：关闭。 | |ProjectName |String |default |项目名称。 | ### Tag |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Key |String |doc |标签的 Key。 | |Value |String |demo |标签的 Value。 | ## 返回示例 ```JSON HTTP/1.1: 200 OK Content-Type: application/json { "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "ListWorkspaces", "Version": "2021-03-03", "Service": "vmp", "Region": "cn-beijing" }, "Result": { "Total": 100, "Items": [ { "Id": "e28ae750-bbb8-4ff4-abf4***", "Name": "workspace-demo", "Tags": [ { "Key": "doc", "Value": "demo" } ], "Status": "Active", "Username": "admin", "CreateTime": "2022-01-01T00:00:00Z", "Description": "This is a workspace discription", "ProjectName": "default", "InstanceTypeId": "vmp.standard.15d", "OverdueReclaimTime": "2022-01-01T00:00:00Z", "DeleteProtectionEnabled": true, "PrometheusPushIntranetEndpoint": "http://push.prometheus-cn-beijing.ivolces.com/workspaces/***/api/v1/push", "PrometheusQueryIntranetEndpoint": "http://query.prometheus-cn-beijing.ivolces.com/workspaces/1d0***", "PrometheusWriteIntranetEndpoint": "http://write.prometheus-cn-beijing.ivolces.com/workspaces/1d0***" } ] } } ``` ## 错误码本接口错误码如下表所示，公共错误码请参见 [公共错误码](https://www.volcengine.com/docs/6731/942210)。 |**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 服务。 |