All Products
Search
Document Center

Application Real-Time Monitoring Service:DescribeContactGroups

Last Updated:Nov 05, 2024

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

Request parameters

ParameterTypeRequiredDescriptionExample
ContactGroupNamestringNo

The name of the alert contact group.

TestGroup
PagelongYes

The number of the page to return.

1
SizelongYes

The number of alert contact groups displayed on each page.

20
IsDetailbooleanNo

Specifies whether to return all the alert contacts in the queried alert contact group. Valid values:

  • false
  • true
true
GroupIdsstringNo

The ID of the alert contact group.

12345
RegionIdstringNo

The region ID.

cn-hangzhou

Response parameters

ParameterTypeDescriptionExample
object

Schema of Response

RequestIdstring

The ID of the request.

4D6C358A-A58B-4F4B-94CE-F5AAF023****
PageBeanobject

The objects that were returned.

Totallong

The total number of alert contact groups.

1
Pagelong

The page number of the returned page.

1
Sizelong

The number of alert contact groups displayed on each page.

20
AlertContactGroupsarray<object>

The name of the alert contact group.

contactGroupsobject
ContactGroupIdfloat

The ID of the alert contact group.

123
ContactGroupNamestring

The name of the alert contact group.

TestGroup
Contactsarray<object>

The contact information. If the IsDetail parameter is set to false, no contact information is displayed.

contactsobject
ContactIdfloat

The ID of the alert contact.

456
ContactNamestring

The name of the alert contact.

John Doe
Phonestring

The mobile number of the alert contact.

1381111****
Emailstring

The email address of the alert contact.

someone@example.com
ArmsContactIdlong

The ID of the alert contact.

100117
ArmsContactGroupIdlong

The ID of the alert contact group.

83261

Examples

Sample success responses

JSONformat

{
  "RequestId": "4D6C358A-A58B-4F4B-94CE-F5AAF023****",
  "PageBean": {
    "Total": 1,
    "Page": 1,
    "Size": 20,
    "AlertContactGroups": [
      {
        "ContactGroupId": 123,
        "ContactGroupName": "TestGroup",
        "Contacts": [
          {
            "ContactId": 456,
            "ContactName": "John Doe",
            "Phone": "1381111****",
            "Email": "someone@example.com",
            "ArmsContactId": 100117
          }
        ],
        "ArmsContactGroupId": 83261
      }
    ]
  }
}

Error codes

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

Change history

Change timeSummary of changesOperation
2023-04-28The request parameters of the API has changedView Change Details