DescribePolicyGroupInfo

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

1. API Description

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

This API is used to get details of a basic policy group.

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: DescribePolicyGroupInfo.
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.
GroupId Yes Integer Policy group ID.

3. Output Parameters

Parameter Name Type Description
GroupName String Policy group name.
ProjectId Integer ID of the project to which the policy group belongs.
IsDefault Integer Whether it is the default policy. The value 0 indicates that it is not the default policy. The value 1 indicates that it is the default policy.
ViewName String Policy type.
Remark String Policy description
ShowName String Policy type name.
LastEditUin String Uin that was last edited.
UpdateTime String Last edited time.
Region Array of String Regions supported by this policy.
DimensionGroup Array of String List of policy type dimensions.
ConditionsConfig Array of DescribePolicyGroupInfoCondition Threshold rule list.
Note: This field may return null, indicating that no valid value was found.
EventConfig Array of DescribePolicyGroupInfoEventCondition Product event rule list.
Note: This field may return null, indicating that no valid value was found.
ReceiverInfos Array of DescribePolicyGroupInfoReceiverInfo Recipient list.
Note: This field may return null, indicating that no valid value was found.
Callback DescribePolicyGroupInfoCallback User callback information.
Note: This field may return null, indicating that no valid value was found.
ConditionsTemp DescribePolicyGroupInfoConditionTpl Template-based policy group.
Note: This field may return null, indicating that no valid value was found.
CanSetDefault Boolean Whether the policy can be configured as the default policy.
IsUnionRule Integer Whether the 'AND' rule is used.
Note: This field may return null, indicating that no valid value was found.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying policy group information

Input Example

https://monitor.tencentcloudapi.com/?Action=DescribePolicyGroupInfo
&Module=monitor
&GroupId=11111
&<Common request parameters>

Output Example

{
  "Response": {
    "Callback": null,
    "CanSetDefault": true,
    "ConditionsConfig": [
      {
        "AlarmNotifyPeriod": 86400,
        "AlarmNotifyType": 0,
        "CalcType": 1,
        "CalcValue": "0",
        "ContinueTime": 60,
        "MetricId": 33,
        "MetricShowName": "CPU utilization",
        "Period": 60,
        "RuleId": 200000,
        "Unit": "%"
      }
    ],
    "ConditionsTemp": null,
    "DimensionGroup": [
      "unInstanceId"
    ],
    "EventConfig": [
      {
        "AlarmNotifyPeriod": 86400,
        "AlarmNotifyType": 0,
        "EventId": 42,
        "EventShowName": "Unreachable by ping",
        "RuleId": 200001
      }
    ],
    "GroupName": "Policy group name test",
    "IsDefault": 0,
    "LastEditUin": "1500000000",
    "ProjectId": 0,
    "ReceiverInfos": null,
    "Region": [
      "bj",
      "ca",
      "cd",
      "de",
      "gz",
      "gzopen",
      "hk",
      "hzec",
      "jnec",
      "jp",
      "kr",
      "nj",
      "sg",
      "sh",
      "shjr",
      "tsn",
      "usw"
    ],
    "Remark": "",
    "RequestId": "11111111-1111-1111-1111-111111111111",
    "ShowName": "CVM - basic monitoring",
    "UpdateTime": "2018-07-09 15:56:55",
    "ViewName": "cvm_device"
  }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integra