文档中心

托管 Prometheus

接入任务

UpdateIntegrationTask

更新接入任务。

请求说明

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

请求方式：POST

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

调试

API Explorer

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

去调试

请求参数

参数	类型	是否必选	示例值	描述
Action	String	是	UpdateIntegrationTask	接口名称。当前 API 的名称为 UpdateIntegrationTask。
Version	String	是	2021-03-03	接口版本。当前 API 的版本为 2021-03-03。
Id	String	是	fcbc7eef-2f6c-4247-bce1***	接入任务 ID。
Name	String	否	integration-demo	接入任务名称。字符串形式，取值范围为 1～40 个字符。支持中文、英文、数字和下划线_。
WorkspaceId	String	否	e28ae750-bbb8-4ff4-abf4***	工作区 ID。
Params	String	否	-	接入任务相关参数，需填写为 JSON 转义后的字符串。

Params

当接入任务类型为CloudMonitor，即云监控接入时，Params 配置参数如下表所示。

参数	类型	是否必选	示例值	描述
JobName	String	否	test	云监控接入任务名称。
ScrapeInterval	String	否	1m	指标采集间隔时间。数字 + 单位形式，单位支持 s（秒）、m（分）。例如：1m 表示 1 分钟。取值范围为 30s～5m。
Regions	Object	否	{"cn-beijing": {"VCM_ALB": {}}}	云产品与地域的映射关系，键为地域（例如cn-beijing）。
MetaLabelWithNewMetric	Boolean	否	false	元信息 Label 导出方式，取值： true：表示使用新指标volc_resource_info展示元信息 Label。 false：表示将元信息 Label 添加到云产品指标上。说明云产品实例元信息的导出和查看方式，请参见查询云产品实例元信息。
ExportedTags	Array of String	否	demo	配置需要注入云产品指标的标签键。
RelabelConfigs	String	否	- action: drop\n source_labels:\n - __name__\n regex: metricA\|metricB	配置指标 Relebel，详情请参见指标 Relabel。

构建 Params 参数的步骤如下：

使用 Params 支持的字段，根据需要构建 JSON 结构代码，本文以如下代码为例。

{​
    "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"​
}​

使用 JSON 转义工具，将 JSON 转义为如下字符串。

{\"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\"}​

将上述字符串配置为Params参数的值即可。

请求示例

POST https://vmp.cn-beijing.volcengineapi.com?Action=UpdateIntegrationTask&Version=2021-03-03​
Content-Type: application/json​
{​
    "Id": "fcbc7eef-2f6c-4247-bce1***",​
    "Name": "integration-demo",​
    "WorkspaceId": "e28ae750-bbb8-4ff4-abf4***",​
    "Params": "-"​
}

返回参数

参数	类型	示例值	描述
Id	String	fcbc7eef-2f6c-4247-bce1***	接入任务 ID。

返回示例

HTTP/1.1: 200 OK​
Content-Type: application/json​
{​
    "ResponseMetadata": {​
        "RequestId": "20230604110420****100232280022D31",​
        "Action": "UpdateIntegrationTask",​
        "Version": "2021-03-03",​
        "Service": "vmp",​
        "Region": "cn-beijing"​
    },​
    "Result": {​
        "Id": "fcbc7eef-2f6c-4247-bce1***"​
    }​
}

错误码

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

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

这个页面对您有帮助吗？

有用

无用