All Products
Search
Document Center

CloudMonitor:DescribeContactListByContactGroup

Last Updated:Jul 26, 2024

Queries the alert contacts in an alert contact 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:DescribeContactListByContactGroupget
  • All Resources
    *
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
ContactGroupNamestringYes

The name of the alert contact group.

CloudMonitor

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code.

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

The returned message.

The group is not exists.
RequestIdstring

The request ID.

06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83
Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
Contactsarray<object>

The alert contacts that receive alert notifications.

object
UpdateTimelong

The time when the alert contact was modified.

Unit: milliseconds.

1552314252000
Namestring

The name of the alert contact.

Alice
CreateTimelong

The time when the alert contact was created.

Unit: milliseconds.

1552314252000
Descstring

The description of the alert contact.

ECS
Channelsobject

The alert notification methods.

Mailstring

The email address of the alert contact.

alice@example.com
AliIMstring

The TradeManager ID of the alert contact.

Note This parameter can be returned only on the China site (aliyun.com).
Alice
DingWebHookstring

The webhook URL of the DingTalk chatbot.

https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****
SMSstring

The mobile number of the alert contact.

Note This parameter can be returned only on the China site (aliyun.com).
1333333****

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "The group is not exists.",
  "RequestId": "06D5ECC2-B9BE-42A4-8FA3-1A610FB08B83",
  "Success": true,
  "Contacts": {
    "Contact": [
      {
        "UpdateTime": 1552314252000,
        "Name": "Alice",
        "CreateTime": 1552314252000,
        "Desc": "ECS",
        "Channels": {
          "Mail": "alice@example.com",
          "AliIM": "Alice",
          "DingWebHook": "https://oapi.dingtalk.com/robot/send?access_token=9bf44f8189597d07dfdd7a123455ffc112****",
          "SMS": "1333333****"
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError message
400%s%s
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