Obtain workspace statuses.

Request description

Volcengine Managed Service for Prometheus has been deployed in multiple regions worldwide to provide you with a more stable, lower-latency experience. You can choose an optimal access point for your service region by referring to the Service addresses topic.

Request method: POST

Request URL: https://vmp.cn-beijing.volcengineapi.com/?Action=ListWorkspaceStatus&Version=2021-03-03

Request parameters

Parameter	Type	Required	Sample value	Description
Action	String	Yes	ListWorkspaceStatus	API name. The API name is ListWorkspaceStatus.
Version	String	Yes	2021-03-03	API version. The API version is 2021-03-03.
PageNumber	Long	No	1	Current page number. The minimum and default values are both 1.
PageSize	Long	No	10	Results per page: A number from 0 to 100. The default number is 10.
Filters	Object of WorkspaceFilter	No	-	Filter conditions for workspaces.
ProjectName	String	No	default	Project name of the workspace.

WorkspaceFilter

Parameter	Type	Required	Sample value	Description
Ids	Array of String	No	["e28ae750-bbb8-4ff4-abf4***"]	Exact query by workspace IDs.
Name	String	No	workspace-demo	Fuzzy query by a workspace name.
Statuses	Array of String	No	["Active"]	Exact query by workspace statuses. Available statuses: Creating: in the process of creating Active: working properly Updating: in the process of updating Deleting: in the process of deleting OverdueShutted: shutdown due to overdue payment Resuming: in the process of reactivating Error: errors occurred
InstanceTypeIds	Array of String	No	["vmp.standard.15d"]	Exact query by workspace types. Available types: vmp.standard.15d: 15-day storage workspace. vmp.standard.30d: 30-day storage workspace. vmp.standard.90d: 90-day storage workspace. vmp.standard.180d: 180-day storage workspace. vmp.standard.1y: 1-year storage workspace.

Sample requests

Response parameters

Parameter	Type	Sample value	Description
Total	Long	100	Total number of workspaces.
Items	Array of WorkspaceStatus	-	A list of workspaces.

WorkspaceStatus

Parameter	Type	Sample value	Description
Id	String	e28ae750-bbb8-4ff4-abf4***	Workspace ID.
Name	String	workspace-demo	Workspace name.
Usage	Object of UsageStatus	-	Usage of the workspace.
Status	String	Active	Workspace statuses: Creating: in the process of creating Active: working properly Updating: in the process of updating Deleting: in the process of deleting OverdueShutted: shutdown due to overdue payment Resuming: in the process of reactivating Error: errors occurred
InstanceTypeId	String	vmp.standard.15d	Workspace specifications.

UsageStatus

Parameter	Type	Sample value	Description
ActiveSeries	Long	10000	The number of active series.
IngestedSamplesPerSecond	Double	3000.0	Samples written per second.

Sample responses

Error codes

The error codes for this API are listed in the following table. For common error codes, see Public error codes.

HTTP status codes	Error codes	Error message	Description
400	InvalidParameter.{{parameter}}	The specified parameter {{parameter}} is invalid.	An invalid parameter was found. For example, an invalid workspace name was included in requests.
403	ProductUnsubscribed	You are not subscribed to VMP. Please go to the VMP console web page to subscribe to the service	The account is not subscribed to the VMP Service.