DescribeUserAlarmConfig - Cloud Firewall - Alibaba Cloud Documentation Center

Queries the alert configurations for a user.

Operation description

QPS limit

The queries per second (QPS) limit for this API operation is 10 calls per second for each user. If the limit is exceeded, throttling is triggered, which may impact your business. Plan your calls accordingly.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request parameters

Parameter	Type	Required	Description	Example
SourceIp	string	No	The source IP address of the visitor.	59.82.135.XXX
Lang	string	No	The language of the content within the request and response. Valid values: en : English zh : Chinese	zh
Lang	string	No	The language of the content within the request and response. Valid values: en : English zh : Chinese	zh

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	9D250177-4F11-58B8-9AFE-A4624FF1****
AlarmConfig	array<object>	The alert configurations.
	object	The alert configuration.
AlarmPeriod	integer	The alert period.	30
AlarmValue	string	The alert notification message.	80
AlarmHour	integer	The alarm threshold.	0
AlarmType	string	The alert metric. Valid values: weeklyReport : weeklyReport trafficPreAlert : trafficPreAlert outgoingRiskAll : outgoingRiskAll Middlethreat : Middlethreat bandwidth : bandwidth ipsHighthreat : ipsHighthreat outgoingRiskNonWhite : outgoingRiskNonWhite ipsIgnoreResolved : ipsIgnoreResolved	bandwidth
AlarmNotify	integer	The notification method. Valid values: 0 : SMS and email 1 : SMS 2 : Email 3 : None	1
AlarmWeekDay	integer	The day of the week for the alert.	0
NotifyConfig	array<object>	The alert notification configurations.
	object	The alert notification configuration.
NotifyValue	string	Specifies whether message notification is enabled. Valid values: 0 (disabled) and 1 (enabled).	0
NotifyType	string	The notification type.	mail
ContactConfig	array<object>	The contact information.
	object	The contact information.
Status	integer	The status of the alert contact. Valid values: 0 (disabled) and 1 (enabled).	1
Email	string	The email address.	1530811****@qq.com
Name	string	The mobile phone number of the alert contact.	1531123****
MobilePhone	string	The mobile phone number.	张三
AlarmLang	string	The language of the alert. Valid values: en : English zh : Chinese	zh
DefaultContact	object	The information about the default alert contact.
Name	string	The name of the default alert contact.	张三
Email	string	The default email address.	1530811****@qq.com
MobilePhone	string	The default mobile phone number.	1531123****
Status	string	The status. Valid values: normal (Normal) and disable (Disabled).	0

Examples

Success response

JSON format

{
  "RequestId": "9D250177-4F11-58B8-9AFE-A4624FF1****",
  "AlarmConfig": [
    {
      "AlarmPeriod": 30,
      "AlarmValue": "80",
      "AlarmHour": 0,
      "AlarmType": "bandwidth",
      "AlarmNotify": 1,
      "AlarmWeekDay": 0
    }
  ],
  "NotifyConfig": [
    {
      "NotifyValue": "0",
      "NotifyType": "mail"
    }
  ],
  "ContactConfig": [
    {
      "Status": 1,
      "Email": "1530811****@qq.com\n",
      "Name": "1531123****",
      "MobilePhone": "张三"
    }
  ],
  "AlarmLang": "zh",
  "DefaultContact": {
    "Name": "张三",
    "Email": "1530811****@qq.com",
    "MobilePhone": "1531123****",
    "Status": "0"
  }
}

Error codes

HTTP status code	Error code	Error message	Description
400	ErrorParametersUid	The aliUid parameter is invalid.	The aliUid parameter is invalid.
400	ErrorDBSelect	internal error: sql select.	Request error, database query failed.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.