All Products
Search

This Product

    CloudMonitor:CreateDynamicTagGroup

    Document Center

    CloudMonitor:CreateDynamicTagGroup

    Last Updated:Mar 01, 2024

    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.

    Authorization information

    There is currently no authorization information disclosed in the API.

    Request parameters

    ParameterTypeRequiredDescriptionExample
    TagKeystringYes

    The tag keys of the cloud resources.

    For more information about how to obtain tag keys, see DescribeTagKeyList .

    		ecs_instance
    ContactGroupListarrayYes
    stringYes

    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
    MatchExpressobject []Yes
    TagValueMatchFunctionstringNo

    The method that is used to match the tag values of the cloud resources. In this example, 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
    TagValuestringNo

    The tag values of the cloud resources. In this example, 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
    TagNamestringNo

    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
    TagRegionIdstringNo

    The ID of the region to which the tags belong.

    		cn-hangzhou
    EnableSubscribeEventbooleanNo

    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
    EnableInstallAgentbooleanNo

    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
    MatchExpressFilterRelationstringNo

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

    • and (default value)
    • or
    		and
    TemplateIdListarrayNo
    stringNo

    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

    ParameterTypeDescriptionExample
    object
    Codestring

    The HTTP status code.

    Note The status code 200 indicates that the call is successful.
    		200
    Messagestring

    The error message.

    		The specified resource is not found.
    RequestIdstring

    The ID of the request.

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

    Indicates whether the call is successful. Valid values:

    • true: The call is successful.
    • false: The call fails.
    		true
    Idstring

    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 codeError codeError messageDescription
    400ParameterInvalid%s-
    403AccessForbiddenUser not authorized to operate on the specified resource.-
    404ResourceNotFoundThe specified resource is not found.The specified resource is not found.
    429ResourceOverLimit%s-
    500InternalErrorThe request processing has failed due to some unknown error.-

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

    Change history

    Change timeSummary of changesOperation
    2023-03-15The Error code has changedsee changesets
    Change itemChange content
    Error CodesThe Error code has changed.
      delete Error Codes: 400
      delete Error Codes: 403
      delete Error Codes: 404
      delete Error Codes: 429
      delete Error Codes: 500