Help Center/ Cloud Eye/ API Reference/ API v2/ One-Click Monitoring/ Batch Modifying Alarm Notifications in Alarm Rules for One Service That Has One-Click Monitoring Enabled
Updated on 2024-05-16 GMT+08:00

Batch Modifying Alarm Notifications in Alarm Rules for One Service That Has One-Click Monitoring Enabled

Function

This API is used to batch modify alarm notifications in alarm rules for one service that has one-click monitoring enabled.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

URI

PUT /v2/{project_id}/one-click-alarms/{one_click_alarm_id}/notifications

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Specifies the tenant ID.

Minimum: 1

Maximum: 64

Regex Pattern: ^[a-zA-Z0-9-]{1,64}$

one_click_alarm_id

Yes

String

Specifies the one-click monitoring ID for a service.

Minimum: 1

Maximum: 64

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

Yes

String

Specifies the MIME type of the request body. The default type is application/json; charset=UTF-8.

Default: application/json; charset=UTF-8

Minimum: 1

Maximum: 64

X-Auth-Token

Yes

String

Specifies the user token.

Minimum: 1

Maximum: 16384

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

notification_enabled

Yes

Boolean

Specifies whether to enable the alarm notification.

alarm_notifications

No

Array of SMNAction objects

Specifies the action to be triggered by an alarm.

ok_notifications

No

Array of SMNAction objects

Specifies the action to be triggered after an alarm is cleared.

notification_begin_time

No

String

Specifies the time when the alarm notification was enabled.

notification_end_time

No

String

Specifies the time when the alarm notification was disabled.

Table 4 SMNAction

Parameter

Mandatory

Type

Description

type

Yes

String

Specifies the notification type. The value can be notification, autoscaling, groupwatch, ecsRecovery, contact, contactGroup, or iecAction.

Enumeration values:

  • notification

  • autoscaling

  • groupwatch

  • ecsRecovery

  • contact

  • contactGroup

  • iecAction

Regex Pattern: ^(notification|autoscaling|groupwatch|ecsRecovery|contact|contactGroup|iecAction)$

notification_list

Yes

Array of strings

Specifies the list of objects to be notified if the alarm status changes. The value of topicUrn can be obtained from SMN. For details, see section "Querying Topics". If type is set to notification, the value of notificationList cannot be left blank. If type is set to autoscaling, the value of notification_list must be left blank. Note: If alarm_action_enabled is set to true, alarm_actions, ok_actions, or both of them must be specified. If alarm_actions and ok_actions coexist, their notification_list values must be the same.

Array Length: 0 - 20

Response Parameters

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the status codes customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Specifies the request error message.

Minimum: 0

Maximum: 256

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 256

Status code: 401

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the status codes customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Specifies the request error message.

Minimum: 0

Maximum: 256

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 256

Status code: 403

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the status codes customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Specifies the request error message.

Minimum: 0

Maximum: 256

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 256

Status code: 404

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the status codes customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Specifies the request error message.

Minimum: 0

Maximum: 256

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 256

Status code: 500

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Specifies the status codes customized by each cloud service when a request error occurs.

Minimum: 0

Maximum: 256

error_msg

String

Specifies the request error message.

Minimum: 0

Maximum: 256

request_id

String

Specifies the request ID.

Minimum: 0

Maximum: 256

Example Requests

{
  "notification_enabled" : true,
  "alarm_notifications" : [ {
    "type" : "notification",
    "notification_list" : [ "urn:smn:123" ]
  } ],
  "ok_notifications" : [ {
    "type" : "notification",
    "notification_list" : [ "urn:smn:123" ]
  } ],
  "notification_begin_time" : "00:00",
  "notification_end_time" : "23:59"
}

Example Responses

None

Status Codes

Status Code

Description

204

No Content

400

Failed to verify parameters.

401

Not authenticated.

403

Authentication failed.

404

Resource not found.

500

Internal system error.

Error Codes

See Error Codes.