Get an integration task.

Request description

VMP has been deployed in multiple regions worldwide, aiming to provide you with an experience of higher stability and lower latency. You can choose an access point that is optimal for the region of your services according to the Service addresses document.

Request method: POST

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

Request parameters

Parameters	Type	Required or not	Sample value	Description
Action	String	Yes	GetIntegrationTask	The API name. The name of the current API operation is GetIntegrationTask.
Version	String	Yes	2021-03-03	API version. The API version is 2021-03-03.
Id	String	Yes	fcbc7eef-2f6c-4247-bce1***	The ID of the integration task.

Sample requests

Response parameters

Parameters	Type	Sample value	Descriptions
Id	String	fcbc7eef-2f6c-4247-bce1***	The ID of the integration task.
Name	String	test	The name of the integration task.
WorkspaceId	String	fcbc7eef-2f6c-4247-bce1***	Workspace ID.
Type	String	CloudMonitor	Integration task type. The value CloudMonitor indicates a Cloud Monitor integration task.
Status	String	Creating	The status of the integration task. Valid values: Creating: creating Updating: updating Active: working properly Error: errors occurred Deleting: deleting
Params	String	{\"JobName\":\"test\",\"ScrapeInterval\":\"1m\",\"Regions\":{\"cn-beijing\":{\"VCM_ALB\":{},\"VCM_ECS\":{}}},\"MetaLabelWithNewMetric\":false,\"RelabelConfigs\":\"- action: drop\\n source_labels:\\n - __name__\\n regex: metricA\|metricB\"}	Integration task settings.
Environment	String	Vke	The environment to which the integration task is deployed. Valid values: Vke: the integration task is deployed in a VKE cluster. Managed: the integration task is deployed in a managed environment. tip When you create a Cloud Monitor integration task, you can select only a managed environment.
VkeClusterId	String	cd2i3c1beif8n1***	The ID of the VKE cluster where the integration task is deployed.
VkeClusterInfo	Object of VkeClusterInfo	-	Information about the VKE cluster to which the integration task is deployed.

VkeClusterInfo

Parameters	Type	Sample value	Description
Name	String	cluster-demo	The name of the VKE cluster.
Status	String	Running	The VKE cluster status.

Sample responses

Error code

The error codes for current API only are listed in the table below. See Public error codes to view error codes for any APIs.

HTTP status code	Error code	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.
400	InvalidParameter.{{parameter}}	The specified parameter {{parameter}} is invalid.	Invalid parameters are found. For example, an invalid workspace name is included in requests.
400	MissingParameter.{{parameter}}	The required parameter {{parameter}} is missing.	Missing required parameters.

Volcengine Managed Service for Prometheus