DescribeUserAlarmConfig API Reference for Cloud Firewall Alert Settings - Cloud Firewall

Retrieves the user's alert configuration.

Operation description

QPS limit

The QPS limit for this interface is 10 calls per second per user. Exceeding this limit throttles API calls and may affect your service. 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 request.	59.82.135.XXX
Lang	string	No	The language of the response. Valid values: zh and en. Default value: zh. Valid values: en : English zh : Chinese	zh
Lang	string	No	The language of the response. Valid values: zh and en. Default value: zh. 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 alarm configuration.
	object	The alarm configuration.
AlarmPeriod	integer	The alarm period.	30
AlarmValue	string	The value that triggers the alarm.	80
AlarmHour	integer	The alarm threshold.	0
AlarmType	string	The alarm type. Valid values: weeklyReport : Weekly report trafficPreAlert : Traffic pre-alert outgoingRiskAll : All outbound risks Middlethreat : Medium-level threat bandwidth : Bandwidth usage ipsHighthreat : High-level threat detected by the IPS outgoingRiskNonWhite : Outbound risk from a non-whitelisted address ipsIgnoreResolved : Ignored or resolved threat detected by the IPS	bandwidth
AlarmNotify	integer	The notification method. Valid values: 0 : SMS and email 1 : SMS 2 : Email 3 : None	1
AlarmWeekDay	integer	The alarm retry count.	0
NotifyConfig	array<object>	The notification configurations.
	object	The notification configuration.
NotifyValue	string	Specifies whether notifications for this type are enabled. Valid values: 0 (Disabled) and 1 (Enabled).
NotifyType	string	The notification type.
ContactConfig	array<object>	The contact information.
	object	The contact information.
Status	integer	The status of the contact. Valid values: 0 (Disabled) and 1 (Enabled).	1
Email	string	The email address.	1530811****@qq.com
Name	string	The contact name.	1531123****
MobilePhone	string	The mobile number.	zhangsan
AlarmLang	string	The language of the alarm notifications. Valid values: en : English zh : Chinese	zh
DefaultContact	object	Information about the default alarm contact.
Name	string	The name of the default contact.	zhangsan
Email	string	The email address of the default contact.	1530811****@qq.com
MobilePhone	string	The mobile number of the default contact.	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": "",
      "NotifyType": ""
    }
  ],
  "ContactConfig": [
    {
      "Status": 1,
      "Email": "1530811****@qq.com\n",
      "Name": "1531123****",
      "MobilePhone": "zhangsan"
    }
  ],
  "AlarmLang": "zh",
  "DefaultContact": {
    "Name": "zhangsan",
    "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.