查询UPath的监控模板-DescribeUPathTemplate

查询UPath的监控模板

Request Parameters

Parameter nameTypeDescriptionRequired
ProjectIdstring项目ID。请参考GetProjectList接口Yes
UPathIdstring加速线路实例ID,格式 upath-xxxxYes

Response Elements

Parameter nameTypeDescriptionRequired
RetCodeint操作返回码Yes
Actionstring操作名称Yes
DataSetarray监控模板详情Yes

AlarmRuler

Parameter nameTypeDescriptionRequired
AlarmStrategystring收敛策略,可选范围 ['Exponential','Continuous','Once'],分别对应指数递增、连续告警、单次告警Yes
AlarmFrequencyint告警探测周期,单位秒Yes
Comparestring比较策略,可选 ['GE','LE'] 分别代表不小于和不大于Yes
ContactGroupIdint联系组IDYes
MetricNamestring告警指标名称, 所有n的个数必须一致。目前仅允许以下四项:UpathNetworkOut:出向带宽,UpathNetworkIn:入向带宽,UpathNetworkOutUsage:出向带宽使用率,UpathNetworkInUsage:入向带宽使用率Yes
Thresholdint告警阈值,带宽使用率的阈值范围是[50,100]的正整数,带宽告警阈值为1000000的倍数, 如大于2Mbps则告警 阈值应该传 2000000Yes
TriggerCountint告警触发周期(次数)Yes
AlarmTemplateRuleIdstring告警模板策略IDYes
ResourceTypestring资源类型No

Request Example

https://api.ucloud.cn/?Action=DescribeUPathTemplate
&ProjectId=org-xxxx
&UPathId=upath-xxxx

Response Example

{
    "Action": "DescribeUPathTemplateResponse",
    "RetCode": 0,
    "Message": "",
    "DataSet": [
        {
            "MetricName": "UpathNetworkIn",
            "Threshold": 10000000,
            "AlarmFrequency": 0,
            "ContactGroupId": 106696,
            "Compare": "GE",
            "AlarmStrategy": "Exponential",
            "TriggerCount": 3,
            "ResourceType": "upath",
            "AlarmTemplateRuleId": 19733
        },
        {
            "MetricName": "UpathNetworkOut",
            "Threshold": 10000000,
            "AlarmFrequency": 0,
            "ContactGroupId": 106696,
            "Compare": "GE",
            "AlarmStrategy": "Exponential",
            "TriggerCount": 3,
            "ResourceType": "upath",
            "AlarmTemplateRuleId": 19734
        }
    ]
}