All Products
Search
Document Center

CloudMonitor:PutContactGroup

Last Updated:Jul 26, 2024

Operation description

This topic provides an example on how to create an alert contact group named 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

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:PutContactGroupcreate
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ContactGroupNamestringYes

The name of the alert contact group.

For information about how to obtain the name of an alert contact group, see DescribeContactGroupList .

ECS_Group
DescribestringNo

The description of the alert contact group.

ECS_Alert_Group
EnableSubscribedbooleanNo

Specifies whether to enable the weekly report subscription feature. Valid values:

  • true: The weekly report subscription feature is enabled.
  • false: The weekly report subscription feature is disabled.
Note You can enable the weekly report subscription only for an Alibaba Cloud account that has at least five Elastic Compute Service (ECS) instances.
true
ContactNamesarrayNo
stringNo

The name of the alert contact. Valid values of N: 1 to 100.

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code.

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

The error message.

Illegal parameters.
RequestIdstring

The ID of the request.

B4E30DB6-F069-5D0B-A589-2A89F7D62A57
Successboolean

Indicates whether the call was successful. Valid values:

  • true: The call was successful.
  • false: The call failed.
true

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "Illegal parameters.",
  "RequestId": "B4E30DB6-F069-5D0B-A589-2A89F7D62A57",
  "Success": true
}

Error codes

HTTP status codeError codeError message
400InvalidParameterValueIllegal parameters
400InvalidParameterValue%s
403InvalidAuthorization%s
404ContactGroup.NotExistsContactGroup not exists
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
No change history