获取接入任务。 ## 请求说明托管 Prometheus 已在全球多个地域部署服务，旨在为您提供更稳定、低延迟的访问体验。您可以通过查阅 [服务地址](https://www.volcengine.com/docs/6731/1581726) 文档，根据业务所在地域，选择最合适的接入点。 * 请求方式：POST * 请求地址：https://vmp.cn\-beijing.volcengineapi.com?Action=GetIntegrationTask&Version=2021\-03\-03 ## 调试 ## 请求参数 |**参数** |**类型** |**是否必选** |**示例值** |**描述** | |---|---|---|---|---| |Action |String |是 |GetIntegrationTask |接口名称。当前 API 的名称为 `GetIntegrationTask`。 | |Version |String |是 |2021\-03\-03 |接口版本。当前 API 的版本为 `2021-03-03`。 | |Id |String |是 |fcbc7eef\-2f6c\-4247\-bce1\*\*\* |接入任务 ID。 | ## 请求示例 ```JSON POST https://vmp.cn-beijing.volcengineapi.com?Action=GetIntegrationTask&Version=2021-03-03 Content-Type: application/json { "Id": "fcbc7eef-2f6c-4247-bce1***" } ``` ## 返回参数 |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Id |String |fcbc7eef\-2f6c\-4247\-bce1\*\*\* |接入任务 ID。 | |Name |String |test |接入任务名称。 | |WorkspaceId |String |fcbc7eef\-2f6c\-4247\-bce1\*\*\* |工作区 ID。 | |Type |String |CloudMonitor |接入任务类型。取值为`CloudMonitor`时，表示云监控接入任务。 | |Status |String |Creating |接入任务状态，取值：|\ | | | ||\ | | | |* **Creating**：创建中|\ | | | |* **Updating**：更新中|\ | | | |* **Active**：正常|\ | | | |* **Error**：错误|\ | | | |* **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\"} |接入任务相关参数。 | |Environment |String |Vke |接入任务部署环境，取值：|\ | | | ||\ | | | |* **Vke**：接入任务部署在 VKE 集群中。|\ | | | |* **Managed**：接入任务部署在托管环境中。|\ | | | ||\ | | | |:::tip|\ | | | |当配置云监控接入任务时，仅支持选择 Managed 环境。|\ | | | ||\ | | | |:::| |VkeClusterId |String |cd2i3c1beif8n1\*\*\* |接入任务部署的 VKE 集群 ID。 | |VkeClusterInfo |Object of [VkeClusterInfo](#vkeclusterinfo) |\- |接入任务部署的 VKE 集群信息。 | ### VkeClusterInfo |**参数** |**类型** |**示例值** |**描述** | |---|---|---|---| |Name |String |cluster\-demo |VKE 集群名称。 | |Status |String |Running |VKE 集群状态。 | ## 返回示例 ```JSON HTTP/1.1: 200 OK Content-Type: application/json { "ResponseMetadata": { "RequestId": "20230604110420****100232280022D31", "Action": "GetIntegrationTask", "Version": "2021-03-03", "Service": "vmp", "Region": "cn-beijing" }, "Result": { "Id": "fcbc7eef-2f6c-4247-bce1***", "Name": "test", "WorkspaceId": "fcbc7eef-2f6c-4247-bce1***", "Environment": "Vke", "VkeClusterId": "cd2i3c1beif8n1***", "VkeClusterInfo": { "Name": "cluster-demo", "Status": "Running" }, "Type": "CloudMonitor", "Status": "Creating", "Params": "{\\\"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\\\"}" } } ``` ## 错误码本接口错误码如下表所示，公共错误码请参见 [公共错误码](https://www.volcengine.com/docs/6731/942210)。 |**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. |缺少必要的参数。 |