Help Center/ Cloud Eye/ API Reference/ API V2/ Resource Groups/ Asynchronously Associating a Resource Group with a Custom Alarm Template
Updated on 2025-08-27 GMT+08:00

Asynchronously Associating a Resource Group with a Custom Alarm Template

Function

This API is used to submit an asynchronous task for batch associating a resource group with custom alarm templates. These tasks create or replace existing alarm rules. Each user can create up to 100 asynchronous tasks in the pending state. Each resource group allows only one pending task.

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}/resource-groups/{group_id}/alarm-templates/async-association

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Definition

Tenant ID.

Constraints:

None

Value range:

Project ID, 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 by calling an API or on the console. For details, see Obtaining a Project ID. The value must contain of 1 to 64 characters.

Default value:

None

group_id

Yes

String

Resource group ID, which starts with rg and is followed by 22 characters, including letters and digits.

Regex Pattern: ^rg([a-z]|[A-Z]|[0-9]){22}$

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.

Default value:

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

template_ids

Yes

Array of strings

Alarm template IDs. If the ID list is empty, the alarm rules created using the alarm templates associated with the resource group will be deleted.

notification_enabled

Yes

Boolean

Whether to enable alarm notification. true: enabled; false: disabled.

alarm_notifications

No

Array of Notification objects

Alarm notification list.

ok_notifications

No

Array of Notification objects

Alarm clearance notification list.

notification_begin_time

No

String

Time when the alarm notification was enabled.

notification_end_time

No

String

Time when the alarm notification was disabled.

effective_timezone

No

String

Time zone, for example, GMT-08:00, GMT+08:00, or GMT+0:00.

enterprise_project_id

No

String

Enterprise project ID

notification_manner

No

String

Notification mode, which can be NOTIFICATION_GROUP (notification groups), TOPIC_SUBSCRIPTION (topic subscriptions), or NOTIFICATION_POLICY (notification policies).

Enumeration values:

  • NOTIFICATION_GROUP

  • TOPIC_SUBSCRIPTION

  • NOTIFICATION_POLICY

notification_policy_ids

No

Array of strings

Associated notification policy IDs.

Table 4 Notification

Parameter

Mandatory

Type

Description

type

Yes

String

Notification type. The value can be notification (SMN notifications), contact (account contacts), contactGroup (notification groups), or autoscaling (AS notifications). autoscaling is used only in AS and is not recommended. groupwatch, ecsRecovery, and iecAction are no longer used.

Enumeration values:

  • notification

  • autoscaling

  • groupwatch

  • ecsRecovery

  • contact

  • contactGroup

  • iecAction

notification_list

Yes

Array of strings

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 both alarm_actions and ok_actions are specified, their notification_list values must be the same.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

group_id

String

Resource group ID, which starts with rg and is followed by 22 characters, including letters and digits.

template_ids

Array of strings

IDs of associated alarm templates.

Status code: 400

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.

Status code: 401

Table 7 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: 403

Table 8 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: 404

Table 9 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 10 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

{
  "template_ids" : [ "at1628592157541dB1klWgY6", "at1628592157541dxcdfssfd" ],
  "notification_enabled" : false
}

Example Responses

Status code: 200

Response body returned after an asynchronous task for associating a resource group with alarm templates is delivered.

{
  "group_id" : "rg1619578505263QkW3b66yo",
  "template_ids" : [ "at1628592157541dB1klWgY6", "at1625452115254dB1kllll3" ]
}

Status Codes

Status Code

Description

200

Response body returned after an asynchronous task for associating a resource group with alarm templates is delivered.

400

Parameter verification failed.

401

Unauthenticated.

403

Authentication failed.

404

Resource not found.

500

Internal error.

Error Codes

See Error Codes.