文档中心>API 中心>应用性能监控>业务系统相关接口>修改apm业务系统与其他产品的关联关系

修改apm业务系统与其他产品的关联关系

最近更新时间:2025-12-05 01:10:16

我的收藏

1. 接口描述

接口请求域名: apm.tencentcloudapi.com 。

用于修改apm业务系统与其他产品的关联关系(包括创建和删除)

默认接口请求频率限制:20次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyApmAssociation。
Version String 公共参数,本接口取值:2021-06-22。
Region String 公共参数,详见产品支持的 地域列表
ProductName String 关联的产品名,当前只支持Prometheus、CKafka
示例值:Prometheus
Status Integer 关联关系的状态:// 关联关系状态:1(启用)、2(不启用)
示例值:1
InstanceId String 业务系统ID
示例值:apm-059oXBfTL
PeerId String 关联的产品实例ID
示例值:prom-xxxxxx
Topic String CKafka消息主题
示例值:apm-trace

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 修改apm业务系统与其他产品的关联关系

修改apm业务系统与其他产品的关联关系

输入示例

POST / HTTP/1.1
Host: apm.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyApmAssociation
<公共请求参数>

{
    "ProductName": "Prometheus",
    "Status": 2,
    "InstanceId": "apm-059oXBfTL",
    "PeerId": "prom-26july28"
}

输出示例

{
    "Response": {
        "RequestId": "9f3e2957-bdf4-4485-98fa-fd7119ec6800"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.AssociationModifyRequestNotValidError 关联关系修改请求有误
FailedOperation.CKafkaDiffAssociationError ckafka与旧关联信息不一致
FailedOperation.CKafkaEmptyTopicError topic不能为空
FailedOperation.CKafkaGetRouteIDFailedError 获取路由失败
FailedOperation.CKafkaGetRouteTimeoutError 获取路由超时
FailedOperation.CKafkaNotAvailableError CKafka实例不可用
FailedOperation.PeerIdNotAvailable 关联产品ID不可用
FailedOperation.ProductNameNotAvailable 关联的产品名称不可用或暂不支持
FailedOperation.PromInstanceNotAvailableError 该Prometheus实例状态不可用
FailedOperation.RouteNotAvailableError 路由不可用
FailedOperation.TopicNotAvailableError topic不可用