修改UPath监控告警项 - ModifyUPathTemplate

简介

修改UPath监控告警项

💡 不同告警指标的参数单位不一样;参数值后的n可以替换为不同的整数，整数值相同的参数组成一条告警指标

定义

公共参数

参数名	类型	描述信息	必填
Action	string	对应的 API 指令名称，当前 API 为 `ModifyUPathTemplate`	Yes
PublicKey	string	用户公钥，可从控制台获取	Yes
Signature	string	根据公钥及 API 指令生成的用户签名，参见签名算法	Yes

请求参数

参数名	类型	描述信息	必填
ProjectId	string	项目ID。请参考GetProjectList接口	Yes
UPathId	string	加速线路实例ID	Yes
MetricName.N	string	告警指标名称, 所有n的个数必须一致。目前仅允许以下四项：UpathNetworkOut:出向带宽，UpathNetworkIn:入向带宽，UpathNetworkOutUsage:出向带宽使用率，UpathNetworkInUsage:入向带宽使用率	No
Threshold.N	int	告警阈值，带宽使用率的阈值范围是[50,100]的正整数，带宽告警阈值为1000000的倍数, 如大于2Mbps则告警阈值应该传 2000000	No
AlarmFrequency.N	int	告警探测周期，单位：秒	No
ContactGroupId.N	int	告警组id	No
Compare.N	string	比较策略，可选 [‘GE’,‘LE’] 分别代表不小于和不大于	No
AlarmStrategy.N	string	收敛策略，可选范围 [‘Exponential’,‘Continuous’,‘Once’]，分别对应指数递增、连续告警、单次告警	No
TriggerCount.N	int	告警触发周期（次数）	No

响应字段

字段名	类型	描述信息	必填
RetCode	int	返回状态码，为 0 则为成功返回，非 0 为失败	Yes
Action	string	操作指令名称	Yes
Message	string	返回错误消息，当 `RetCode` 非 0 时提供详细的描述信息	No

示例

请求示例


https://api.an-link.com/?Action=ModifyUPathTemplate
&ProjectId=org-xxxx
&AlarmStrategy.n=Continuous
&Threshold.n=10000000
&Compare.n=GE
&TriggerCount.n=3
&AlarmFrequency.n=60
&UPathId=upath-xxxx
&MetricName.n=UpathNetworkIn
&ContactGroupId.n=111

响应示例


{
  "Action": "ModifyUPathTemplateResponse",
  "RetCode": 0
}