tencent cloud

1. API Description

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

This API is used to query the list of alarm policies.

A maximum of 20 requests can be initiated per second for this API.

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.

3. Output Parameters

4. Example

Example1 Searching for an alarm policy associated with a CVM

This example shows you how to filter policies by instance. You need to specify the monitoring/policy type and enter the dimension information of an instance. In this example, we will filter policies by searching for two CVMs with the IDs ins-qr8d555g and ins-qr8d555h, respectively.

MonitorTypes is specified as MT_QCE.

Namespaces is specified as cvm_device.

The JSON string specified for Dimensions is

[
    {
        "Dimensions": {
            "unInstanceId": "ins-qr8d555g"
        }
    },
     {
        "Dimensions": {
            "unInstanceId": "ins-qr8d555h"
        }
    }
]

For more information on the sample parameters of different Tencent Cloud services, see Product Policy Type and Dimension Information.

Input Example

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

{
    "Module": "monitor",
    "PageSize": 10,
    "PageNumber": 1,
    "MonitorTypes": [
        "MT_QCE"
    ],
    "Namespaces": [
        "cvm_device"
    ],
    "Dimensions": "[{\"Dimensions\": { \"unInstanceId\": \"ins-qr8d555g\"}},{ \"Dimensions\": { \"unInstanceId\": \"ins-qr8d555h\"}}]"
}

Output Example

{
    "Response": {
        "TotalCount": 0,
        "Policies": [
            {
                "PolicyId": "abc",
                "PolicyName": "abc",
                "Remark": "abc",
                "MonitorType": "abc",
                "Enable": 0,
                "UseSum": 0,
                "ProjectId": 0,
                "ProjectName": "abc",
                "Namespace": "abc",
                "ConditionTemplateId": "abc",
                "Condition": {
                    "IsUnionRule": 0,
                    "Rules": [
                        {
                            "MetricName": "abc",
                            "Period": 0,
                            "Operator": "abc",
                            "Value": "abc",
                            "ContinuePeriod": 0,
                            "NoticeFrequency": 0,
                            "IsPowerNotice": 0,
                            "Filter": {
                                "Type": "abc",
                                "Dimensions": "abc"
                            },
                            "Description": "abc",
                            "Unit": "abc",
                            "RuleType": "abc",
                            "IsAdvanced": 0,
                            "IsOpen": 0,
                            "ProductId": "abc",
                            "ValueMax": 0,
                            "ValueMin": 0,
                            "HierarchicalValue": {
                                "Remind": "abc",
                                "Warn": "abc",
                                "Serious": "abc"
                            }
                        }
                    ],
                    "ComplexExpression": "abc"
                },
                "EventCondition": {
                    "Rules": [
                        {
                            "MetricName": "abc",
                            "Period": 0,
                            "Operator": "abc",
                            "Value": "abc",
                            "ContinuePeriod": 0,
                            "NoticeFrequency": 0,
                            "IsPowerNotice": 0,
                            "Filter": {
                                "Type": "abc",
                                "Dimensions": "abc"
                            },
                            "Description": "abc",
                            "Unit": "abc",
                            "RuleType": "abc",
                            "IsAdvanced": 0,
                            "IsOpen": 0,
                            "ProductId": "abc",
                            "ValueMax": 0,
                            "ValueMin": 0,
                            "HierarchicalValue": {
                                "Remind": "abc",
                                "Warn": "abc",
                                "Serious": "abc"
                            }
                        }
                    ]
                },
                "NoticeIds": [
                    "abc"
                ],
                "Notices": [
                    {
                        "Id": "abc",
                        "Name": "abc",
                        "UpdatedAt": "abc",
                        "UpdatedBy": "abc",
                        "NoticeType": "abc",
                        "UserNotices": [
                            {
                                "ReceiverType": "abc",
                                "UserIds": [
                                    0
                                ],
                                "GroupIds": [
                                    0
                                ],
                                "StartTime": 0,
                                "EndTime": 0,
                                "NoticeWay": [
                                    "abc"
                                ],
                                "PhoneOrder": [
                                    0
                                ],
                                "PhoneCircleTimes": 0,
                                "PhoneInnerInterval": 0,
                                "PhoneCircleInterval": 0,
                                "NeedPhoneArriveNotice": 0,
                                "PhoneCallType": "abc",
                                "Weekday": [
                                    0
                                ],
                                "OnCallFormIDs": [
                                    "abc"
                                ]
                            }
                        ],
                        "URLNotices": [
                            {
                                "URL": "abc",
                                "IsValid": 0,
                                "ValidationCode": "abc",
                                "StartTime": 0,
                                "EndTime": 0,
                                "Weekday": [
                                    0
                                ]
                            }
                        ],
                        "IsPreset": 0,
                        "NoticeLanguage": "abc",
                        "PolicyIds": [
                            "abc"
                        ],
                        "AMPConsumerId": "abc",
                        "CLSNotices": [
                            {
                                "Enable": 0,
                                "Region": "abc",
                                "LogSetId": "abc",
                                "TopicId": "abc"
                            }
                        ],
                        "Tags": [
                            {
                                "Key": "abc",
                                "Value": "abc"
                            }
                        ]
                    }
                ],
                "TriggerTasks": [
                    {
                        "Type": "abc",
                        "TaskConfig": "abc"
                    }
                ],
                "ConditionsTemp": {
                    "TemplateName": "abc",
                    "Condition": {
                        "IsUnionRule": 0,
                        "Rules": [
                            {
                                "MetricName": "abc",
                                "Period": 0,
                                "Operator": "abc",
                                "Value": "abc",
                                "ContinuePeriod": 0,
                                "NoticeFrequency": 0,
                                "IsPowerNotice": 0,
                                "Filter": {
                                    "Type": "abc",
                                    "Dimensions": "abc"
                                },
                                "Description": "abc",
                                "Unit": "abc",
                                "RuleType": "abc",
                                "IsAdvanced": 0,
                                "IsOpen": 0,
                                "ProductId": "abc",
                                "ValueMax": 0,
                                "ValueMin": 0,
                                "HierarchicalValue": {
                                    "Remind": "abc",
                                    "Warn": "abc",
                                    "Serious": "abc"
                                }
                            }
                        ],
                        "ComplexExpression": "abc"
                    },
                    "EventCondition": {}
                },
                "LastEditUin": "abc",
                "UpdateTime": 0,
                "InsertTime": 0,
                "Region": [
                    "abc"
                ],
                "NamespaceShowName": "abc",
                "IsDefault": 0,
                "CanSetDefault": 0,
                "InstanceGroupId": 0,
                "InstanceSum": 0,
                "InstanceGroupName": "abc",
                "RuleType": "abc",
                "OriginId": "abc",
                "TagInstances": [
                    {
                        "Key": "abc",
                        "Value": "abc",
                        "InstanceSum": 0,
                        "ServiceType": "abc",
                        "RegionId": 0,
                        "BindingStatus": 0,
                        "TagStatus": 0
                    }
                ],
                "FilterDimensionsParam": "abc",
                "IsOneClick": 0,
                "OneClickStatus": 0,
                "AdvancedMetricNumber": 0,
                "IsBindAll": 0,
                "Tags": [
                    {
                        "Key": "abc",
                        "Value": "abc"
                    }
                ]
            }
        ],
        "RequestId": "abc"
    }
}

