Help Center/ Cloud Eye/ API Reference/ API v2/ One-Click Monitoring/ Batch Enabling or Disabling Alarm Rules of One Service in One-Click Monitoring
Updated on 2024-05-16 GMT+08:00

Batch Enabling or Disabling Alarm Rules of One Service in One-Click Monitoring

Function

This API is used to batch enable or disable alarm rules for one service in one-click monitoring.

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}/alarm-rules/action

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

alarm_ids

Yes

Array of strings

Specifies IDs of alarm rules to be enabled or disabled in batches.

Array Length: 1 - 100

alarm_enabled

Yes

Boolean

Specifies whether to generate alarms when the alarm triggering conditions are met.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

alarm_ids

Array of strings

Specifies IDs of alarm rules that were enabled or disabled.

Array Length: 1 - 100

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

{
  "alarm_ids" : [ "al123232232341232132" ],
  "alarm_enabled" : true
}

Example Responses

Status code: 200

Alarm rules enabled or disabled.

{
  "alarm_ids" : [ "al123232232341232132" ]
}

Status Codes

Status Code

Description

200

Alarm rules enabled or disabled.

400

Failed to verify parameters.

401

Not authenticated.

403

Authentication failed.

404

Resource not found.

500

Internal system error.

Error Codes

See Error Codes.