CreateMonitorGroupByResourceGroupId - Cloud Monitor - Alibaba Cloud Documentation Center

Operation description

This topic provides an example on how to create an application group by using the resource group CloudMonitor and the alert contact group ECS_Group. The region ID of the resource group is cn-hangzhou.

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:CreateMonitorGroupByResourceGroupId

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
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): 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): The CloudMonitor agent is not automatically installed.	true
RegionId	string	Yes	The ID of the region where the resource group resides. For information about how to obtain the ID of the region where a resource group resides, see GetResourceGroup.	cn-hangzhou
ResourceGroupId	string	Yes	The ID of the resource group. For information about how to obtain the ID of a resource group, see ListResourceGroups.	rg-acfmw3ty5y7****
ResourceGroupName	string	Yes	The name of the resource group. For information about how to obtain the name of a resource group, see ListResourceGroups.	CloudMonitor
ContactGroupList	array	Yes	The alert contact groups. 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
	string	No	The alert contact group. 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

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

Response elements

Element	Type	Description	Example
	object
Code	string	The status code. Note The status code 200 indicates that the request was successful.	200
Message	string	The error message.	The specified resource is not found.
RequestId	string	The request ID.	784CAB3C-F613-5BCE-8469-6DCB29B18A20
Success	boolean	Indicates whether the request was successful. Valid values: true false	true
Id	integer	The ID of the application group.	3607****

Examples

Success response

JSON format

{
  "Code": "200",
  "Message": "The specified resource is not found.",
  "RequestId": "784CAB3C-F613-5BCE-8469-6DCB29B18A20",
  "Success": true,
  "Id": 0
}

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.
4092	ParameterInvalid	ResourceGroupId already create group

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.