Obtain the list of workspace types.

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=ListWorkspaceInstanceTypes&Version=2021-03-03

Request parameters

Parameter	Type	Required	Sample value	Description
Action	String	Yes	ListWorkspaceInstanceTypes	API name. The API name is ListWorkspaceInstanceTypes.
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 WorkspaceInstanceTypeFilters	No	-	Filter conditions for workspace types.

WorkspaceInstanceTypeFilters

Parameter	Type	Required	Sample value	Description
Ids	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 workspace types.
Items	Array of WorkspaceInstanceType	-	A list of workspace types.

WorkspaceInstanceType

Parameter	Type	Sample value	Description
Id	String	vmp.standard.15d	Workspace type.
ActiveSeries	Integer	10000000	Maximum number of active series.
QueryPerSecond	Integer	100	Maximum query QPS.
ReplicasPerZone	Integer	2	Number of data replicas per availability zone (az).
RetentionPeriod	String	360h	Maximum data retention period.
QueryConcurrency	Integer	10	Maximum query concurrency.
DownsamplingPeriods	Array of String	["90d:5m"]	Downsampling policy.
ScanSeriesPerSecond	Integer	20000	Maximum number of time series scanned per second.
ScanSamplesPerSecond	Long	200000000	Maximum number of samples scanned per second.
IngestSamplesPerSecond	Integer	1000000	Maximum number of samples written per second.
AvailabilityZoneReplicas	Integer	2	Number of availability zones (az).

Sample responses

Error codes

The following table lists the error codes for this API only. For common error codes, see Public error codes.

HTTP status codes	Error codes	Error message	Description
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.