Help Center/ Cloud Eye/ API Reference/ API V2/ Alarm Rules/ Enabling or Disabling Alarm Rules in Batches
Updated on 2025-10-30 GMT+08:00
View PDF
Share

Enabling or Disabling Alarm Rules in Batches

Function

This API is used to enable or disable alarm rules in batches.

Debugging

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

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    ces:alarms:putAction

    Write

    alarm *

    • g:ResourceTag/<tag-key>

    • g:EnterpriseProjectId
    • ces:alarms:put

    -

URI

POST /v2/{project_id}/alarms/action

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Project ID. It is used to specify the project that an asset belongs to. You can query the assets of a project by project ID. You can obtain the project ID from the API or console. For details, see Obtaining a Project ID.

Constraints

N/A

Range

1 to 64 characters

Default Value

N/A

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

Content-Type

No

String

Definition

MIME type of the request body.

Constraints:

None

Value range:

The value can contain 1 to 64 characters.

Default value:

The default type is application/json; charset=UTF-8.

X-Auth-Token

No

String

Definition

User token.

Constraints:

None

Value range:

The value can contain 1 to 16,384 characters.

Default value:

None
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

alarm_ids

Yes

Array of strings

Definition

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

Constraints

At least one and a maximum of 100 alarm rule IDs can be configured.

alarm_enabled

Yes

Boolean

Definition

Whether to enable the alarm rule.

Constraints

N/A

Range

A boolean value.

  • true: enabled

  • false: disabled

Default Value

true

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

alarm_ids

Array of strings

Definition

IDs of alarm rules that were enabled or disabled.

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Status codes customized by each cloud service when a request error occurs.

error_msg

String

Request error message.

request_id

String

Request ID.

Status code: 500

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Status codes customized by each cloud service when a request error occurs.

error_msg

String

Request error message.

request_id

String

Request ID.

Example Requests

Enabling or disabling alarm rules in batches.

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

Example Responses

Status code: 200

Alarm rules enabled or disabled.

{
  "alarm_ids" : [ "alCzk8o9dtSQHtiDgb44Eepw" ]
}

Status Codes

Status Code

Description

200

Alarm rules enabled or disabled.

400

Parameter verification failed.

500

Internal system error.

Error Codes

See Error Codes.

Parent topic: Alarm Rules