All Products
Search
Document Center

CloudMonitor:CreateMonitorGroupByResourceGroupId

Last Updated:Jul 26, 2024

Creates an application group by using a resource group.

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.

Debugging

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

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.
OperationAccess levelResource typeCondition keyAssociated operation
cms:CreateMonitorGroupByResourceGroupIdcreate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
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): 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): The CloudMonitor agent is not automatically installed.
true
RegionIdstringYes

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
ResourceGroupIdstringYes

The ID of the resource group.

For information about how to obtain the ID of a resource group, see ListResourceGroups .

rg-acfmw3ty5y7****
ResourceGroupNamestringYes

The name of the resource group.

For information about how to obtain the name of a resource group, see ListResourceGroups .

CloudMonitor
ContactGroupListarrayYes

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 .

stringYes

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 parameters

ParameterTypeDescriptionExample
object
Codestring

The status code.

Note The status code 200 indicates that the request was successful.
200
Messagestring

The error message.

The specified resource is not found.
RequestIdstring

The request ID.

784CAB3C-F613-5BCE-8469-6DCB29B18A20
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Idlong

The ID of the application group.

3607****

Examples

Sample success responses

JSONformat

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

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.
500InternalErrorThe request processing has failed due to some unknown error.-
4092ParameterInvalidResourceGroupId already create group-

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

Change history

Change timeSummary of changesOperation
No change history