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

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.

Constraints

This API is not supported in the following regions: AF-Cairo, CN North3, CN North-Ulanqab11, CN East2, CN East-Qingdao, CN South-Shenzhen, LA-Buenos Aires1, LA-Lima1, LA-Mexico City1, TR-Istanbul, CN North-Ulanqab201, CN Southwest-Guiyang-Qiche2, AP-Manila, and CN South-Guangzhou-InvitationOnly.

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:resourceGroups:putAssociationAlarmTemplate

    Write

    -

    g:EnterpriseProjectId
    • ces:resourceGroups:put

    -

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

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

group_id

Yes

String

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

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

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

Definition

Whether to enable alarm notifications.

Constraints

N/A

Range

A boolean value.

  • true: enabled

  • false: disabled

Default Value

true

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

Definition

Time when alarm notifications were enabled.

Constraints

N/A

Range

The value allows 1 to 64 characters and can only contain digits and colons (:).

Default Value

N/A

notification_end_time

No

String

Definition

Time when alarm notifications were disabled.

Constraints

N/A

Range

The value allows 1 to 64 characters and can only contain digits and colons (:).

Default Value

N/A

effective_timezone

No

String

Definition

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

Constraints

N/A

Range

1 to 16 characters

Default Value

N/A

enterprise_project_id

No

String

Definition

Enterprise project ID.

Constraints

N/A

Range

Only lowercase letters, digits, and hyphens (-) are allowed.

Default Value

N/A

notification_manner

No

String

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

notification_policy_ids

No

Array of strings

Associated notification policy IDs.
Table 4 Notification

Parameter

Mandatory

Type

Description

type

Yes

String

Definition

Notification type.

Constraints

N/A

Range

The value can be:

  • notification: SMN notifications

  • contact: account contacts

  • contactGroup: notification groups

  • autoscaling: AS notifications. This value is used only for AS.

  • groupwatch: deprecated

  • ecsRecovery: deprecated

  • iecAction: This API has been deprecated and is not recommended.

Default Value

N/A

notification_list

Yes

Array of strings

Definition

Recipients to be notified of the alarm status changes. The value of topicUrn can be obtained from SMN. For details, see section "Querying Topics".

Constraints

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. If notification_enabled is set to true, you must specify either alarm_notifications or ok_notifications. If both alarm_notifications and ok_notifications are specified, their notification_list values must be the same. A maximum of 20 recipients are allowed.

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.

Parent topic: Resource Groups