1. 接口描述
接口请求域名： monitor.api3.fincloud.tencent.cn。
获取单个告警策略详情
默认接口请求频率限制：20次/秒。
接口更新时间：2022-11-22 16:25:07。
接口既验签名又鉴权。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。
| 参数名称 | 必选 | 允许NULL | 类型 | 描述 |
|---|---|---|---|---|
| Action | 是 | 否 | String | 公共参数，本接口取值：DescribeAlarmPolicy |
| Version | 是 | 否 | String | 公共参数，本接口取值：2018-07-24 |
| Region | 是 | 否 | String | 公共参数，地域信息可通过DescribeRegions接口查看产品支持的地域列表 |
| Module | 是 | 否 | String | 固定值，为"monitor" 示例值： monitor |
| PolicyId | 是 | 否 | String | 告警策略ID 示例值： policy-t1pvz47f |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| Policy | AlarmPolicy | 策略详情 示例值：查看 |
| RequestId | String | 唯一请求 ID，每次请求都会返回。定位问题时需要提供该次请求的 RequestId。 |
4. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。
| 错误码 | 描述 |
|---|---|
| InternalError | 内部错误。 |
| ResourceNotFound | 资源不存在。 |
| FailedOperation | 操作失败。 |
| UnsupportedOperation | 操作不支持。 |
5. 示例
示例1 查询告警策略详情
输入示例
POST / HTTP/1.1
Host: monitor.api3.fincloud.tencent.cn
Content-Type: application/json
X-TC-Action: DescribeAlarmPolicy
<公共请求参数>
{
"Module":"monitor",
"PolicyId":"policy-t1pvz47f"
}
https://monitor.api3.fincloud.tencent.cn/?Action=DescribeAllNamespaces&Module="monitor"&PolicyId="1598976507"&ids="1598976507"&MonitorTypes="1000000"
&<公共请求参数>
输出示例
{
"Response": {
"Policy": {
"PolicyId": "policy-t1pvz47f",
"PolicyName": "云服务器基础监控告警策略",
"UseSum": 1,
"Remark": "",
"MonitorType": "MT_QCE",
"Enable": 1,
"IsDefault": 0,
"ProjectId": 0,
"ProjectName": "默认项目",
"Namespace": "cvm_device",
"ConditionTemplateId": "",
"Condition": {
"IsUnionRule": 0,
"Rules": [
{
"MetricName": "CpuUsage",
"Description": "CPU利用率",
"Unit": "%",
"Period": 60,
"AggregateType": "",
"AggregationDimensions": null,
"Operator": "gt",
"Value": "0",
"ContinuePeriod": 1,
"NoticeFrequency": 86400,
"IsPowerNotice": 0,
"Filter": {
"Type": "",
"Expression": "",
"Dimensions": "[]"
},
"RuleType": ""
}
]
},
"EventCondition": {
"Rules": []
},
"NoticeIds": [
"notice-rwudonte"
],
"Notices": [
{
"Id": "notice-rwudonte",
"Name": "系统预设通知模板",
"UpdatedAt": "2020-12-04 19:22:30",
"UpdatedBy": "1500000686",
"NoticeType": "ALL",
"UserNotices": [
{
"ReceiverType": "USER",
"UserIds": [
1001357
],
"GroupIds": null,
"StartTime": 0,
"EndTime": 86399,
"NoticeWay": [
"SMS",
"EMAIL"
],
"PhoneOrder": null,
"PhoneCircleTimes": 0,
"PhoneInnerInterval": 0,
"PhoneCircleInterval": 0,
"NeedPhoneArriveNotice": 0
}
],
"URLNotices": [],
"IsPreset": 1,
"NoticeLanguage": "zh-CN"
}
],
"TriggerTasks": [],
"OriginId": "1319514",
"ConditionsTemp": {
"ConditionId": 0,
"TemplateName": "",
"Condition": null,
"EventCondition": null
},
"LastEditUin": "1500000686",
"UpdateTime": 1608197675,
"InsertTime": 1608197675,
"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"
],
"NamespaceShowName": "云服务器-基础监控",
"CanSetDefault": 0,
"InstanceGroupId": 6155,
"InstanceGroupName": "mingc_instance",
"InstanceSum": 1,
"RuleType": "STATIC"
},
"RequestId": "546f55d8-80d1-4668-a43e-11490491d62e"
}
}