All Products
Search
Document Center

Application Real-Time Monitoring Service:CreateOrUpdateContactGroup

Last Updated:Nov 05, 2024

Creates or modifies an alert contact group.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

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

Request parameters

ParameterTypeRequiredDescriptionExample
ContactGroupIdlongNo

The ID of the alert contact group.

  • If you do not specify this parameter, an alert contact group is created.
  • If you specify this parameter, the specified alert contact group is modified.
123
ContactGroupNamestringYes

The name of the alert contact group.

TestGroup
ContactIdsstringNo

The ID of the contact that you want to add to the contact group. Separate multiple IDs with commas (,).

[1,2,3]

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The request ID.

9319A57D-2D9E-472A-B69B-CF3CD16D****
AlertContactGroupobject

The information about the alert contact group.

ContactGroupIdfloat

The ID of the alert contact group.

123
ContactGroupNamestring

The name of the alert contact group.

TestGroup
ContactIdsstring

The IDs of the contacts that are included in the alert contact group.

[1,2,3]

Examples

Sample success responses

JSONformat

{
  "RequestId": "9319A57D-2D9E-472A-B69B-CF3CD16D****",
  "AlertContactGroup": {
    "ContactGroupId": 123,
    "ContactGroupName": "TestGroup",
    "ContactIds": "[1,2,3]"
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
No change history