文档中心

托管 Prometheus

接入任务

ListIntegrationTasks

获取接入任务列表。

请求说明

托管 Prometheus 已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅服务地址文档，根据业务所在地域，选择最合适的接入点。

请求方式：POST

请求地址：https://vmp.cn-beijing.volcengineapi.com?Action=ListIntegrationTasks&Version=2021-03-03

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	ListIntegrationTasks	接口名称。当前 API 的名称为 ListIntegrationTasks。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 2021-03-03。
PageNumber	Long	否	1	当前页数，最小值或默认值均为 1。
PageSize	Long	否	10	单页数量: 取值范围为 0～100。默认值为 10。
Filters	Object of IntegrationFilter	否	-	接入任务过滤条件。

IntegrationFilter

参数	类型	是否必选	示例值	描述
Ids	Array of String	否	fcbc7eef-2f6c-4247-bce1***	接入任务 ID。
Name	String	否	integration-demo	接入任务名称，支持模糊搜索。
Statuses	Array of String	否	Creating	接入任务状态，取值： Creating：创建中 Updating：更新中 Active：正常 Error：错误 Deleting：删除中
Environment	String	否	Managed	接入任务部署环境，取值： Vke：接入任务部署在 VKE 集群中。 Managed：接入任务部署在托管环境中。说明当配置云监控接入任务时，仅支持选择 Managed 环境。
WorkspaceId	String	否	e28ae750-bbb8-4ff4-abf4***	工作区 ID。
VkeClusterIds	Array of String	否	cd2i3c1beif8n1***	接入任务部署的 VKE 集群 ID。

请求示例

POST https://vmp.cn-beijing.volcengineapi.com?Action=ListIntegrationTasks&Version=2021-03-03​
Content-Type: application/json​
{​
    "PageNumber": 1,​
    "PageSize": 10,​
    "Filters": {​
        "Ids": [​
            ""​
        ],​
        "Name": "integration-demo",​
        "Statuses": [​
            ""​
        ],​
        "Environment": "Managed",​
        "WorkspaceId": "e28ae750-bbb8-4ff4-abf4***",​
        "VkeClusterIds": [​
            ""​
        ]​
    }​
}

返回参数

参数	类型	示例值	描述
Total	Long	100	接入任务总数。
Items	Array of IntegrationTask	-	接入任务列表。

IntegrationTask

参数	类型	示例值	描述
Id	String	fcbc7eef-2f6c-4247-bce1***	接入任务 ID。
Name	String	integration-demo	接入任务名称。
Type	String	CloudMonitor	接入任务类型。
Status	String	Active	接入任务状态，取值： Creating：创建中 Updating：更新中 Active：正常 Error：错误 Deleting：删除中
Environment	String	Vke	接入任务部署环境，取值： Vke：接入任务部署在 VKE 集群中。 Managed：接入任务部署在托管环境中。说明当配置云监控接入任务时，仅支持选择 Managed 环境。
WorkspaceId	String	e28ae750-bbb8-4ff4-abf4***	工作区 ID。
VkeClusterId	String	cd2i3c1beif8n1***	接入任务部署的 VKE 集群 ID。
VkeClusterInfo	Object of VkeClusterInfo	-	接入任务部署的 VKE 集群信息。

VkeClusterInfo

参数	类型	示例值	描述
Name	String	cluster-demo	VKE 集群名称。
Status	String	Running	VKE 集群状态。

返回示例

HTTP/1.1: 200 OK​
Content-Type: application/json​
{​
    "ResponseMetadata": {​
        "RequestId": "20230604110420****100232280022D31",​
        "Action": "ListIntegrationTasks",​
        "Version": "2021-03-03",​
        "Service": "vmp",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "Total": 100,​
        "Items": [​
            {​
                "Id": "fcbc7eef-2f6c-4247-bce1***",​
                "Name": "integration-demo",​
                "Type": "CloudMonitor",​
                "Status": "Active",​
                "Environment": "Vke",​
                "WorkspaceId": "e28ae750-bbb8-4ff4-abf4***",​
                "VkeClusterId": "cd2i3c1beif8n1***",​
                "VkeClusterInfo": {​
                    "Name": "cluster-demo",​
                    "Status": "Running"​
                }​
            }​
        ]​
    }​
}

错误码

本接口错误码如下表所示，公共错误码请参见公共错误码。

HTTP 状态码	错误码	错误信息	说明
403	ProductUnsubscribed	You are not subscribed to VMP. Please go to the VMP console web page to subscribe to the service	当前账号未订阅 VMP 服务。
400	InvalidParameter.{{parameter}}	The specified parameter {{parameter}} is invalid.	输入不合法，如工作区名称不合法等。
400	MissingParameter.{{parameter}}	The required parameter {{parameter}} is missing.	缺少必要的参数。

最近更新时间：2025.11.05 17:12:27

这个页面对您有帮助吗？

有用

无用