All Products
Search

This Product

    Cloud Monitor:CreateDynamicTagGroup

    Document Center

    Cloud Monitor:CreateDynamicTagGroup

    Last Updated:Oct 30, 2025

    You can call the CreateDynamicTagGroup operation to automatically create application groups using tags.

    Operation description

    This operation supports the following Alibaba Cloud services: Elastic Compute Service (ECS), ApsaraDB RDS, and Server Load Balancer (SLB).

    This topic provides an example of how to automatically create an application group for resources that have the ecs_instance tag key. The alert contact group for the application group is ECS_Group.

    Try it now

    Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

    Test

    RAM authorization

    The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

    • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

    • API: The API that you can call to perform the action.

    • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

    • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

      • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

      • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

    • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

    • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

    Action

    Access level

    Resource type

    Condition key

    Dependent action

    cms:CreateDynamicTagGroup

    create

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    TagKey

    string

    Yes

    The tag key of the resource.

    For more information about how to query the tag keys of resources, see DescribeTagKeyList.

    ecs_instance
    ContactGroupList

    array

    Yes

    The alert contact groups. The value of N can be from 1 to 100. Alert notifications for the application group are sent to the alert contacts in these alert contact groups.

    An alert contact group can contain one or more alert contacts. For more information about how to create alert contacts and alert contact groups, see PutContact and PutContactGroup. For more information about how to obtain alert contact groups, see DescribeContactGroupList.

    ECS_Group

    string

    No

    The alert contact groups. The value of N can be from 1 to 100. Alert notifications for the application group are sent to the alert contacts in these alert contact groups.

    An alert contact group can contain one or more alert contacts. For more information about how to create alert contacts and alert contact groups, see PutContact and PutContactGroup. For more information about how to obtain alert contact groups, see DescribeContactGroupList.

    ECS_Group
    MatchExpress

    array<object>

    Yes

    The match expressions that are used to create an application group from tags.

    object

    No

    The match expressions that are used to create an application group from tags. The value of N can be from 1 to 3.

    TagValueMatchFunction

    string

    No

    The method that is used to match the values of resource tags. The value of N is 1. Valid values:

    • contains: includes.

    • startWith: prefix.

    • endWith: suffix.

    • notContains: does not include.

    • equals: equals.

    • all: all.

    Note

    You must specify both the MatchExpress.N.TagValueMatchFunction and MatchExpress.N.TagValue parameters.

    contains
    TagValue

    string

    No

    The value of the resource tag. The value of N is 1.

    Note

    You must specify both the MatchExpress.N.TagValueMatchFunction and MatchExpress.N.TagValue parameters.

    instance
    TagName

    string

    No

    The key of the tag that is used to create the group. If multiple resources have this tag key, the resources that meet the filter conditions are added to the same group based on the same key-value pair.

    appname
    TagRegionId

    string

    No

    The ID of the region to which the tag belongs.

    cn-hangzhou
    EnableSubscribeEvent

    boolean

    No

    Specifies whether to automatically subscribe to event notifications for the application group. When a critical or warning event occurs on a resource in the application group, CloudMonitor sends an alert notification. Valid values:

    • true: enabled.

    • false (default): disabled.

    true
    EnableInstallAgent

    boolean

    No

    Specifies whether to automatically install the CloudMonitor agent for the application group. CloudMonitor automatically installs the agent on the hosts in the application group. Valid values:

    • true: enabled.

    • false (default): disabled.

    true
    MatchExpressFilterRelation

    string

    No

    The relationship between the conditional expressions for the tag values. Valid values:

    • and (default)

    • or

    and
    TemplateIdList

    array

    No

    The ID of the alert template.

    For more information about how to query the IDs of alert templates, see DescribeMetricRuleTemplateList.

    85****

    string

    No

    The ID of the alert template.

    For more information about how to query the IDs of alert templates, see DescribeMetricRuleTemplateList.

    70****

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

    Response elements

    Element

    Type

    Description

    Example

    object

    None.

    Code

    string

    The status code.

    Note

    A status code of 200 indicates that the request was successful.

    200
    Message

    string

    The error message.

    The specified resource is not found.
    RequestId

    string

    The request ID.

    84AC6F0B-7945-466A-AA44-99BB5A561F86
    Success

    boolean

    Indicates whether the operation was successful. Valid values:

    • true: The operation was successful.

    • false: The operation failed.

    true
    Id

    string

    The ID of the tag matching rule.

    2534dc0a-e3e5-4ae1-a2fc-75ef166c****

    Examples

    Success response

    JSON format

    {
  "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
    500 InternalError The request processing has failed due to some unknown error.
    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

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.