Query workspace details.

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

Debugging

API Explorer

You can initiate calls online through API Explorer without paying attention to the signature generation process and quickly obtain the call results.

Go to debug

Request parameters

Parameters	Type	Required	Sample value	Description
Action	String	Yes	GetWorkspace	The name of the API. The API name is GetWorkspace.
Version	String	Yes	2021-03-03	The API version. The API version is 2021-03-03.
Id	String	Yes	e28ae750-bbb8-4ff4-abf4***	Workspace ID You can call the ListWorkspaces API to obtain the workspace ID.

Sample request

Response parameters

Parameters	Type	Sample value	Description
Id	String	e28ae750-bbb8-4ff4-abf4***	Workspace ID
CreateTime	String	2022-01-01T00:00:00Z	The creation date of the workspace.
Name	String	workspace-demo	Workspace name.
Description	String	This is a workspace description	Description of the workspace.
Status	String	Active	Workspace statuses: Creating: in the process of creating Active: working properly Updating: updating Deleting: deleting OverdueShutted: shutdown due to overdue payment Resuming: resuming Error: errors occurred
InstanceTypeId	String	vmp.standard.15d	Workspace type. Available values: 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.
OverdueReclaimTime	String	2022-01-01T00:00:00Z	Estimated reclaim time of workspace for overdue payments. It is presented in RFC3339 format. tip This field remains empty until overdue payments happen.
Username	String	admin	BasicAuth username of the workspace.
PrometheusWriteIntranetEndpoint	String	http://query.prometheus-cn-beijing.ivolces.com/workspaces/1d0***	RemoteWrite URL of the workspace.
PrometheusQueryIntranetEndpoint	String	http://write.prometheus-cn-beijing.ivolces.com/workspaces/1d0***	Query URL of the workspace.
DeleteProtectionEnabled	Boolean	true	Whether the deletion protection for a workspace is enabled: true: enabled. false: disabled.
Tags	Array of Tag	-	Workspace tags.
ProjectName	String	default	The project name.
PrometheusPushIntranetEndpoint	String	http://push.prometheus-cn-beijing.ivolces.com/workspaces/***/api/v1/push	URL of workspace Pushgateway.
AuthType	String	BasicAuth	The workspace authentication type. Valid values: BasicAuth: basic authentication BearerToken: token authentication None: Custom authentication is not configured. In this case, Volcano Engine AK/SK authentication is used by default.
InstanceType	Object of WorkspaceInstanceType	-	Detailed workspace specifications.
Quota	Object of WorkspaceQuota	-	Workspace quota details.

Tag

Parameters	Type	Sample value	Description
Key	String	doc	Key of tag.
Value	String	demo	Value of the label.

WorkspaceInstanceType

Parameters	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 scan series 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).

WorkspaceQuota

Parameters	Type	Sample value	Description
ActiveSeries	Integer	1000000	Maximum number of active series. It is an integer from 1 to 50,000,000.
QueryPerSecond	Integer	100	Maximum query QPS. It is an integer from 1 to 500.
ScanSeriesPerSecond	Integer	20000	Maximum number of scan series per second. It is an integer from 1 to 200,000.
ScanSamplesPerSecond	Long	200000000	Maximum number of samples scanned per second. It is an integer from 1 to 1,000,000,000.
IngestSamplesPerSecond	Integer	1000000	Metric ingestion rate, which is the maximum number of samples written per second. It is an integer from 1 to 5,000,000.

Sample response

Error code

This API has no exclusive error codes. For public error codes, see Public error codes.