ModifyApmPrometheusRule

Last updated:2025-11-14 16:37:53

ModifyApmPrometheusRule

Last updated: 2025-11-14 16:37:53

1. API Description

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

This API is used to modify metric match rules between apm Business System and Prometheus Instance.

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: ModifyApmPrometheusRule.
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.
Id	Yes	Integer	Rule ID
InstanceId	Yes	String	Business system ID
Name	No	String	Specifies the rule name to modify.
Status	No	Integer	Rule status: 1 (enabled), 2 (disabled), 3 (deleted).
ServiceName	No	String	Applications where the rule takes effect. input an empty string for all applications. if this is not modified, pass the old rule.
MetricMatchType	No	Integer	Match type: 0 - precision match, 1 - prefix match, 2 - suffix match (if not modified, the old rule must be passed).
MetricNameRule	No	String	Specifies the rule for customer-defined metric names with cache hit.

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 match rule for metrics between the apm Business System and Prometheus Instance.

Input Example

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

{
    "Id": 2,
    "Name": "MyRule",
    "Status": 2,
    "ServiceName": "profile-service",
    "MetricMatchType": 0,
    "MetricNameRule": "task.duration",
    "InstanceId": "apm-059oXBfTL"
}

Output Example

{
    "Response": {
        "RequestId": "be4c9cea-5b0f-4b96-93d6-59c840a4c096"
    }
}

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	Operation failed.
FailedOperation.PromRuleConflict	Prometheus metric match rule conflict, same metric match rule exists.
FailedOperation.PromRuleIsEmptyErr	Prometheus metric match rule is empty.
FailedOperation.PromRuleRequestNotValidError	Prometheus metric match rule request error.

Was this page helpful?

You can also Contact Sales or Submit a Ticket for help.

Yes

Feedback

tencent cloud