DescribePolicyGroupList

Last updated: 2021-01-11 14:28:14

1. API Description

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

This API is used to get the list of basic policy alarm groups.

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

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 parameter. The value used for this API: DescribePolicyGroupList.
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 The value is fixed to monitor.
Limit Yes Integer Number of parameters that can be returned on each page. Value range: 1 - 100.
Offset Yes Integer Parameter offset on each page. The value starts from 0.
Like No String Search by policy name.
InstanceGroupId No Integer Instance group ID.
UpdateTimeOrder No String Sort by update time. Valid values: asc and desc.
ProjectIds.N No Array of Integer Project ID list.
ViewNames.N No Array of String List of alarm policy types.
FilterUnuseReceiver No Integer Whether to filter policy groups without recipients. The value 1 indicates that policy groups without recipients will be filtered. The value 0 indicates that policy groups without recipients will not be filtered.
Receivers.N No Array of String Filter by recipient group.
ReceiverUserList.N No Array of String Filter by recipient.
Dimensions No String Dimension set field (json string), for example, [[{"name":"unInstanceId","value":"ins-6e4b2aaa"}]].
ConditionTempGroupId No String Template-based policy group IDs, which are separated by commas.
ReceiverType No String Filter by recipient or recipient group. The value 'user' indicates by recipient. The value 'group' indicates by recipient group.
IsOpen No Boolean Filter conditions. Whether the alarm policy has been enabled or disabled

3. Output Parameters

Parameter Name Type Description
GroupList Array of DescribePolicyGroupListGroup Policy group list.
Note: This field may return null, indicating that no valid value was found.
Total Integer Total number of policy groups.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Getting the first two items in basic alarm policy group list

Input Example

https://monitor.tencentcloudapi.com/?Action=DescribePolicyGroupList
&Module=monitor
&Limit=2
&Offset=0
&<Common request parameters>

Output Example

{
  "Response": {
    "GroupList": [
      {
        "CanSetDefault": true,
        "Conditions": [
          {
            "AlarmNotifyPeriod": 86400,
            "AlarmNotifyType": 0,
            "CalcType": 1,
            "CalcValue": "0",
            "ContinueTime": 60,
            "MetricId": 33,
            "MetricShowName": "CPU utilization",
            "Period": 60,
            "RuleId": 1111111,
            "Unit": "%"
          }
        ],
        "ConditionsTemp": null,
        "EventConditions": [
          {
            "AlarmNotifyPeriod": 0,
            "AlarmNotifyType": 0,
            "EventId": 42,
            "EventShowName": "Unreachable by ping",
            "RuleId": 1111112
          }
        ],
        "GroupId": 1111111,
        "GroupName": "Copy-test",
        "InsertTime": 1531122504,
        "InstanceGroup": null,
        "IsDefault": 0,
        "IsOpen": true,
        "LastEditUin": "1500000000",
        "NoShieldedSum": 0,
        "ParentGroupId": 0,
        "ProjectId": 0,
        "ReceiverInfos": [
          {
            "EndTime": 86400,
            "NeedSendNotice": 1,
            "NotifyWay": [
              "EMAIL",
              "SMS"
            ],
            "PersonInterval": 60,
            "ReceiverGroupList": [
              1111
            ],
            "ReceiverType": "group",
            "ReceiverUserList": [],
            "RecoverNotify": [
              "SMS"
            ],
            "RoundInterval": 60,
            "RoundNumber": 2,
            "SendFor": [],
            "StartTime": 0,
            "UidList": null
          }
        ],