ListAlertStrategyTemplate - ListAlertStrategyTemplate

Overview

ListAlertStrategyTemplate

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `ListAlertStrategyTemplate`.	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. Leave empty for the default project; sub-accounts must fill this in. Please refer to the GetProjectList interface.	Yes
TemplateIDs.N	int	Template id collection, get the alert template list according to the template id	No
Limit	int	The query returns the number of items，default value is 300, maximum value: 300.	No
Offset	int	Data Offset (Default 0)	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
Data	array[ListAlertTemplate]	Alert Template List	No
TotalCount	int	TotalCount	No

Data Model

ListAlertTemplate

Field Name	Type	Description Information	Required
CompanyID	int	company id	No
TemplateID	int	template id	No
Name	string	Template Name	No
ProductType	int	ProductType	No
ProductKey	string	ProductKey	No
RuleSet	array[AlertRule]	RuleSet	No
Remark	string	Remark	No

AlertRule

Field Name	Type	Description Information	Required
RuleID	int	Rule ID	No
MetricID	int	Rule Metric ID. Refer to the list of metrics returned under this type of product GetProductMetrics	No
MetricName	string	Metric Name	No
ThresholdCompare	int	Threshold comparison method. Enumeration value comparison method: 1->= 2-<= 3-> 4-< 5-== 6-!=	No
ThresholdValue	float	Alert Rule ThresholdValue	No
TriggerCount	int	Trigger Count	No
SendPeriodType	string	Trigger Cycle. Enum values: continuous Continuous, exponent Exponential, single Non-repetitive	No
SendInterval	int	Send Interval	No
Level	string	Alarm Level	No
Status	int	Alarm Status(0:off 1on)	No
UnitID	int	Unit ID	No
UnitName	string	Unit Name	No

Example

Request Example


https://api.genesissai.com/?Action=ListAlertStrategyTemplate
&Region=cn-zj
&Zone=cn-zj-01
&ProjectId=WlvKlnLL
&ProjectId=kaGOEwqa
&Filter.TemplateIDs.N=8
&Limit=9
&Offset=7

Response Example


{
  "Action": "ListAlertStrategyTemplateResponse",
  "Data": [
    {
      "CompanyID": 4,
      "Name": "dnJZlrWA",
      "ProductKey": "RwmwuAAp",
      "ProductType": 9,
      "Remark": "tNWQKTXr",
      "RuleSet": [
        {
          "Level": "cQBWjaRy",
          "MetricID": 3,
          "MetricName": "HbmMUMkx",
          "RuleID": 7,
          "SendInterval": 2,
          "SendPeriodType": "rUXdydLC",
          "Status": 3,
          "ThresholdCompare": 1,
          "ThresholdValue": 1.86358,
          "TriggerCount": 8
        }
      ],
      "TemplateID": 9
    }
  ],
  "Message": "uIxKeOnd",
  "RetCode": 0,
  "TotalCount": 6
}