tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Documentation

DescribeAlertRules

Last updated: 2023-08-11 16:09:06

1. API Description

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

This API is used to query a Prometheus alerting 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: DescribeAlertRules.
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 Prometheus instance ID
Limit No Integer Number of returned results. Default value: 20. Maximum value: 100.
Offset No Integer Offset. Default value: 0.
RuleId No String Rule ID
RuleState No Integer Rule status code. Valid values:
  • 2=RuleEnabled
  • 3=RuleDisabled
    		•
    RuleName No String Rule name
    Type No String Alerting rule template category

    3. Output Parameters

    Parameter Name Type Description
    TotalCount Integer Number of alerting rules
    AlertRuleSet Array of PrometheusRuleSet Alerting rule details
    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 Querying alerting rules

    Input Example

    https://monitor.tencentcloudapi.com/?Action=DescribeAlertRules
&InstanceId=my-prom-gg
&RuleState=2
&Limit=10
&<Common request parameters>

    Output Example

    {
    "Response": {
        "AlertRuleSet": [
            {
                "RuleId": "arule-c9qvmfm8",
                "RuleName": "example6",
                "RuleState": 3,
                "Type": "",
                "Labels": [
                    {
                        "Key": "k1",
                        "Value": "v1"
                    },
                    {
                        "Key": "k2",
                        "Value": "v2"
                    }
                ],
                "Expr": "up{service=\"rig-prometheus-agent\"} > 0",
                "Annotations": [
                    {
                        "Key": "ak1",
                        "Value": "av1"
                    },
                    {
                        "Key": "ak2",
                        "Value": "av2"
                    }
                ],
                "Duration": "1m",
                "Receivers": [
                    "123",
                    "456"
                ],
                "CreatedAt": "2020-08-24T09:39:27Z",
                "UpdatedAt": "2020-08-24T09:39:27Z"
            },
            {
                "RuleId": "arule-nnqzmis6",
                "RuleName": "example5",
                "RuleState": 2,
                "Type": "",
                "Labels": [
                    {
                        "Key": "k1",
                        "Value": "v1"
                    },
                    {
                        "Key": "k2",
                        "Value": "v2"
                    }
                ],
                "Expr": "up{service=\"rig-prometheus-agent\"} > 0",
                "Annotations": [
                    {
                        "Key": "ak1",
                        "Value": "av1"
                    },
                    {
                        "Key": "ak2",
                        "Value": "av2"
                    }
                ],
                "Duration": "1m",
                "Receivers": [
                    "123",
                    "456"
                ],
                "CreatedAt": "2020-08-24T09:39:17Z",
                "UpdatedAt": "2020-08-24T09:39:17Z"
            }
        ],
        "RequestId": "-fp6ttca3mlpv34ks85fv3661vja2bwg",
        "TotalCount": 2
    }
}

    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.
    Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
    Privacy PolicyLegalCookie Policy