Updated on 2024-08-02 GMT+08:00

Modifying an Event Alarm Rule

Function

This API is used to modify an event alarm rule.

Calling Method

For details, see Calling APIs.

URI

PUT /v2/{project_id}/event2alarm-rule

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID obtained from IAM. Generally, a project ID contains 32 characters.

Minimum: 32

Maximum: 32

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

No

String

User token obtained from IAM.

Minimum: 0

Maximum: 40960

Content-Type

Yes

String

Content type, which is application/json.

Enumeration values:

  • application/json

Table 3 Request body parameters

Parameter

Mandatory

Type

Description

user_id

Yes

String

Project ID.

Minimum: 32

Maximum: 32

name

Yes

String

Rule name. Enter a maximum of 100 characters and do not start or end with a special character. Only letters, digits, underscores (_), and hyphens (-) are allowed.

Minimum: 1

Maximum: 100

description

No

String

Rule description. Enter a maximum of 1024 characters and do not start or end with an underscore (_) or hyphen (-). Only letters, digits, and special characters (_-<>=,.) are allowed.

Minimum: 0

Maximum: 1024

create_time

Yes

Integer

Creation time.

Minimum: 0

Maximum: 9999999999999

update_time

No

Integer

Update time.

Minimum: 0

Maximum: 9999999999999

resource_provider

No

String

Event source.

Minimum: 0

Maximum: 64

metadata

Yes

metadata object

Source data.

enable

Yes

Boolean

Whether to enable the rule.

trigger_policies

Yes

Array of trigger_policies objects

Trigger policy.

Array Length: 0 - 1024

alarm_type

Yes

String

Alarm type. notification: direct alarm reporting. denoising: alarm noise reduction.

Minimum: 0

Maximum: 32

Enumeration values:

  • notification

  • denoising

action_rule

Yes

String

Alarm action rule.

Minimum: 0

Maximum: 128

inhibit_rule

No

String

Alarm suppression rule.

Minimum: 0

Maximum: 128

route_group_rule

No

String

Alarm grouping rule.

Minimum: 0

Maximum: 128

event_names

No

Array of strings

Event name.

migrated

No

Boolean

Whether to migrate to AOM 2.0.

topics

No

Array of SmnTopics objects

SMN information.

Table 4 metadata

Parameter

Mandatory

Type

Description

customField

No

Array of strings

Custom tag.

Minimum: 0

Maximum: 1024

Array Length: 0 - 1024

Table 5 trigger_policies

Parameter

Mandatory

Type

Description

id

No

Integer

ID.

Minimum: 0

Maximum: 128

name

No

String

Event name.

Minimum: 0

Maximum: 128

trigger_type

No

String

Trigger type. accumulative: Accumulated trigger. immediately: Immediate trigger.

Minimum: 0

Maximum: 128

Enumeration values:

  • accumulative

  • immediately

period

No

Integer

Trigger cycle.

Minimum: 1

Maximum: 86400

operator

No

String

Comparison operator.

Minimum: 0

Maximum: 8

count

No

Integer

Number of trigger times.

Minimum: 1

Maximum: 100

level

No

String

Alarm severity.

Minimum: 0

Maximum: 32

Table 6 SmnTopics

Parameter

Mandatory

Type

Description

display_name

No

String

Topic display name, which will be the name of an email sender. Max.: 192 bytes. This parameter is left blank by default.

Minimum: 1

Maximum: 64

name

Yes

String

Name of the topic. Enter 1 to 255 characters starting with a letter or digit. Only letters, digits, hyphens (-), and underscores (_) are allowed.

Minimum: 1

Maximum: 255

push_policy

Yes

Integer

SMN message push policy. Options: 0 and 1.

Minimum: 0

Maximum: 1

status

No

Integer

Status of the topic subscriber. 0: The topic has been deleted or the subscription list of this topic is empty. 1: The subscription object is in the subscribed state. 2: The subscription object is in the unsubscribed or canceled state.

Enumeration values:

  • 0

  • 1

  • 2

topic_urn

Yes

String

Unique resource identifier of the topic.

Minimum: 1

Maximum: 100

Response Parameters

Status code: 400

Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 12

Maximum: 12

error_msg

String

Error message.

Minimum: 0

Maximum: 1024

error_type

String

Error type.

Minimum: 0

Maximum: 128

trace_id

String

Request ID.

Minimum: 32

Maximum: 32

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 12

Maximum: 12

error_msg

String

Error message.

Minimum: 0

Maximum: 1024

error_type

String

Error type.

Minimum: 0

Maximum: 128

trace_id

String

Request ID.

Minimum: 32

Maximum: 32

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 12

Maximum: 12

error_msg

String

Error message.

Minimum: 0

Maximum: 1024

error_type

String

Error type.

Minimum: 0

Maximum: 128

trace_id

String

Request ID.

Minimum: 32

Maximum: 32

Status code: 500

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Error code.

Minimum: 12

Maximum: 12

error_msg

String

Error message.

Minimum: 0

Maximum: 1024

error_type

String

Error type.

Minimum: 0

Maximum: 128

trace_id

String

Request ID.

Minimum: 32

Maximum: 32

Example Requests

Update an event alarm rule whose user ID is "xxxxxxx", event source is "AOM", and name is "scl_test_event".

https://{endpoint}/v2/{project_id}/event2alarm-rule

{
  "user_id" : "xxxxxxx",
  "name" : "scl_test_event",
  "description" : "",
  "create_time" : 1669276304343,
  "update_time" : 1669276304343,
  "resource_provider" : "AOM",
  "metadata" : {
    "customField" : [ "xxx" ]
  },
  "enable" : true,
  "trigger_policies" : [ {
    "id" : 0,
    "name" : "",
    "trigger_type" : "accumulative",
    "period" : 300,
    "operator" : ">=",
    "count" : 99,
    "level" : ""
  } ],
  "alarm_type" : "notification",
  "action_rule" : "111111",
  "inhibit_rule" : "",
  "route_group_rule" : ""
}

Example Responses

Status code: 204

OK: The request is successful.

 

Status code: 400

Bad Request: The request is invalid. The client should not repeat the request without modifications.

{
  "error_code" : "AOM.02021003",
  "error_msg" : "input alarm rule or description is invalid",
  "trace_id" : ""
}

Status code: 401

Unauthorized: The authentication information is incorrect or invalid.

{
  "error_code" : "SVCSTG.AMS.2000051",
  "error_msg" : "auth failed.",
  "error_type" : "AUTH_FAILED"
}

Status code: 403

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

{
  "error_code" : "AOM.0403",
  "error_msg" : "auth failed.",
  "error_type" : "AUTH_FAILED"
}

Status code: 500

Internal Server Error: The server is able to receive the request but unable to understand the request.

{
  "error_code" : "AOM.02021500",
  "error_message" : "SC_INTERNAL_SERVER_ERROR",
  "trace_id" : ""
}

Status Codes

Status Code

Description

204

OK: The request is successful.

400

Bad Request: The request is invalid. The client should not repeat the request without modifications.

401

Unauthorized: The authentication information is incorrect or invalid.

403

Forbidden: The request is rejected. The server has received the request and understood it, but the server refuses to respond to it. The client should not repeat the request without modifications.

500

Internal Server Error: The server is able to receive the request but unable to understand the request.

Error Codes

See Error Codes.