Query the monitoring template of UPath - DescribeUPathTemplate

Overview

Query the monitoring template of UPath

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `DescribeUPathTemplate`.	Yes
PublicKey	string	The user's public key can be obtained from Console (opens in a new tab)	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, format upath-xxxx	Yes

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
DataSet	array[AlarmRuler]	Monitoring Template Details	Yes

Data Model

AlarmRuler

Field Name	Type	Description Information	Required
AlarmStrategy	string	Convergence Strategy, optional range ['Exponential','Continuous','Once'], corresponding to Exponential Increase, Continuous Alert, Single Alert respectively.	Yes
AlarmFrequency	int	Alarm detection cycle, in seconds	Yes
Compare	string	Comparison strategy, optional ['GE','LE'] respectively represent not less than and not greater than	Yes
ContactGroupId	int	Contact Group ID	Yes
MetricName	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.	Yes
Threshold	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.	Yes
TriggerCount	int	Alarm Trigger Cycle (Times)	Yes
AlarmTemplateRuleId	int	Alarm Template Strategy ID	Yes
ResourceType	string	Resource Type	No

Example

Request Example

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

Response Example

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

DescribeUPath GetGlobalSSHPrice