Modify UPath Monitoring Alert Items - ModifyUPathTemplate

Overview

Modify UPath Monitoring Alert Items

💡 Different alarm indicators have different parameter units; the ‘n’ after the parameter value can be replaced with different integers, and parameters with the same integer value form an alarm indicator.

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `ModifyUPathTemplate`.	Yes
PublicKey	string	The user’s public key can be obtained from Console	Yes
Signature	string	User signature generated based on public key and API command, see Signature Algorithm	Yes

Request Parameters

Parameter Name	Type	Description Information	Required
ProjectId	string	Project ID. Please refer to the GetProjectList interface.	Yes
UPathId	string	Acceleration Line Instance ID	Yes
MetricName.N	string	Alarm Metric Name, all ‘n’ counts must be consistent. Currently, only the following four items are allowed: UpathNetworkOut: Outbound Bandwidth, UpathNetworkIn: Inbound Bandwidth, UpathNetworkOutUsage: Outbound Bandwidth Usage, UpathNetworkInUsage: Inbound Bandwidth Usage.	No
Threshold.N	int	Alarm threshold, the threshold range for bandwidth usage is an integer between [50,100], the bandwidth alarm threshold is a multiple of 1000000, for example, if it exceeds 2Mbps, the alarm threshold should be set to 2000000.	No
AlarmFrequency.N	int	Alarm detection cycle, unit: seconds	No
ContactGroupId.N	int	Alert Group ID	No
Compare.N	string	Comparison strategy, optional [‘GE’,‘LE’] respectively represent not less than and not greater than	No
AlarmStrategy.N	string	Convergence Strategy, optional range [‘Exponential’,‘Continuous’,‘Once’], corresponding to Exponential Increase, Continuous Alert, Single Alert respectively.	No
TriggerCount.N	int	Alarm Trigger Cycle (Times)	No

Response Field

Field Name	Type	Description Information	Required
RetCode	int	Return status code. If it is 0, it means successful return. If it is not 0, it means failure.	Yes
Action	string	Operation command name.	Yes
Message	string	Returns an error message, providing detailed description when `RetCode` is non-zero.	No

Example

Request Example

https://api.dezai.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

Response Example

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

ModifyUPathBandwidth UGABindUPath