Get Alert Template List - GetAlarmTemplateList

Overview

Get Alert Template List

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `GetAlarmTemplateList`.	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
Region	string	Region. See List of Regions and Availability Zones	Yes
ProjectId	string	Project ID. If not filled in, the default project will be used. Sub-accounts must fill in. Please refer to the GetProjectList interface.	No
Limit	int	Return data length, default is 20	No
Offset	int	List start position offset, default is 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
TotalCount	int	Total Quantity	Yes
DataSet	array[AlarmTemplate]	Alarm Template List	Yes

Data Model

AlarmTemplate

Field Name	Type	Description Information	Required
AlarmTemplateId	int	Alarm Template ID	Yes
AlarmTemplateName	string	Alarm Template Name	Yes
ResourceType	string	Resource Type	Yes
BoundResourceCount	int	Number of Bound Resources	Yes
IsGlobal	int	Is it a global data center template, 0 is not, 1 is	Yes
IsDefault	string	Is it the default template?	No
Remark	string	Note	No

Example

Request Example

https://api.surfercloud.com/?Action=GetAlarmTemplateList
&Region=DGdSoave
&ProjectId=EzXfGltN
&Limit=UjSBCcay
&Offset=tMJXiqNF
&ResourceType=YsEmOUYC

Response Example

{
  "Action": "GetAlarmTemplateListResponse",
  "DataSet": [
    {
      "AlarmTemplateId": 1,
      "AlarmTemplateName": "THwnZpbV",
      "BoundResourceCount": 8,
      "IsDefault": "Yes",
      "Remark": "pJavCcAz",
      "ResourceType": "UaCrdVJM"
    },
    {
      "AlarmTemplateId": 9,
      "AlarmTemplateName": "nDCuUndt",
      "BoundResourceCount": 2,
      "IsDefault": "Yes",
      "Remark": "zhMGrkaK",
      "ResourceType": "KPJLDerL"
    },
    {
      "AlarmTemplateId": 4,
      "AlarmTemplateName": "ZRHjuLLX",
      "BoundResourceCount": 4,
      "IsDefault": "Yes",
      "Remark": "wpGNxXwu",
      "ResourceType": "tzJzMuuz"
    },
    {
      "AlarmTemplateId": 4,
      "AlarmTemplateName": "zbiIKPnV",
      "BoundResourceCount": 6,
      "IsDefault": "Yes",
      "Remark": "sIHLdiXA",
      "ResourceType": "kduqaLUb"
    },
    {
      "AlarmTemplateId": 6,
      "AlarmTemplateName": "DBMweHYH",
      "BoundResourceCount": 8,
      "IsDefault": "Yes",
      "Remark": "YJqRXyiC",
      "ResourceType": "zfqEzXCT"
    },
    {
      "AlarmTemplateId": 6,
      "AlarmTemplateName": "zDtcJJXm",
      "BoundResourceCount": 1,
      "IsDefault": "Yes",
      "Remark": "DsZQaLGz",
      "ResourceType": "rKvQzdmV"
    },
    {
      "AlarmTemplateId": 3,
      "AlarmTemplateName": "PHdOzEwQ",
      "BoundResourceCount": 9,
      "IsDefault": "Yes",
      "Remark": "bXJvUkBz",
      "ResourceType": "JXXAlxSz"
    },
    {
      "AlarmTemplateId": 6,
      "AlarmTemplateName": "AnQVcuMA",
      "BoundResourceCount": 9,
      "IsDefault": "Yes",
      "Remark": "oNaALals",
      "ResourceType": "OFddPTcu"
    }
  ],
  "RetCode": 0,
  "TotalCount": 4
}

GetAlarmRecordList GetMetric