You need to enable JavaScript to run this app.
导航
云监控
  • 文档首页
    • /云监控/API参考/告警联系人/ListContacts
ListContacts
最近更新时间：2024.09.24 18:56:29首次发布时间：2021.11.10 18:21:35
我的收藏

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

请求说明

  • 请求方式：POST
  • 请求地址：https://open.volcengineapi.com?Action=ListContacts&Version=2018-01-01
ServiceName : Volc_Observe
Region : cn-beijing 
AccessKey : xxx
SecretKey : xxx

调试

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

请求参数

Query

参数类型是否必选示例值描述
ActionString是ListContacts接口名称。当前 API 的名称为 ListContacts。
VersionString是2018-01-01接口版本。当前 API 的版本为 2018-01-01。

Body

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

Name

String

否

name1

联系人名称的关键字，支持模糊查询。

  • 不能以数字、中划线开头。
  • 只能包含中文、字母、数字、下划线(_)和中划线(-)。
  • 长度限制在1 ~ 128字符之间。
PhoneString否133****4354联系人电话的关键字，支持模糊查询。
EmailString否jackemail@xxx.com联系人邮箱的关键字，支持模糊查询。

PageNumber

Integer

否

1

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

  • 实际起始位置 = (PageNumber-1) * PageSize
  • 实际终止位置 = PageNumber * PageSize
PageSizeInteger否10分页查询时每页的行数，默认值为10。

返回参数

参数类型示例值描述
DataArray of ContactsVO-符合条件的联系人的详细信息。
PageSizeInteger30分页查询参数，用于设置每页行数。默认值：30。
PageNumberInteger1分页查询参数，用于设置当前页码。默认值：1。
TotalCountInteger2符合条件的联系人总数。

ContactsVO

参数类型示例值描述
IdString145262463627244****联系人ID。
NameStringname1联系人名称。
EmailString1234567****联系人邮箱地址。
PhoneString1234567****联系人手机号码。
ContactGroupsArray of ContactGroupVO-联系人关联的联系组的信息。

ContactGroupVO

参数类型示例值描述
IdString145080093687100****联系组的ID。
NameString默认告警联系组联系组名称。
AccountIdString100000****创建本联系组的账号ID。
CreatedAtString2021-10-20T20:27:53+08:00联系组的创建时间。
UpdatedAtString2021-10-20T20:27:53+08:00联系组的更新时间。
DescriptionStringThis is a group.联系组的描述。

请求示例

POST https://open.volcengineapi.com?Action=ListContacts&Version=2018-01-01
ServiceName: Volc_Observe
Region: cn-beijing
AccessKey: xxx
SecretKey: xxx
{
    "PageSize":10,
    "PageNumber":1,
    "Name":"name1",
    "Phone":"133****4345",
    "Email":"jackemail@xxx.com"
}

返回示例

{
    "ResponseMetadata": {
        "RequestId": "2022092215001701017423503808******",
        "Action": "ListContacts",
        "Version": "2018-01-01",
        "Service": "Volc_Observe",
        "Region": ""
    },
    "Result": {
        "Data": [
            {
                "Id": "145262463627244****",
                "Name": "name1",
                "Phone": "",
                "Email": "name1.account@xxx.com",
                "ContactGroups": [
                    {
                        "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": 3
    }
}

错误码

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