You need to enable JavaScript to run this app.
导航

ListContactGroups

最近更新时间2023.03.31 16:12:20

首次发布时间2021.11.10 18:21:34

调用ListContactGroups接口获取联系组列表,支持搜索联系组名称的关键字进行模糊查询。

Request URL

POST https://open.volcengineapi.com?Action=ListContactGroups&Version=2018-01-01
ServiceName : Volc_Observe
Region : cn-beijing 
AccessKey : xxx
SecretKey : xxx

请求参数

名称

类型

是否必填

示例值

描述

PageSize

Integer

20

分页查询时每页的行数,取值:> 0 ,默认值为10。

PageNumber

Integer

1

列表的页码,默认值为1。要查询的列表范围为:
实际起始位置 = PageNumber * PageSize
实际终止位置 = PageNumber * (PageSize + 1)

Name

String

group

联系组名称的关键字,支持模糊查询。

返回数据

参数

类型

示例值

描述

Data

Array

-

符合条件的联系组的详细信息。具体请参见Data数据结构

PageNumber

Integer

1

当前页码。

PageSize

Integer

10

当前分页的行数。

TotalCount

Integer

4

符合条件的联系组总数。

Data数据结构

参数

类型

示例值

描述

Id

String

145258255725730****

联系组ID。

Name

String

group1

联系组名称。

AccountId

String

100000****

创建该联系组的账号ID。

Description

String

This is a group.

联系组描述。

CreateAt

String

2021-10-25T18:27:24+08:00

联系组的创建时间。

UpdateAt

String

2021-10-25T18:49:43+08:00

联系组的更新时间。

Contacts

Array

-

联系组中的联系信息。具体请参见Contacts数据结构

Contacts数据结构

参数

类型

示例值

描述

Id

String

145080104031932****

联系人ID。

Name

String

name1

联系人名称。

Phone

String

1234567****

联系人电话。

Email

String

name1.account@xxx.com

联系人邮箱地址。

请求示例

POST https://open.volcengineapi.com?Action=ListContactGroups&Version=2018-01-01
ServiceName=Volc_Observe
Region=cn-beijing 
AccessKey=xxx 
SecretKey=xxx 

{
    "PageSize":10,
    "PageNumber":1,
    "Name":""
}

返回示例

{
    "ResponseMetadata":{
        "RequestId":"2022092215001701017423503808******",
        "Action":"ListContactGroups",
        "Version":"2018-01-01",
        "Service":"Volc_Observe",
        "Region":""
    },
    "Result":{
        "Data":[
            {
                "Id":"145258255725730****",
                "Name":"group1",
                "AccountId":"100000****",
                "Description":"This is a group.",
                "CreatedAt":"2021-10-25T18:27:24+08:00",
                "UpdatedAt":"2021-10-25T18:49:43+08:00",
                "Contacts":[
                    {
                        "Id":"145080104031932****",
                        "Name":"name1",
                        "Phone":"1234567****",
                        "Email":"name1.account@xxx.com"
                    },
                    {
                        "Id":"145247681036000****",
                        "Name":"name2",
                        "Phone":"1234567****",
                        "Email":"name2.account@xxx.com"
                    }
                ]
            },
            {
                "Id":"145080093687100****",
                "Name":"默认告警联系组",
                "AccountId":"100000****",
                "Description":"",
                "CreatedAt":"2021-10-20T20:27:53+08:00",
                "UpdatedAt":"2021-10-20T20:27:53+08:00"
            }
        ],
        "PageNumber":1,
        "PageSize":10,
        "TotalCount":4
    }
}
```
`