DocsICP FilingConsole
官方文档
首页

ModifyUserAlarmConfig

更新时间：
复制 MD 格式
产品详情
我的收藏

Modifies user alert configuration.

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

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

yundun-cloudfirewall:ModifyUserAlarmConfig

update

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
SourceIp

string

No

Source IP address of the requester.

117.129.64.XXX
Lang

string

No

Language used for requests and responses.

zh
Lang

string

No

Language used for requests and responses.

zh
AlarmConfig

array<object>

Yes

Alert configuration.

object

No

Alert configuration.

AlarmValue

string

No

Alert notification message.

on
AlarmType

string

No

Alarm metric.

Valid values:

  • weeklyReport :

    weeklyReport

  • trafficPreAlert :

    trafficPreAlert

  • outgoingRiskAll :

    outgoingRiskAll

  • ipsMiddlethreat :

    ipsMiddlethreat

  • bandwidth :

    bandwidth

  • ipsHighthreat :

    ipsHighthreat

  • outgoingRiskNonWhite :

    outgoingRiskNonWhite

  • ipsIgnoreResolved :

    ipsIgnoreResolved

bandwidth
AlarmPeriod

string

No

Alert period.

Valid values:

  • 0 :

    8:00~20:00

  • 1 :

    24 hours

0
AlarmHour

string

No

Hour for alert notifications.

10
AlarmNotify

string

No

Notification method.

Valid values:

  • 0 :

    sms/email

  • 1 :

    sms

  • 2 :

    email

  • 3 :

    none

0
AlarmWeekDay

string

No

Day of the week for alert notifications.

2
ContactConfig

array<object>

No

Contact configuration.

object

No

Contact configuration.

Status

string

No

Alert status.

Valid values:

  • 0 :

    shutdown

  • 1 :

    enabled

1
Email

string

No

Mailbox.

91632****@qq.com
MobilePhone

string

No

Mobile number.

1351234****

Name

string

No

Alert notification recipient.

Ben
AlarmLang

string

No

Language for message notifications.

Valid values:

  • en :

    English

  • zh :

    Chinese

zh
UseDefaultContact

integer

No

Use default contact method.

1

Response elements

Element

Type

Description

Example

object

RequestId

string

Request ID of the response.

3B168A0F-A43D-5FD0-8059-B51BDD6E****

Examples

Success response

JSON format

{
  "RequestId": "3B168A0F-A43D-5FD0-8059-B51BDD6E****"
}

Error codes

HTTP status code

Error code

Error message

Description
400 ErrorParametersUid The aliUid parameter is invalid. The aliUid parameter is invalid.
400 ErrorParametersAlarmConfig invalid alarmConfig. The value of the AlarmConfig parameter is invalid.
400 ErrorParameters Parameters error. Parameter error.
400 ErrorParametersNotifyConfig invalid notifyConfig. The value of the NotifyConfig parameter is invalid.
400 ErrorParamSms invalid sms number. The specified mobile number used to receive text messages is invalid.
400 ErrorParamEmail invalid email address. The email address is invalid.
400 ErrorParamCountExceed sms or email count exceed. The number of addresses exceeds the upper limit.
400 ErrorDBDeleteError A database delete error occurred. An error occurred while deleting the database.
400 ErrorDBUpdate internal error: sql update. An error occurred. Try again later.
400 ErrorDBInsert internal error: sql insert. Request error, database insert failed

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.