CreatePrometheusAlertGroup

最后更新时间：2025-11-13 20:45:17

CreatePrometheusAlertGroup

最后更新时间： 2025-11-13 20:45:17

1. API Description

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

This API is used to create a Prometheus alert rule groups.

This API is used to group alert rules, which can include multiple alert rules. Alert messages within the group are sent via the alert group's notification template.
This API is used to enable individually creating enabled/disabled alert rules under an alert group.

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: CreatePrometheusAlertGroup.
Version	Yes	String	Common Params. The value used for this API: 2018-07-24.
Region	Yes	String	Common Params. For more information, please see the list of regions supported by the product. This API only supports: ap-bangkok, ap-beijing, ap-chengdu, ap-chongqing, ap-guangzhou, ap-hongkong, ap-jakarta, ap-nanjing, ap-seoul, ap-shanghai, ap-shanghai-fsi, ap-shenzhen-fsi, ap-singapore, ap-tokyo, eu-frankfurt, na-ashburn, na-siliconvalley, sa-saopaulo.
InstanceId	No	String	prometheus instance ID.
GroupName	No	String	Alert group name. Not allowed to have the same name as other Alert groups.
GroupState	No	Integer	Alert group status. 2 - enable. 3 - disabled. Specifies to overwrite all alert rule statuses under the `Rules` field when not empty.
AMPReceivers.N	No	Array of String	Alert notification template ID list of tencent cloud observability platform, such as Consumer-xxxx or notice-xxxx.
CustomReceiver	No	PrometheusAlertCustomReceiver	Specifies the custom Alert notification template.
RepeatInterval	No	String	Alert notification cycle (convergence time). defaults to 1h if left empty.
Rules.N	No	Array of PrometheusAlertGroupRuleSet	Specifies the Alert rule list to be created.

3. Output Parameters

Parameter Name	Type	Description
GroupId	String	Created Alert group ID, which matches the regular expression `alert-[a-z0-9]{8}`.
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 Creating an Alert Rule Using a Notification Template

This example shows you how to create an alert rule using a notification template.

Input Example

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

{
    "InstanceId": "prom-7vp71mk0",
"GroupName": "Alarm Grouping Test"
    "AMPReceivers": [
        "notice-xxxxxx"
    ],
    "Rules": [
        {
"RuleName": "Rule-1",
            "Labels": [
                {
                    "Key": "k1",
                    "Value": "v1"
                }
            ],
            "Annotations": [
                {
                    "Key": "summary",
                    "Value": "{{$value}}"
                },
                {
                    "Key": "describe",
"Value": "Rule 1 Alarm"
                }
            ],
            "Expr": "expr1"
        }
    ]
}

Output Example

{
    "Response": {
        "GroupId": "alert-2zvqof1a",
        "RequestId": "02c92b99-abc9-431b-8b08-42b9977d51cf"
    }
}

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
AuthFailure	Error with CAM signature/authentication.
FailedOperation	Operation failed.
FailedOperation.BadYamlFormat	The YAML format is incorrect.
FailedOperation.DbQueryFailed	Failed to query the database.
FailedOperation.DbRecordCreateFailed	Failed to create the database record.
FailedOperation.DbRecordDeleteFailed	Failed to delete the database record.
FailedOperation.DbRecordUpdateFailed	Failed to update the database record.
FailedOperation.GenerateInstanceIDFailed	An error occurred while generating the resource ID.
FailedOperation.ResourceExist	The resource already exists.
FailedOperation.ResourceNotFound	The resource does not exist.
InternalError	Internal error.
InvalidParameter	Invalid parameter.

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

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

是

否

文档反馈

tencent cloud