DescribeUserAlarmConfig - 获取用户告警配置_云防火墙(Cloud Firewall)-阿里云帮助中心

获取用户告警配置。

接口说明

QPS 限制

本接口的单用户 QPS 限制为 10 次/秒。超过限制，API 调用会被限流，这可能会影响您的业务，请合理调用。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
SourceIp	string	否	访问者源 IP 地址。	59.82.135.XXX
Lang	string	否	语言类型。枚举值： en : 英文 zh : 中文	zh
Lang	string	否	语言类型。枚举值： en : 英文 zh : 中文	zh

返回参数

名称	类型	描述	示例值
	object
RequestId	string	请求 ID。	9D250177-4F11-58B8-9AFE-A4624FF1****
AlarmConfig	array<object>	报警配置。
	object	报警配置。
AlarmPeriod	integer	告警周期。	30
AlarmValue	string	报警通知消息。	80
AlarmHour	integer	报警阈值。	0
AlarmType	string	告警类型。枚举值： weeklyReport : weeklyReport trafficPreAlert : trafficPreAlert outgoingRiskAll : outgoingRiskAll Middlethreat : Middlethreat bandwidth : bandwidth ipsHighthreat : ipsHighthreat outgoingRiskNonWhite : outgoingRiskNonWhite ipsIgnoreResolved : ipsIgnoreResolved	bandwidth
AlarmNotify	integer	通知方式。枚举值： 0 : sms/email 1 : sms 2 : email 3 : none	1
AlarmWeekDay	integer	报警重试次数。	0
NotifyConfig	array<object>	报警通知配置。
	object	报警通知配置。
NotifyValue	string	消息通知配置。取值：-0：关闭-1：开启	0
NotifyType	string	通知类型。	mail
ContactConfig	array<object>	联系人信息。
	object	联系人信息。
Status	integer	报警状态。取值：-0：关闭-1：开启	1
Email	string	邮箱。	1530811****@qq.com
Name	string	手机号。	1531123****
MobilePhone	string	报警联系人姓名。	张三
AlarmLang	string	报警的语言类型。枚举值： en : 英文 zh : 中文	zh
DefaultContact	object	默认报警联系人信息。
Name	string	默认报警联系人姓名。	张三
Email	string	默认邮箱。	1530811****@qq.com
MobilePhone	string	默认手机号。	1531123****
Status	string	日志存储状态。取值：-normal：正常-disable：禁用	0

示例

正常返回示例

JSON格式

{
  "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"
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	ErrorParametersUid	The aliUid parameter is invalid.	aliUid 不合法
400	ErrorDBSelect	internal error: sql select.	请求错误，数据库查询失败。

访问错误中心查看更多错误码。

变更历史

更多信息，参考变更详情。