Help Center > > User Guide> Working with RDS for SQL Server> Usage of Stored Procedures> Updating Alert Settings

Updating Alert Settings

Updated at: May 26, 2020 GMT+08:00

Scenarios

You can use a stored procedure to update the settings of an existing alert.

Prerequisites

An RDS Microsoft SQL Server DB instance has been connected. Connect to the DB instance through the Microsoft SQL Server client. For details, see Connecting to a DB Instance Through a Public Network. An RDS Microsoft SQL Server DB instance has been connected.

Procedure

Run the following commands to update the settings of an existing alert:

EXEC [msdb].[dbo].[rds_update_alert]

@name='name'

@new_name = 'new_name'

@message_id=message_id

@severity=severity

@enabled=enabled

@delay_between_responses= delay_between_responses

@notification_message='notification_message'

@include_event_description_in=include_event_description_in

@database_name='database'

@event_description_keyword= 'event_description_keyword'

@job_id=job_id | @job_name='job_name'

@occurrence_count= occurrence_count

@count_reset_date= count_reset_date

@count_reset_time= count_reset_time

@last_occurrence_date= last_occurrence_date

@ last_occurrence_time= last_occurrence_time

@ last_response_date= last_response_date

@ last_response_time= last_response_time

@ raise_snmp_trap= raise_snmp_trap

@ performance_condition= 'performance_condition'

@category_name='category'

@wmi_namespace='wmi_namespace'

@wmi_query='wmi_query'

Table 1 Parameter description

Parameter

Description

'name'

The name of the alert that is to be updated. name is sysname, with no default.

'new_name'

A new name for the alert. The name must be unique. new_name is sysname, with a default of NULL.

message_id

A new message or error number for the alert definition. Typically, message_id corresponds to an error number in the sysmessages table. message_id is int, with a default of NULL. A message ID can be used only if the severity level setting for the alert is 0.

severity

A new severity level (from 1 through 25) for the alert definition. Any Microsoft SQL Server message sent to the Windows application log with the specified severity will activate the alert. severity is int, with a default of NULL. A severity level can be used only if the message ID setting for the alert is 0.

enabled

Whether the alert is enabled (1) or not enabled (0). enabled is tinyint, with a default of 1 (enabled). If the value is 0, the alert is not enabled and does not fire.

delay_between_responses

The new waiting period, in seconds, between responses to the alert. delay_between_responses is int, with a default of 0, which means there is no waiting between responses (each occurrence of the alert generates a response). The response can be in either or both of these forms:

  • One or more notifications sent through e-mail or pager.
  • A job to execute.

    By setting this value, it is possible to prevent, for example, unwanted e-mail messages from being sent when an alert repeatedly occurs in a short period of time.

'notification_message'

The revised text of an additional message sent to the operator as part of the e-mail, net send, or pager notification. notification_message is nvarchar(512), with a default of NULL. Specifying notification_message is useful for adding special notes such as remedial procedures.

include_event_description_in

Whether the description of the SQL Server error from the Windows application log should be included in the notification message. include_event_description_in is tinyint, with a default of NULL, and can be one or more of these values.

  • 0: None
  • 1: E-mail
  • 2: Pager
  • 4: net send
  • 7: All

'database'

The name of the database in which the error must occur for the alert to fire. If database is not supplied, the alert fires regardless of where the error occurred. database is sysname. Names that are enclosed in brackets ([ ]) are not allowed. The default value is NULL.

'event_description_keyword'

A sequence of characters that must be found in the description of the error in the error message log. Transact-SQL LIKE expression pattern-matching characters can be used. event_description_keyword is nvarchar(100), with a default of NULL. This parameter is useful for filtering object names (for example, %customer_table%).

job_id

The job identification number. job_id is uniqueidentifier, with a default of NULL. If job_id is specified, job_name must be omitted.

'job_name'

The name of the job that executes in response to this alert. job_name is sysname, with a default of NULL. If job_name is specified, job_id must be omitted.

occurrence_count

Resets the number of times the alert has occurred. occurrence_count is int, with a default of NULL, and can be set only to 0.

count_reset_date

Resets the date the occurrence count was last reset. count_reset_date is int, with a default of NULL.

count_reset_time

Resets the time the occurrence count was last reset. count_reset_time is int, with a default of NULL.

last_occurrence_date

Resets the date the alert last occurred. last_occurrence_date is int, with a default of NULL, and can be set only to 0.

last_occurrence_time

Resets the time the alert last occurred. last_occurrence_time is int, with a default of NULL, and can be set only to 0.

last_response_date

Resets the date the alert was last responded to by the SQLServerAgent service. last_response_date is int, with a default of NULL, and can be set only to 0.

last_response_time

Resets the time the alert was last responded to by the SQLServerAgent service. last_response_time is int, with a default of NULL, and can be set only to 0.

raise_snmp_trap

Reserved.

'performance_condition'

A value expressed in the format "itemcomparatorvalue." performance_condition is nvarchar(512), with a default of NULL, and consists of the following elements:

  • Item: A performance object, performance counter, or named instance of the counter
  • Comparator: One of these operators: >, <, =
  • ReplTest1: Numeric value of the counter

'category'

The name of the alert category. category is sysname, with a default of NULL.

'wmi_namespace'

The WMI namespace to query for events. wmi_namespace is sysname, with a default of NULL.

'wmi_query'

The query that specifies the WMI event for the alert. wmi_query is nvarchar(512), with a default of NULL.

After the command is executed, the system displays the following information.

Commands completed successfully.

Example

The command output is as follows.

Did you find this page helpful?

Submit successfully!

Thank you for your feedback. Your feedback helps make our documentation better.

Failed to submit the feedback. Please try again later.

Which of the following issues have you encountered?







Please complete at least one feedback item.

Content most length 200 character

Content is empty.

OK Cancel