Retrieve Alert Record List - GetAlarmRecordList

Overview

Retrieve Alert Record List

Definition

Public Parameters

Parameter Name	Type	Description Information	Required
Action	string	Corresponding API command name, the current API is `GetAlarmRecordList`.	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. If not filled in, the default project is used, sub-accounts must be filled in. Please refer to the GetProjectList interface.	No
BeginTime	int	Start Time, Timestamp	No
EndTime	int	End time, timestamp (currently only supports retrieving alarm records within a 31-day interval)	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
DataSet	array[AlarmRecord]	Alarm Record List	Yes

Data Model

AlarmRecord

Field Name	Type	Description Information	Required
Region	string	Region ID	No
Zone	string	Availability Zone ID	No
ResourceId	string	Resource ID	Yes
ResourceType	string	Resource Type	Yes
Name	string	Resource Name	Yes
MetricName	string	Metric Name	Yes
OccurrenceTime	int	Alarm Occurrence Time	Yes
Recovered	string	Restore?	Yes
Threshold	float	Threshold	Yes
Value	float	Alarm Value	Yes
RecoveryTime	int	Alarm Recovery Time	No

Example

Request Example

https://api.surfercloud.com/?Action=GetAlarmRecordList
&ProjectId=ResDQFGv
&BeginTime=923344
&EndTime=5333333

Response Example

{
  "Action": "GetAlarmRecordListResponse",
  "DataSet": [
    {
      "MetricName": "TaRgQmTH",
      "Name": "BXNzRSnO",
      "OccurrenceTime": 8,
      "Recovered": "Yes",
      "RecoveryTime": 8,
      "ResourceId": "fmLxFLkZ",
      "ResourceType": "KAInbahB",
      "Threshold": 7.97572,
      "Value": 9.51639
    },
    {
      "MetricName": "ASPlEaZc",
      "Name": "osdailmY",
      "OccurrenceTime": 5,
      "Recovered": "Yes",
      "RecoveryTime": 9,
      "ResourceId": "bisLTIWp",
      "ResourceType": "WrmwejhS",
      "Threshold": 6.53413,
      "Value": 5.54988
    },
    {
      "MetricName": "KgGCfbqp",
      "Name": "VAFbFRxD",
      "OccurrenceTime": 2,
      "Recovered": "Yes",
      "RecoveryTime": 8,
      "ResourceId": "wCfkteuo",
      "ResourceType": "UTROAYRI",
      "Threshold": 8.72818,
      "Value": 2.27913
    },
    {
      "MetricName": "mWQZYFzM",
      "Name": "XaHhdZLW",
      "OccurrenceTime": 1,
      "Recovered": "Yes",
      "RecoveryTime": 3,
      "ResourceId": "QVQMVclb",
      "ResourceType": "mdedMlZD",
      "Threshold": 9.22554,
      "Value": 2.43968
    },
    {
      "MetricName": "uqQHIXVE",
      "Name": "PvSNXQpZ",
      "OccurrenceTime": 1,
      "Recovered": "Yes",
      "RecoveryTime": 3,
      "ResourceId": "JeHDBIwa",
      "ResourceType": "JgCsxfqS",
      "Threshold": 7.17721,
      "Value": 4.74256
    },
    {
      "MetricName": "uSWEzuJi",
      "Name": "CMzuWovm",
      "OccurrenceTime": 8,
      "Recovered": "Yes",
      "RecoveryTime": 1,
      "ResourceId": "eUISGdGS",
      "ResourceType": "WJOMSayg",
      "Threshold": 6.57864,
      "Value": 1.73251
    },
    {
      "MetricName": "zSIYVqgD",
      "Name": "oEeBdwco",
      "OccurrenceTime": 6,
      "Recovered": "Yes",
      "RecoveryTime": 5,
      "ResourceId": "WdXpvtrI",
      "ResourceType": "gEYdhrGf",
      "Threshold": 1.52272,
      "Value": 9.83791
    },
    {
      "MetricName": "QVYNTUed",
      "Name": "XvyLDfzY",
      "OccurrenceTime": 8,
      "Recovered": "Yes",
      "RecoveryTime": 2,
      "ResourceId": "dZfxKNkY",
      "ResourceType": "JXrsqQwP",
      "Threshold": 4.31349,
      "Value": 3.97248
    },
    {
      "MetricName": "sndStIsR",
      "Name": "ZaEOZbgh",
      "OccurrenceTime": 6,
      "Recovered": "Yes",
      "RecoveryTime": 8,
      "ResourceId": "ojuzjqkF",
      "ResourceType": "LEfmyHmQ",
      "Threshold": 1.35466,
      "Value": 4.54875
    },
    {
      "MetricName": "RKOTCDPi",
      "Name": "tNpywJsP",
      "OccurrenceTime": 5,
      "Recovered": "Yes",
      "RecoveryTime": 8,
      "ResourceId": "WjPSUvSp",
      "ResourceType": "xTnHtABc",
      "Threshold": 1.33729,
      "Value": 3.37471
    }
  ],
  "RetCode": 0
}

DescribeResourceMetric GetAlarmTemplateList