CreateDynamicTagGroup - CloudMonitor - Alibaba Cloud Documentation Center

Creates an application group based on the tags of cloud resources.

Operation description

This operation is available for Elastic Compute Service (ECS), ApsaraDB RDS, and Server Load Balancer (SLB).

This topic provides an example to show how to create an application group for resources whose tag key is ecs_instance. In this example, the alert contact group of the application group is ECS_Group.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
cms:CreateDynamicTagGroup	create	All Resources *	none	none

Request parameters

Parameter	Type	Required	Description	Example
TagKey	string	Yes	The tag keys of the cloud resources. For more information about how to obtain tag keys, see DescribeTagKeyList .	ecs_instance
ContactGroupList	array	Yes
	string	Yes	The alert contact groups. Valid values of N: 1 to 100. The alert notifications of the application group are sent to the alert contacts that belong to the specified alert contact groups. An alert contact group can contain one or more alert contacts. For information about how to create alert contacts and alert contact groups, see PutContact and PutContactGroup . For information about how to obtain alert contact groups, see DescribeContactGroupList .	ECS_Group
MatchExpress	array<object>	Yes	The conditional expressions used to create an application group based on the tag.
	object	Yes	The conditional expressions used to create an application group based on the tag. Valid values of N: 1 to 3.
TagValueMatchFunction	string	No	The method that is used to match the tag values of the cloud resources. Set the value of N to 1. Valid values: contains: contains startWith: starts with a prefix endWith: ends with a suffix notContains: does not contain equals: equals all: matches all Note If you set the `MatchExpress.N.TagValueMatchFunction` parameter, you must also set the `MatchExpress.N.TagValue` parameter.	contains
TagValue	string	No	The tag values of the cloud resources. Set the value of N to 1. Note If you set the `MatchExpress.N.TagValueMatchFunction` parameter, you must also set the `MatchExpress.N.TagValue` parameter.	instance
TagName	string	No	The keys of the tags that are used to create the application group. If a specified key is attached to multiple resources, the resources that have the same key-value pair are added to the same group.	appname
TagRegionId	string	No	The ID of the region to which the tags belong.	cn-hangzhou
EnableSubscribeEvent	boolean	No	Specifies whether the application group automatically subscribes to event notifications. If events whose severity level is critical or warning occur on resources in an application group, CloudMonitor sends alert notifications. Valid values: true: The application group automatically subscribes to event notifications. false (default value): The application group does not automatically subscribe to event notifications.	true
EnableInstallAgent	boolean	No	Specifies whether the CloudMonitor agent is automatically installed for the application group. CloudMonitor determines whether to automatically install the CloudMonitor agent for the hosts in an application group based on the value of this parameter. Valid values: true: The CloudMonitor agent is automatically installed. false (default value): The CloudMonitor agent is not automatically installed.	true
MatchExpressFilterRelation	string	No	The relationship between the conditional expressions for the tag values of the cloud resources. Valid values: and (default value) or	and
TemplateIdList	array	No
	string	No	The IDs of the alert templates. For more information about how to query alert template IDs, see DescribeMetricRuleTemplateList .	70****

For more information about common request parameters, see Common parameters.

Response parameters

Parameter	Type	Description	Example
	object
Code	string	The HTTP status code. Note The status code 200 indicates that the call is successful.	200
Message	string	The error message.	The specified resource is not found.
RequestId	string	The ID of the request.	84AC6F0B-7945-466A-AA44-99BB5A561F86
Success	boolean	Indicates whether the call is successful. Valid values: true: The call is successful. false: The call fails.	true
Id	string	The ID of the tag matching rule.	2534dc0a-e3e5-4ae1-a2fc-75ef166c****

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "84AC6F0B-7945-466A-AA44-99BB5A561F86",
  "Success": true,
  "Id": "2534dc0a-e3e5-4ae1-a2fc-75ef166c****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	ParameterInvalid	%s	-
403	AccessForbidden	User not authorized to operate on the specified resource.	-
404	ResourceNotFound	The specified resource is not found.	The specified resource is not found.
429	ResourceOverLimit	%s	-
500	InternalError	The request processing has failed due to some unknown error.	-

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation
2023-03-15	The Error code has changed	View Change Details