tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

CreatePrometheusAlertRule

Last updated: 2024-11-14 14:53:51

    1. API Description

    Domain name for API request: tke.tencentcloudapi.com.

    This API is used to create an alarm rule.

    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: CreatePrometheusAlertRule.
    Version Yes String Common Params. The value used for this API: 2018-05-25.
    Region Yes String Common Params. For more information, please see the list of regions supported by the product.
    InstanceId Yes String Instance ID
    AlertRule Yes PrometheusAlertRuleDetail Alarm configurations

    3. Output Parameters

    Parameter Name Type Description
    Id String Alarm ID
    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

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

    Input Example

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

{
    "InstanceId": "prom-test",
    "AlertRule": {
        "TemplateId": "temp-test",
        "Name": "test",
        "Rules": [
            {
                "Describe": "Pod is in NotReady status for more than 15 minutes",
                "Name": "KubePodNotReady",
                "For": "",
                "Labels": [
                    {
                        "Name": "severity",
                        "Value": "warning"
                    }
                ],
                "Rule": "sum by (cluster,namespace, pod) (\n  max by(cluster,namespace, pod) (\n    kube_pod_status_phase{job=\"kube-state-metrics\", phase=~\"Pending|Unknown\"}\n  ) * on(cluster,namespace, pod) group_left(owner_kind) topk by(cluster,namespace, pod) (\n    1, max by(cluster,namespace, pod, owner_kind) (kube_pod_owner{owner_kind!=\"Job\"})\n  )\n) > 0\n",
                "Template": "cluster {{ $labels.cluster }}/namespace {{ $labels.namespace }}/Pod {{ $labels.pod }} is in NotReady status for more than 15 minutes",
                "Annotations": [
                    {
                        "Name": "content",
                        "Value": "pod crash"
                    }
                ]
            }
        ],
        "Notification": {
            "RepeatInterval": "5h",
            "TimeRangeStart": "00:00:00",
            "Enabled": true,
            "PhoneNotifyOrder": [
                1
            ],
            "PhoneInnerInterval": 0,
            "PhoneCircleInterval": 0,
            "NotifyWay": [
                "SMS"
            ],
            "ReceiverGroups": [
                1
            ],
            "PhoneArriveNotice": true,
            "PhoneCircleTimes": 0,
            "Type": "amp",
            "TimeRangeEnd": "23:59:59"
        }
    }
}

    Output Example

    {
    "Response": {
        "Id": "alert-123",
        "RequestId": "85438a95-6e0d-422e-a099-123456789"
    }
}

    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

    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
    InternalError Internal error.
    InternalError.Param Parameter error.
    InternalError.UnexpectedInternal Unknown internal error.
    InvalidParameter.Param Invalid parameter.
    InvalidParameter.PromInstanceNotFound The PROM instance does not exist.
    ResourceNotFound The resource does not exist.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy