Domain name for API request: monitor.tencentcloudapi.com.
This API is used to get the details of a single alarm policy.
A maximum of 20 requests can be initiated per second for this API.
Note: This API supports Finance regions. If the common parameter Region is a Finance region, a domain name with the Finance region needs to be specified, for example: monitor.ap-shanghai-fsi.tencentcloudapi.com
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 parameter. The value used for this API: DescribeAlarmPolicy. |
| Version | Yes | String | Common parameter. The value used for this API: 2018-07-24. |
| Region | Yes | String | Common parameter. For more information, please see the list of regions supported by the product. |
| Module | Yes | String | Value fixed at "monitor" |
| PolicyId | Yes | String | Alarm policy ID |
| Parameter Name | Type | Description |
|---|---|---|
| Policy | AlarmPolicy | Policy details |
| RequestId | String | The unique request ID, which is returned for each request. RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: monitor.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeAlarmPolicy
<Common request parameters>
{
"Module": "monitor",
"PolicyId": "policy-t1pvz47f"
}
{
"Response": {
"Policy": {
"PolicyId": "policy-t1pvz47f",
"PolicyName": "Alarm policy for CVM basic monitoring",
"UseSum": 1,
"Remark": "",
"MonitorType": "MT_QCE",
"Enable": 1,
"IsDefault": 0,
"ProjectId": 0,
"ProjectName": "Default project",
"Namespace": "cvm_device",
"ConditionTemplateId": "",
"Condition": {
"IsUnionRule": 0,
"Rules": [
{
"MetricName": "CpuUsage",
"Description": "CPU utilization",
"Unit": "%",
"Period": 60,
"Operator": "gt",
"Value": "0",
"ContinuePeriod": 1,
"NoticeFrequency": 86400,
"IsPowerNotice": 0,
"Filter": {
"Type": "",
"Dimensions": "[]"
},
"RuleType": ""
}
]
},
"EventCondition": {
"Rules": []
},
"NoticeIds": [
"notice-rwudonte"
],
"Notices": [
{
"Id": "notice-rwudonte",
"Name": "System default notification template",
"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": {
"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": "CVM - basic monitoring",
"CanSetDefault": 0,
"InstanceGroupId": 6155,
"InstanceGroupName": "mingc_instance",
"InstanceSum": 1,
"RuleType": "STATIC"
},
"RequestId": "546f55d8-80d1-4668-a43e-11490491d62e"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation | Operation failed. |
| InternalError | Internal error. |
| ResourceNotFound | The resource is not found. |
| UnsupportedOperation | Unsupported operation. |
Was this page helpful?