Example2 Searching for policies by recipient group

This example shows you how to search for policies by recipient group.

Input Example

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

{
    "Module": "monitor",
    "PageSize": 10,
    "PageNumber": 1
}

Output Example

{
    "Response": {
        "TotalCount": 0,
        "Policies": [
            {
                "PolicyId": "abc",
                "PolicyName": "abc",
                "Remark": "abc",
                "MonitorType": "abc",
                "Enable": 0,
                "UseSum": 0,
                "ProjectId": 0,
                "ProjectName": "abc",
                "Namespace": "abc",
                "ConditionTemplateId": "abc",
                "Condition": {
                    "IsUnionRule": 0,
                    "Rules": [
                        {
                            "MetricName": "abc",
                            "Period": 0,
                            "Operator": "abc",
                            "Value": "abc",
                            "ContinuePeriod": 0,
                            "NoticeFrequency": 0,
                            "IsPowerNotice": 0,
                            "Filter": {
                                "Type": "abc",
                                "Dimensions": "abc"
                            },
                            "Description": "abc",
                            "Unit": "abc",
                            "RuleType": "abc",
                            "IsAdvanced": 0,
                            "IsOpen": 0,
                            "ProductId": "abc",
                            "ValueMax": 0,
                            "ValueMin": 0,
                            "HierarchicalValue": {
                                "Remind": "abc",
                                "Warn": "abc",
                                "Serious": "abc"
                            }
                        }
                    ],
                    "ComplexExpression": "abc"
                },
                "EventCondition": {
                    "Rules": [
                        {
                            "MetricName": "abc",
                            "Period": 0,
                            "Operator": "abc",
                            "Value": "abc",
                            "ContinuePeriod": 0,
                            "NoticeFrequency": 0,
                            "IsPowerNotice": 0,
                            "Filter": {
                                "Type": "abc",
                                "Dimensions": "abc"
                            },
                            "Description": "abc",
                            "Unit": "abc",
                            "RuleType": "abc",
                            "IsAdvanced": 0,
                            "IsOpen": 0,
                            "ProductId": "abc",
                            "ValueMax": 0,
                            "ValueMin": 0,
                            "HierarchicalValue": {
                                "Remind": "abc",
                                "Warn": "abc",
                                "Serious": "abc"
                            }
                        }
                    ]
                },
                "NoticeIds": [
                    "abc"
                ],
                "Notices": [
                    {
                        "Id": "abc",
                        "Name": "abc",
                        "UpdatedAt": "abc",
                        "UpdatedBy": "abc",
                        "NoticeType": "abc",
                        "UserNotices": [
                            {
                                "ReceiverType": "abc",
                                "UserIds": [
                                    0
                                ],
                                "GroupIds": [
                                    0
                                ],
                                "StartTime": 0,
                                "EndTime": 0,
                                "NoticeWay": [
                                    "abc"
                                ],
                                "PhoneOrder": [
                                    0
                                ],
                                "PhoneCircleTimes": 0,
                                "PhoneInnerInterval": 0,
                                "PhoneCircleInterval": 0,
                                "NeedPhoneArriveNotice": 0,
                                "PhoneCallType": "abc",
                                "Weekday": [
                                    0
                                ],
                                "OnCallFormIDs": [
                                    "abc"
                                ]
                            }
                        ],
                        "URLNotices": [
                            {
                                "URL": "abc",
                                "IsValid": 0,
                                "ValidationCode": "abc",
                                "StartTime": 0,
                                "EndTime": 0,
                                "Weekday": [
                                    0
                                ]
                            }
                        ],
                        "IsPreset": 0,
                        "NoticeLanguage": "abc",
                        "PolicyIds": [
                            "abc"
                        ],
                        "AMPConsumerId": "abc",
                        "CLSNotices": [
                            {
                                "Enable": 0,
                                "Region": "abc",
                                "LogSetId": "abc",
                                "TopicId": "abc"
                            }
                        ],
                        "Tags": [
                            {
                                "Key": "abc",
                                "Value": "abc"
                            }
                        ]
                    }
                ],
                "TriggerTasks": [
                    {
                        "Type": "abc",
                        "TaskConfig": "abc"
                    }
                ],
                "ConditionsTemp": {
                    "TemplateName": "abc",
                    "Condition": {
                        "IsUnionRule": 0,
                        "Rules": [
                            {
                                "MetricName": "abc",
                                "Period": 0,
                                "Operator": "abc",
                                "Value": "abc",
                                "ContinuePeriod": 0,
                                "NoticeFrequency": 0,
                                "IsPowerNotice": 0,
                                "Filter": {
                                    "Type": "abc",
                                    "Dimensions": "abc"
                                },
                                "Description": "abc",
                                "Unit": "abc",
                                "RuleType": "abc",
                                "IsAdvanced": 0,
                                "IsOpen": 0,
                                "ProductId": "abc",
                                "ValueMax": 0,
                                "ValueMin": 0,
                                "HierarchicalValue": {
                                    "Remind": "abc",
                                    "Warn": "abc",
                                    "Serious": "abc"
                                }
                            }
                        ],
                        "ComplexExpression": "abc"
                    },
                    "EventCondition": {}
                },
                "LastEditUin": "abc",
                "UpdateTime": 0,
                "InsertTime": 0,
                "Region": [
                    "abc"
                ],
                "NamespaceShowName": "abc",
                "IsDefault": 0,
                "CanSetDefault": 0,
                "InstanceGroupId": 0,
                "InstanceSum": 0,
                "InstanceGroupName": "abc",
                "RuleType": "abc",
                "OriginId": "abc",
                "TagInstances": [
                    {
                        "Key": "abc",
                        "Value": "abc",
                        "InstanceSum": 0,
                        "ServiceType": "abc",
                        "RegionId": 0,
                        "BindingStatus": 0,
                        "TagStatus": 0
                    }
                ],
                "FilterDimensionsParam": "abc",
                "IsOneClick": 0,
                "OneClickStatus": 0,
                "AdvancedMetricNumber": 0,
                "IsBindAll": 0,
                "Tags": [
                    {
                        "Key": "abc",
                        "Value": "abc"
                    }
                ]
            }
        ],
        "RequestId": "abc"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

• Tencent Cloud SDK 3.0 for Python
• Tencent Cloud SDK 3.0 for Java
• Tencent Cloud SDK 3.0 for PHP
• Tencent Cloud SDK 3.0 for Go
• Tencent Cloud SDK 3.0 for NodeJS
• Tencent Cloud SDK 3.0 for .NET
• Tencent Cloud SDK 3.0 for C++

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.