ModifyApmAssociation

最后更新时间：2025-11-14 16:37:55

ModifyApmAssociation

最后更新时间： 2025-11-14 16:37:55

1. API Description

Domain name for API request: apm.intl.tencentcloudapi.com.

This API is used to modify the relationship between the apm Business System and other products, including deletion.

A maximum of 20 requests can be initiated per second for this API.

We recommend you to use API Explorer

Try it

API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name	Required	Type	Description
Action	Yes	String	Common Params. The value used for this API: ModifyApmAssociation.
Version	Yes	String	Common Params. The value used for this API: 2021-06-22.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product.
ProductName	Yes	String	Associated product name. currently only supports Prometheus.
Status	Yes	Integer	Status of the association relationship: // association status: 1 (enabled), 2 (disabled), 4 (deleted).
InstanceId	Yes	String	Business system ID
PeerId	No	String	Associated product instance ID.
Topic	No	String	Specifies the CKafka message topic.

3. Output Parameters

Parameter Name	Type	Description
RequestId	String	The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.

4. Example

Example1 test

This example shows you how to modify the relationship between the apm Business System and other products.

Input Example

POST / HTTP/1.1
Host: apm.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyApmAssociation
<Common request parameters>

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

Output Example

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

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

Tencent Cloud CLI 3.0

6. Error Code

The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

Error Code	Description
FailedOperation.AssociationModifyRequestNotValidError	Association relationship modify request error.
FailedOperation.CKafkaDiffAssociationError	ckafka is inconsistent with the old association information.
FailedOperation.CKafkaEmptyTopicError	topic cannot be empty.
FailedOperation.CKafkaGetRouteIDFailedError	Get route failed.
FailedOperation.CKafkaGetRouteTimeoutError	Get route timeout.
FailedOperation.CKafkaNotAvailableError	CKafka instance unavailable.
FailedOperation.PeerIdNotAvailable	Associated product ID unavailable.
FailedOperation.ProductNameNotAvailable	Associated product name is unavailable or not currently supported.
FailedOperation.PromInstanceNotAvailableError	The Prometheus instance status is unavailable.
FailedOperation.RouteNotAvailableError	Route unavailable.
FailedOperation.TopicNotAvailableError	topic is unavailable.

本页内容是否解决了您的问题？

您也可以联系销售或提交工单以寻求帮助。

是

否

文档反馈

tencent cloud