最近更新时间:2024.03.12 16:52:16
首次发布时间:2021.11.10 18:21:34
调用ListContactGroups接口获取联系组列表,支持搜索联系组名称的关键字进行模糊查询。
POST https://open.volcengineapi.com?Action=ListContactGroups&Version=2018-01-01
ServiceName : Volc_Observe Region : cn-beijing AccessKey : xxx SecretKey : xxx
名称 | 类型 | 是否必填 | 示例值 | 描述 |
---|---|---|---|---|
PageSize | Integer | 否 |
| 分页查询时每页的行数,取值:> 0 ,默认值为10。 |
PageNumber | Integer | 否 |
| 列表的页码,默认值为1。要查询的列表范围为: |
Name | String | 否 |
| 联系组名称的关键字,支持模糊查询。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Data | Array | - | 符合条件的联系组的详细信息。具体请参见Data数据结构。 |
PageNumber | Integer |
| 当前页码。 |
PageSize | Integer |
| 当前分页的行数。 |
TotalCount | Integer |
| 符合条件的联系组总数。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | String |
| 联系组ID。 |
Name | String |
| 联系组名称。 |
AccountId | String |
| 创建该联系组的账号ID。 |
Description | String |
| 联系组描述。 |
CreateAt | String |
| 联系组的创建时间。 |
UpdateAt | String |
| 联系组的更新时间。 |
Contacts | Array | - | 联系组中的联系信息。具体请参见Contacts数据结构。 |
参数 | 类型 | 示例值 | 描述 |
---|---|---|---|
Id | String |
| 联系人ID。 |
Name | String |
| 联系人名称。 |
Phone | String |
| 联系人电话。 |
String |
| 联系人邮箱地址。 |
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 } }