All Products
Search
Document Center

CloudMonitor:DescribeContactGroupList

Last Updated:Jul 26, 2024

Queries alert groups.

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

Request parameters

ParameterTypeRequiredDescriptionExample
PageSizeintegerNo

The number of entries to return on each page.

1
PageNumberintegerNo

The number of the page to return.

10

Response parameters

ParameterTypeDescriptionExample
object
Codestring

The HTTP status code.

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

The returned message.

The Request is not authorization.
RequestIdstring

The ID of the request.

916EE694-03C2-47B6-85EE-5054E3C168D3
Totalinteger

The total number of the returned entries.

22
Successboolean

Indicates whether the call was successful. Valid values:

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

The names of alert groups.

string
{ "ContactGroup": [ "ECS_Group", "Jim" ] }
ContactGroupListarray<object>

The information about alert groups that were queried.

object
Describestring

The description of the alert group.

UpdateTimelong

The time when the alert group was modified. This value is a UNIX timestamp that represents the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1589447759000
CreateTimelong

The time when the alert group was created. This value is a UNIX timestamp that represents the number of milliseconds that have elapsed since January 1, 1970, 00:00:00 UTC.

1507070598000
EnabledWeeklyReportboolean

Indicates whether the alert group can subscribe to weekly reports. Valid values:

  • true: The alert group can subscribe to weekly reports.
  • false: The alert group cannot subscribe to weekly reports.
Note The weekly report subscription feature is only available for Alibaba Cloud accounts with more than five Elastic Compute Service (ECS) instances.
true
Namestring

The name of the alert group.

Contact1
EnableSubscribedboolean

Indicates whether the alert group subscribes to weekly reports. Valid values:

  • true: The alert group subscribes to weekly reports.
  • false: The alert group does not subscribe to weekly reports.
true
Contactsarray

The alert contacts in the alert group.

string
Jimmy

Examples

Sample success responses

JSONformat

{
  "Code": "200",
  "Message": "The Request is not authorization.",
  "RequestId": "916EE694-03C2-47B6-85EE-5054E3C168D3",
  "Total": 22,
  "Success": true,
  "ContactGroups": {
    "ContactGroup": [
      "{ \"ContactGroup\": [ \"ECS_Group\", \"Jim\" ] }"
    ]
  },
  "ContactGroupList": {
    "ContactGroup": [
      {
        "Describe": "",
        "UpdateTime": 1589447759000,
        "CreateTime": 1507070598000,
        "EnabledWeeklyReport": true,
        "Name": "Contact1",
        "EnableSubscribed": true,
        "Contacts": {
          "Contact": [
            "Jimmy"
          ]
        }
      }
    ]
  }
}

Error codes

HTTP status codeError codeError message
400InvalidParameter%s
403InvalidAuthorization%s
404ResourceNotFound%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