有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

接口请求域名: monitor.tencentcloudapi.com 。

获取单个告警策略详情

默认接口请求频率限制:60次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeAlarmPolicy。
Version String 公共参数,本接口取值:2018-07-24。
Region String 公共参数,详见产品支持的 地域列表
Module String 固定值,为"monitor"
示例值:monitor
PolicyId String 告警策略ID
示例值:policy-t1pvz47f

3. 输出参数

参数名称 类型 描述
Policy AlarmPolicy 策略详情
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询告警策略详情

输入示例

POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAlarmPolicy
<公共请求参数>

{
    "Module": "monitor",
    "PolicyId": "policy-t1pvz47f"
}

输出示例

{
    "Response": {
        "Policy": {
            "NamespaceShowName": "xx",
            "LastEditUin": "xx",
            "Namespace": "xx",
            "InstanceGroupName": "xx",
            "AdvancedMetricNumber": 0,
            "Notices": [
                {
                    "AMPConsumerId": "xx",
                    "URLNotices": [
                        {
                            "ValidationCode": "xx",
                            "URL": "xx",
                            "IsValid": 0,
                            "Weekday": [
                                0
                            ],
                            "StartTime": 0,
                            "EndTime": 0
                        }
                    ],
                    "Name": "xx",
                    "NoticeType": "xx",
                    "CLSNotices": [
                        {
                            "TopicId": "xx",
                            "Region": "xx",
                            "Enable": 0,
                            "LogSetId": "xx"
                        }
                    ],
                    "UpdatedBy": "xx",
                    "PolicyIds": [
                        "xx"
                    ],
                    "UserNotices": [
                        {
                            "NoticeWay": [
                                "SMS",
                                "EMAIL"
                            ],
                            "NeedPhoneArriveNotice": 0,
                            "PhoneOrder": [
                                0
                            ],
                            "PhoneCallType": "xx",
                            "UserIds": [
                                1001357
                            ],
                            "ReceiverType": "xx",
                            "PhoneCircleInterval": 0,
                            "GroupIds": [
                                0
                            ],
                            "StartTime": 0,
                            "PhoneCircleTimes": 0,
                            "EndTime": 86399,
                            "PhoneInnerInterval": 0,
                            "Weekday": [
                                0
                            ]
                        }
                    ],
                    "IsPreset": 1,
                    "UpdatedAt": "xx",
                    "NoticeLanguage": "xx",
                    "Id": "xx"
                }
            ],
            "TriggerTasks": [
                {
                    "Type": "xx",
                    "TaskConfig": "xx"
                }
            ],
            "ConditionTemplateId": "xx",
            "UpdateTime": 1608197675,
            "Enable": 1,
            "TagInstances": [
                {
                    "ServiceType": "xx",
                    "RegionId": 0,
                    "Value": "xx",
                    "InstanceSum": 0,
                    "Key": "xx",
                    "BindingStatus": 0,
                    "TagStatus": 0
                }
            ],
            "GroupBy": [
                {
                    "Id": "xx",
                    "Name": "xx"
                }
            ],
            "Condition": {
                "IsUnionRule": 0,
                "Rules": [
                    {
                        "NoticeFrequency": 86400,
                        "RuleType": "xx",
                        "IsAdvanced": 0,
                        "Description": "xx",
                        "IsOpen": 0,
                        "Period": 60,
                        "Value": "xx",
                        "Filter": {
                            "Type": "xx",
                            "Dimensions": "xx"
                        },
                        "IsPowerNotice": 0,
                        "ContinuePeriod": 1,
                        "Operator": "xx",
                        "ProductId": "xx",
                        "Unit": "xx",
                        "MetricName": "xx"
                    }
                ]
            },
            "PolicyName": "xx",
            "Remark": "xx",
            "ConditionsTemp": {
                "EventCondition": {
                    "Rules": [
                        {
                            "NoticeFrequency": 0,
                            "RuleType": "xx",
                            "IsAdvanced": 0,
                            "Description": "xx",
                            "IsOpen": 0,
                            "Period": 0,
                            "Value": "xx",
                            "Filter": {
                                "Type": "xx",
                                "Dimensions": "xx"
                            },
                            "IsPowerNotice": 0,
                            "ContinuePeriod": 0,
                            "Operator": "xx",
                            "ProductId": "xx",
                            "Unit": "xx",
                            "MetricName": "xx"
                        }
                    ]
                },
                "Condition": {
                    "IsUnionRule": 0
                },
                "TemplateName": "xx"
            },
            "ProjectId": 0,
            "Region": [
                "bj",
                "ca",
                "cd",
                "cgoec",
                "cq",
                "de",
                "fzec",
                "gz",
                "gzopen",
                "hfeec",
                "hk",
                "hzec",
                "in",
                "jnec",
                "jp",
                "kr",
                "nj",
                "ru",
                "sg",
                "sh",
                "sheec",
                "shjr",
                "szjr",
                "szx",
                "th",
                "tpe",
                "tsn",
                "use",
                "usw",
                "xbec",
                "xiyec"
            ],
            "FilterDimensionsParam": "xx",
            "Filter": {
                "Expression": "xx",
                "Type": "xx",
                "Dimensions": "xx"
            },
            "EventCondition": {
                "Rules": [
                    {
                        "NoticeFrequency": 0,
                        "RuleType": "xx",
                        "IsAdvanced": 0,
                        "Description": "xx",
                        "IsOpen": 0,
                        "Period": 0,
                        "Value": "xx",
                        "Filter": {
                            "Type": "xx",
                            "Dimensions": "xx"
                        },
                        "IsPowerNotice": 0,
                        "ContinuePeriod": 0,
                        "Operator": "xx",
                        "ProductId": "xx",
                        "Unit": "xx",
                        "MetricName": "xx"
                    }
                ]
            },
            "InsertTime": 1608197675,
            "InstanceGroupId": 6155,
            "NoticeIds": [
                "notice-rwudonte"
            ],
            "OriginId": "xx",
            "IsDefault": 0,
            "PolicyId": "xx",
            "UseSum": 1,
            "InstanceSum": 1,
            "ProjectName": "xx",
            "RuleType": "xx",
            "OneClickStatus": 0,
            "IsOneClick": 0,
            "CanSetDefault": 0,
            "MonitorType": "xx"
        },
        "RequestId": "xx"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation 操作失败。
FailedOperation.DoHTTPTransferFailed 后端服务超时
InternalError 内部错误。
ResourceNotFound 资源不存在。
UnsupportedOperation 操作不支持。