Get a list of integration tasks.

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

Request parameters

Parameter	Type	Required or not	Sample Value	Description
Action	String	Yes	ListIntegrationTasks	The API name. The name of the current API is ListIntegrationTasks.
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	Number per page: The value can range from 0 to 100. Default value is 10.
Filters	Object of IntegrationFilter	No	-	Filter conditions for integration tasks.

IntegrationFilter

Parameter	Type	Required or not	Sample value	Description
Ids	Array of String	No	fcbc7eef-2f6c-4247-bce1***	The IDs of the integration tasks.
Name	String	No	integration-demo	Task name. Fuzzy search is supported.
Statuses	Array of String	No	Creating	The status of the integration task. Valid values: Creating: creating Updating: updating Active: working properly Error: errors occurred Deleting: deleting
Environment	String	No	Managed	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.
WorkspaceId	String	No	e28ae750-bbb8-4ff4-abf4***	Workspace ID.
VkeClusterIds	Array of String	No	cd2i3c1beif8n1***	The ID of the VKE cluster where the integration task is deployed.

Sample requests

Response parameters

Parameter	Type	Sample value	DDescriptionescription
Total	Long	100	Total number of integration tasks.
Items	Array of IntegrationTask	-	A list of integration tasks.

IntegrationTask

Parameter	Type	Sample value	Description
Id	String	fcbc7eef-2f6c-4247-bce1***	The ID of the integration task.
Name	String	integration-demo	The name of the integration task.
Type	String	CloudMonitor	Integration task type.
Status	String	Active	The status of the integration task. Valid values: Creating: creating Updating: updating Active: working properly Error: errors occurred Deleting: deleting
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.
WorkspaceId	String	e28ae750-bbb8-4ff4-abf4***	Workspace ID.
VkeClusterId	String	cd2i3c1beif8n1***	The ID of the VKE cluster that runs the integration task.
VkeClusterInfo	Object of VkeClusterInfo	-	Information about the VKE cluster to which the integration task is deployed.

VkeClusterInfo

Parameter	Type	Sample Value	Description
Name	String	cluster-demo	The VKE cluster name.
Status	String	Running	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 codes	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.	An invalid parameter was found. For example, an invalid workspace name was included in requests.
400	MissingParameter.{{parameter}}	The required parameter {{parameter}} is missing.	Missing necessary parameters.

Volcengine Managed Service for Prometheus