tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Tencent Cloud Observability Platform
    Documentation
    Download PDF

    CreateAlertRule

    Last updated: 2023-08-11 16:09:09
    Download PDF

    1. API Description

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

    This API is used to create a Prometheus alerting rule.

    Note that alert object and alert message are special fields of Prometheus Rule Annotations, which need to be passed in through annotations and correspond to summary and description keys respectively. For more information, see Alerting rules.

    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: CreateAlertRule.
    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-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.
    InstanceId Yes String TMP instance ID, such as “prom-abcd1234”.
    RuleName Yes String Rule name
    Expr Yes String Alerting rule expression. For more information, see Alerting Rule Description
    Receivers.N Yes Array of String List of alert notification template IDs
    RuleState No Integer Rule status code. Valid values:
  • 2=RuleEnabled
  • 3=RuleDisabled
    		•
    Duration No String Rule alert duration
    Labels.N No Array of PrometheusRuleKV List of tags
    Annotations.N No Array of PrometheusRuleKV List of annotations.

    Alert object and alert message are special fields of Prometheus Rule Annotations, which need to be passed in through annotations and correspond to summary and description keys respectively.
    Type No String Alerting rule template category

    3. Output Parameters

    Parameter Name Type Description
    RuleId String Rule ID
    Note: This field may return null, indicating that no valid values can be obtained.
    RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

    4. Example

    Example1 Creating an alerting rule

    Input Example

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

{
    "Receivers": [
        "34224"
    ],
    "InstanceId": "prom-abcd1234",
    "Expr": "\"up{service=\\\"rig-prometheus-agent\\\"}>0\"",
    "Duration": "5m",
    "RuleName": "test",
    "RuleState": "2"
}

    Output Example

    {
    "Response": {
        "RequestId": "hfd437lxxdj3455-qxdb3eyydvw4doxm",
        "RuleId": "arule-f2vx2owo"
    }
}

    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
    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.
    Contact Us

    Contact our sales team or business advisors to help your business.

    Contact Us
    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    Submit a Ticket
    7x24 Phone Support
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy