ListContactGroups--云监控-火山引擎

文档中心

导航

ListContactGroups

最近更新时间：2024.09.24 18:56:29首次发布时间：2021.11.10 18:21:34

获取联系组列表，支持搜索联系组名称的关键字进行模糊查询。

请求说明

请求方式：POST
请求地址：https://open.volcengineapi.com?Action=ListContactGroups&Version=2018-01-01

ServiceName : Volc_Observe
Region : cn-beijing 
AccessKey : xxx
SecretKey : xxx

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

Query

参数	类型	是否必选	示例值	描述
Action	String	是	`ListContactGroups`	接口名称。当前 API 的名称为 `ListContactGroups`。
Version	String	是	`2018-01-01`	接口版本。当前 API 的版本为 `2018-01-01`。

Body

参数类型是否必选示例值描述

Name String 否 group 联系组名称的关键字，支持模糊查询。

PageSize Integer 否 20 分页查询时每页的行数，取值 > 0 ，默认值为10。

参数	类型	是否必选	示例值	描述
Name	String	否	`group`	联系组名称的关键字，支持模糊查询。
PageSize	Integer	否	`20`	分页查询时每页的行数，取值 > 0 ，默认值为10。
PageNumber	Integer	否	`1`	列表的页码，默认值为1。要查询的列表范围为：实际起始位置 = (PageNumber-1) * PageSize 实际终止位置 = PageNumber * PageSize

PageNumber

Integer

否

1

列表的页码，默认值为1。要查询的列表范围为：

实际起始位置 = (PageNumber-1) * PageSize
实际终止位置 = PageNumber * PageSize

返回参数

参数	类型	示例值	描述
Data	Array of ContactGroupVO	`-`	符合条件的联系组的详细信息。
PageSize	Integer	`30`	分页查询参数，用于设置每页行数。默认值：30。
PageNumber	Integer	`1`	分页查询参数，用于设置当前页码。默认值：1。
TotalCount	Integer	`2`	符合条件的联系组总数。

ContactGroupVO

参数	类型	示例值	描述
Id	String	`145080093687100****`	联系组的ID。
Name	String	`默认告警联系组`	联系组名称。
Contacts	Array of ContactsVO	`-`	联系组中的联系信息。
AccountId	String	`100000****`	创建本联系组的账号ID。
CreatedAt	String	`2021-10-20T20:27:53+08:00`	联系组的创建时间。
UpdatedAt	String	`2021-10-20T20:27:53+08:00`	联系组的更新时间。
Description	String	`This is a group.`	联系组的描述。

ContactsVO

参数	类型	示例值	描述
Id	String	`145262463627244****`	联系人ID。
Name	String	`name1`	联系人名称。
Email	String	`1234567****`	联系人邮箱地址。
Phone	String	`1234567****`	联系人手机号码。

请求示例

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
    }
}

错误码

本接口无特有的错误码。更多信息请参见错误码。

云监控