public class DescribeAlarmPoliciesRequest extends AbstractModel
header, skipSign
Constructor and Description |
---|
DescribeAlarmPoliciesRequest() |
DescribeAlarmPoliciesRequest(DescribeAlarmPoliciesRequest source)
NOTE: Any ambiguous key set via .set("AnyKey", "value") will be a shallow copy,
and any explicit key, i.e Foo, set via .setFoo("value") will be a deep copy.
|
Modifier and Type | Method and Description |
---|---|
String |
getDimensions()
Get 告警对象列表,JSON 字符串。外层数组,对应多个实例,内层为对象的维度。例如“云服务器-基础监控”可写为:
`[ {"Dimensions": {"unInstanceId": "ins-qr8d555g"}}, {"Dimensions": {"unInstanceId": "ins-qr8d555h"}} ]`
具体也可以参考下方的示例 2。
不同云产品参数示例详见 [维度信息Dimensions列表](https://cloud.tencent.com/document/product/248/50397)
注意:如果NeedCorrespondence传入1,即需要返回策略与实例对应关系,请传入不多于20个告警对象维度,否则容易请求超时
|
Long[] |
getEnable()
Get 告警启停筛选,[1]:启用 [0]:停止,全部[0, 1]
|
String |
getField()
Get 排序字段,例如按照最后修改时间排序,Field: "UpdateTime"
|
Long |
getInstanceGroupId()
Get 实例分组id
|
String |
getModule()
Get 固定值,为"monitor"
|
String[] |
getMonitorTypes()
Get 根据监控类型过滤 不选默认查所有类型 "MT_QCE"=云产品监控,当Dimension不为空时,该项为必填项
|
String[] |
getNamespaces()
Get 根据命名空间过滤,不同策略类型的值详见
[策略类型列表](https://cloud.tencent.com/document/product/248/50397)当Dimension不为空时,该项为必填项
|
Long |
getNeedCorrespondence()
Get 是否需要策略与入参过滤维度参数的对应关系,1:是 0:否,默认为0
|
Long |
getNotBindAll()
Get 返回结果过滤掉绑定全部对象的策略,1代表需要过滤,0则无需过滤
|
Long |
getNotBindingNoticeRule()
Get 传 1 查询未配置通知规则的告警策略;不传或传其他数值,查询所有策略。
|
String[] |
getNoticeIds()
Get 通知模板的id列表,可查询通知模板列表获取。
可使用 [查询通知模板列表](https://cloud.tencent.com/document/product/248/51280) 接口查询。
|
Long |
getNotInstanceGroup()
Get 返回结果过滤掉关联实例为实例分组的策略,1代表需要过滤,0则无需过滤
|
String[] |
getOneClickPolicyType()
Get 根据一键告警策略筛选 不传展示全部策略 ONECLICK=展示一键告警策略 NOT_ONECLICK=展示非一键告警策略
|
String |
getOrder()
Get 排序顺序:升序:ASC 降序:DESC
|
Long |
getPageNumber()
Get 页数,从 1 开始计数,默认 1
|
Long |
getPageSize()
Get 每页的数量,取值1~100,默认20
|
String |
getPolicyName()
Get 按策略名称模糊搜索
|
String[] |
getPolicyType()
Get 根据默认策略筛选 不传展示全部策略 DEFAULT=展示默认策略 NOT_DEFAULT=展示非默认策略
|
Long[] |
getProjectIds()
Get 策略所属项目的id数组,可在此页面查看
[项目管理](https://console.cloud.tencent.com/project)
|
String |
getPromInsId()
Get prom实例id,自定义指标策略时会用到
|
Long[] |
getReceiverGroups()
Get 根据接收组搜索,可以使用“访问管理”的 [查询用户组列表 ListGroups](https://cloud.tencent.com/document/product/598/34589) 接口获取用户组列表 或 [列出用户关联的用户组 ListGroupsForUser](https://cloud.tencent.com/document/product/598/34588) 查询某个子用户所在的用户组列表 ,此处填入返回结果中的 `GroupId ` 字段
|
String[] |
getReceiverOnCallFormIDs()
Get 根据排班表搜索
|
Long[] |
getReceiverUids()
Get 根据接收人搜索,可以使用“访问管理”的 [拉取子用户 ListUsers](https://cloud.tencent.com/document/product/598/34587) 接口获取用户列表 或 [查询子用户 GetUser](https://cloud.tencent.com/document/product/598/34590) 接口查询子用户详情,此处填入返回结果中的 `Uid` 字段
|
String[] |
getRuleTypes()
Get 根据触发条件筛选 不传展示全部策略 STATIC=展示静态阈值策略 DYNAMIC=展示动态阈值策略
|
Tag[] |
getTags()
Get 策略根据标签过滤
|
AlarmPolicyTriggerTask[] |
getTriggerTasks()
Get 按照触发任务(例如弹性伸缩)过滤策略。最多10个
|
void |
setDimensions(String Dimensions)
Set 告警对象列表,JSON 字符串。外层数组,对应多个实例,内层为对象的维度。例如“云服务器-基础监控”可写为:
`[ {"Dimensions": {"unInstanceId": "ins-qr8d555g"}}, {"Dimensions": {"unInstanceId": "ins-qr8d555h"}} ]`
具体也可以参考下方的示例 2。
不同云产品参数示例详见 [维度信息Dimensions列表](https://cloud.tencent.com/document/product/248/50397)
注意:如果NeedCorrespondence传入1,即需要返回策略与实例对应关系,请传入不多于20个告警对象维度,否则容易请求超时
|
void |
setEnable(Long[] Enable)
Set 告警启停筛选,[1]:启用 [0]:停止,全部[0, 1]
|
void |
setField(String Field)
Set 排序字段,例如按照最后修改时间排序,Field: "UpdateTime"
|
void |
setInstanceGroupId(Long InstanceGroupId)
Set 实例分组id
|
void |
setModule(String Module)
Set 固定值,为"monitor"
|
void |
setMonitorTypes(String[] MonitorTypes)
Set 根据监控类型过滤 不选默认查所有类型 "MT_QCE"=云产品监控,当Dimension不为空时,该项为必填项
|
void |
setNamespaces(String[] Namespaces)
Set 根据命名空间过滤,不同策略类型的值详见
[策略类型列表](https://cloud.tencent.com/document/product/248/50397)当Dimension不为空时,该项为必填项
|
void |
setNeedCorrespondence(Long NeedCorrespondence)
Set 是否需要策略与入参过滤维度参数的对应关系,1:是 0:否,默认为0
|
void |
setNotBindAll(Long NotBindAll)
Set 返回结果过滤掉绑定全部对象的策略,1代表需要过滤,0则无需过滤
|
void |
setNotBindingNoticeRule(Long NotBindingNoticeRule)
Set 传 1 查询未配置通知规则的告警策略;不传或传其他数值,查询所有策略。
|
void |
setNoticeIds(String[] NoticeIds)
Set 通知模板的id列表,可查询通知模板列表获取。
可使用 [查询通知模板列表](https://cloud.tencent.com/document/product/248/51280) 接口查询。
|
void |
setNotInstanceGroup(Long NotInstanceGroup)
Set 返回结果过滤掉关联实例为实例分组的策略,1代表需要过滤,0则无需过滤
|
void |
setOneClickPolicyType(String[] OneClickPolicyType)
Set 根据一键告警策略筛选 不传展示全部策略 ONECLICK=展示一键告警策略 NOT_ONECLICK=展示非一键告警策略
|
void |
setOrder(String Order)
Set 排序顺序:升序:ASC 降序:DESC
|
void |
setPageNumber(Long PageNumber)
Set 页数,从 1 开始计数,默认 1
|
void |
setPageSize(Long PageSize)
Set 每页的数量,取值1~100,默认20
|
void |
setPolicyName(String PolicyName)
Set 按策略名称模糊搜索
|
void |
setPolicyType(String[] PolicyType)
Set 根据默认策略筛选 不传展示全部策略 DEFAULT=展示默认策略 NOT_DEFAULT=展示非默认策略
|
void |
setProjectIds(Long[] ProjectIds)
Set 策略所属项目的id数组,可在此页面查看
[项目管理](https://console.cloud.tencent.com/project)
|
void |
setPromInsId(String PromInsId)
Set prom实例id,自定义指标策略时会用到
|
void |
setReceiverGroups(Long[] ReceiverGroups)
Set 根据接收组搜索,可以使用“访问管理”的 [查询用户组列表 ListGroups](https://cloud.tencent.com/document/product/598/34589) 接口获取用户组列表 或 [列出用户关联的用户组 ListGroupsForUser](https://cloud.tencent.com/document/product/598/34588) 查询某个子用户所在的用户组列表 ,此处填入返回结果中的 `GroupId ` 字段
|
void |
setReceiverOnCallFormIDs(String[] ReceiverOnCallFormIDs)
Set 根据排班表搜索
|
void |
setReceiverUids(Long[] ReceiverUids)
Set 根据接收人搜索,可以使用“访问管理”的 [拉取子用户 ListUsers](https://cloud.tencent.com/document/product/598/34587) 接口获取用户列表 或 [查询子用户 GetUser](https://cloud.tencent.com/document/product/598/34590) 接口查询子用户详情,此处填入返回结果中的 `Uid` 字段
|
void |
setRuleTypes(String[] RuleTypes)
Set 根据触发条件筛选 不传展示全部策略 STATIC=展示静态阈值策略 DYNAMIC=展示动态阈值策略
|
void |
setTags(Tag[] Tags)
Set 策略根据标签过滤
|
void |
setTriggerTasks(AlarmPolicyTriggerTask[] TriggerTasks)
Set 按照触发任务(例如弹性伸缩)过滤策略。最多10个
|
void |
toMap(HashMap<String,String> map,
String prefix)
Internal implementation, normal users should not use it.
|
any, fromJsonString, getBinaryParams, GetHeader, getMultipartRequestParams, getSkipSign, isStream, set, SetHeader, setParamArrayObj, setParamArraySimple, setParamObj, setParamSimple, setSkipSign, toJsonString
public DescribeAlarmPoliciesRequest()
public DescribeAlarmPoliciesRequest(DescribeAlarmPoliciesRequest source)
public String getModule()
public void setModule(String Module)
Module
- 固定值,为"monitor"public Long getPageNumber()
public void setPageNumber(Long PageNumber)
PageNumber
- 页数,从 1 开始计数,默认 1public Long getPageSize()
public void setPageSize(Long PageSize)
PageSize
- 每页的数量,取值1~100,默认20public String getPolicyName()
public void setPolicyName(String PolicyName)
PolicyName
- 按策略名称模糊搜索public String[] getMonitorTypes()
public void setMonitorTypes(String[] MonitorTypes)
MonitorTypes
- 根据监控类型过滤 不选默认查所有类型 "MT_QCE"=云产品监控,当Dimension不为空时,该项为必填项public String[] getNamespaces()
public void setNamespaces(String[] Namespaces)
Namespaces
- 根据命名空间过滤,不同策略类型的值详见
[策略类型列表](https://cloud.tencent.com/document/product/248/50397)当Dimension不为空时,该项为必填项public String getDimensions()
public void setDimensions(String Dimensions)
Dimensions
- 告警对象列表,JSON 字符串。外层数组,对应多个实例,内层为对象的维度。例如“云服务器-基础监控”可写为:
`[ {"Dimensions": {"unInstanceId": "ins-qr8d555g"}}, {"Dimensions": {"unInstanceId": "ins-qr8d555h"}} ]`
具体也可以参考下方的示例 2。
不同云产品参数示例详见 [维度信息Dimensions列表](https://cloud.tencent.com/document/product/248/50397)
注意:如果NeedCorrespondence传入1,即需要返回策略与实例对应关系,请传入不多于20个告警对象维度,否则容易请求超时public Long[] getReceiverUids()
public void setReceiverUids(Long[] ReceiverUids)
ReceiverUids
- 根据接收人搜索,可以使用“访问管理”的 [拉取子用户 ListUsers](https://cloud.tencent.com/document/product/598/34587) 接口获取用户列表 或 [查询子用户 GetUser](https://cloud.tencent.com/document/product/598/34590) 接口查询子用户详情,此处填入返回结果中的 `Uid` 字段public Long[] getReceiverGroups()
public void setReceiverGroups(Long[] ReceiverGroups)
ReceiverGroups
- 根据接收组搜索,可以使用“访问管理”的 [查询用户组列表 ListGroups](https://cloud.tencent.com/document/product/598/34589) 接口获取用户组列表 或 [列出用户关联的用户组 ListGroupsForUser](https://cloud.tencent.com/document/product/598/34588) 查询某个子用户所在的用户组列表 ,此处填入返回结果中的 `GroupId ` 字段public String[] getPolicyType()
public void setPolicyType(String[] PolicyType)
PolicyType
- 根据默认策略筛选 不传展示全部策略 DEFAULT=展示默认策略 NOT_DEFAULT=展示非默认策略public String getField()
public void setField(String Field)
Field
- 排序字段,例如按照最后修改时间排序,Field: "UpdateTime"public String getOrder()
public void setOrder(String Order)
Order
- 排序顺序:升序:ASC 降序:DESCpublic Long[] getProjectIds()
public void setProjectIds(Long[] ProjectIds)
ProjectIds
- 策略所属项目的id数组,可在此页面查看
[项目管理](https://console.cloud.tencent.com/project)public String[] getNoticeIds()
public void setNoticeIds(String[] NoticeIds)
NoticeIds
- 通知模板的id列表,可查询通知模板列表获取。
可使用 [查询通知模板列表](https://cloud.tencent.com/document/product/248/51280) 接口查询。public String[] getRuleTypes()
public void setRuleTypes(String[] RuleTypes)
RuleTypes
- 根据触发条件筛选 不传展示全部策略 STATIC=展示静态阈值策略 DYNAMIC=展示动态阈值策略public Long[] getEnable()
public void setEnable(Long[] Enable)
Enable
- 告警启停筛选,[1]:启用 [0]:停止,全部[0, 1]public Long getNotBindingNoticeRule()
public void setNotBindingNoticeRule(Long NotBindingNoticeRule)
NotBindingNoticeRule
- 传 1 查询未配置通知规则的告警策略;不传或传其他数值,查询所有策略。public Long getInstanceGroupId()
public void setInstanceGroupId(Long InstanceGroupId)
InstanceGroupId
- 实例分组idpublic Long getNeedCorrespondence()
public void setNeedCorrespondence(Long NeedCorrespondence)
NeedCorrespondence
- 是否需要策略与入参过滤维度参数的对应关系,1:是 0:否,默认为0public AlarmPolicyTriggerTask[] getTriggerTasks()
public void setTriggerTasks(AlarmPolicyTriggerTask[] TriggerTasks)
TriggerTasks
- 按照触发任务(例如弹性伸缩)过滤策略。最多10个public String[] getOneClickPolicyType()
public void setOneClickPolicyType(String[] OneClickPolicyType)
OneClickPolicyType
- 根据一键告警策略筛选 不传展示全部策略 ONECLICK=展示一键告警策略 NOT_ONECLICK=展示非一键告警策略public Long getNotBindAll()
public void setNotBindAll(Long NotBindAll)
NotBindAll
- 返回结果过滤掉绑定全部对象的策略,1代表需要过滤,0则无需过滤public Long getNotInstanceGroup()
public void setNotInstanceGroup(Long NotInstanceGroup)
NotInstanceGroup
- 返回结果过滤掉关联实例为实例分组的策略,1代表需要过滤,0则无需过滤public Tag[] getTags()
public void setTags(Tag[] Tags)
Tags
- 策略根据标签过滤public String getPromInsId()
public void setPromInsId(String PromInsId)
PromInsId
- prom实例id,自定义指标策略时会用到public String[] getReceiverOnCallFormIDs()
public void setReceiverOnCallFormIDs(String[] ReceiverOnCallFormIDs)
ReceiverOnCallFormIDs
- 根据排班表搜索Copyright © 2024. All rights reserved.