PutMonitorGroupDynamicRule

Updated at:

Creates or modifies an application group that dynamically matches instances by name. All instances that meet the matching rules are automatically added to the application 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:PutMonitorGroupDynamicRule

create

*MonitorGroup

acs:cms::{#accountId}:group/{#groupId}

None None

Request parameters

Parameter

Type

Required

Description

Example

GroupId

integer

Yes

The ID of the application group.

123456

GroupRules

array<object>

Yes

None.

array<object>

No

None.

FilterRelation

string

Yes

The combination condition for dynamic matching rules. Valid values of N: 1 to 3. Valid values:

  • and: Only instances that meet all matching rules are automatically added to the application group.

  • or: Instances that meet any matching rule are automatically added to the application group.

and

Filters

array<object>

Yes

None.

object

No

None.

Value

string

Yes

The value that meets the matching condition. Valid values of N: 1 to 3.

nginx

Name

string

Yes

The field name for instance matching. Valid values of N: 1 to 3.

Currently, only the hostname is supported, such as hostName.

hostName

Function

string

Yes

The filter condition for instances. Valid values of N: 1 to 3. Valid values:

  • contains: Includes.

  • notContains: Does not include.

  • startWith: Prefix.

  • endWith: Suffix.

contains

Category

string

Yes

The type of Alibaba Cloud service for the dynamic alert rule. Valid values of N: 1 to 3. Valid values:

  • ecs: Elastic Compute Service server.

  • rds: relational database.

  • slb: load balancing.

ecs

IsAsync

boolean

No

The mode for creating the dynamic matching rule. Valid values:

  • true: Asynchronous creation.

  • false (default): Synchronous creation.

false

DryRun

boolean

No

Specifies whether to only precheck the request. Valid values:

  • true: sends a check request. No security group is associated with the instance. The system checks whether required parameters are specified, the request format is valid, and service limits are met. If the check fails, an error is returned. If the check succeeds, the error code DryRunOperation is returned.

  • false (default): sends a normal request. If the check succeeds, an HTTP 2xx status code is returned and the operation is performed.

false

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

Response elements

Element

Type

Description

Example

object

Code

integer

The HTTP status code.

Note

A status code of 200 indicates success.

200

Message

string

The error message.

The specified resource is not found.

RequestId

string

The request ID.

3E73F1AB-D195-438A-BCA7-2F4355789C58

Success

boolean

Indicates whether the operation was successful. Valid values:

  • true: The operation was successful.

  • false: The operation failed.

true

Examples

Success response

JSON format

{
  "Code": 200,
  "Message": "The specified resource is not found.",
  "RequestId": "3E73F1AB-D195-438A-BCA7-2F4355789C58",
  "Success": true
}

Error codes

HTTP status code

Error code

Error message

Description

400 ParameterInvalid %s
401 AccessDeniedException You donot have sufficient access to perform this action.
412 OverLimit Matched instances count was over limit
412 DryRunOperation %s. dryRun Pre-Verification Results
500 InternalError The request processing has failed due to some unknown error.
402 LimitExceeded The quota for this customer had been reached.
403 AccessForbidden %s
206 %s %s
404 ResourceNotFound The specified resource is not found. The specified resource is not found.
503 %s %s
406 %s %s
429 Throttli∂ngException The request was denied due to request throttling.
409 %s %s

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.