获取联系人列表，支持搜索联系人名称的关键字进行模糊查询。 ## 请求说明 * 请求方式：POST * 请求地址：https://cloudmonitor.cn\-beijing.volcengineapi.com?Action=ListContacts&Version=2018\-01\-01 ## 调试 ## 请求参数 |参数 |类型 |是否必选 |示例值 |描述 | |---|---|---|---|---| |Action |String |是 |ListContacts |接口名称。当前 API 的名称为 `ListContacts`。 | |Version |String |是 |2018\-01\-01 |接口版本。当前 API 的版本为 `2018-01-01`。 | |Name |String |否 |user\-demo |联系人名称的关键字，支持模糊查询。|\ | | | | ||\ | | | | |* 不能以数字、中划线开头。|\ | | | | |* 只能包含中文、字母、数字、下划线`_`和中划线`-`。|\ | | | | |* 长度限制在 1～128 字符之间。 | |Phone |String |否 |133\*\*\*\*4354 |联系人电话的关键字，支持模糊查询。 | |Email |String |否 |user\-demo@example.com |联系人邮箱的关键字，支持模糊查询。 | |PageNumber |Integer |否 |1 |列表的页码，取值 \> 0，默认值为 1。要查询的列表范围为：|\ | | | | ||\ | | | | |* 实际起始位置 = (PageNumber\-1) \* PageSize|\ | | | | |* 实际终止位置 = PageNumber \* PageSize | |PageSize |Integer |否 |10 |分页查询时每页的行数，默认值为10。 | ## 请求示例 ```json POST https://cloudmonitor.cn-beijing.volcengineapi.com?Action=ListContacts&Version=2018-01-01 Content-Type: application/json { "Name": "user-demo", "Email": "user-demo@example.com", "Phone": "133****4354", "PageNumber": 1, "PageSize": 10 } ``` ## 返回参数 |参数 |类型 |示例值 |描述 | |---|---|---|---| |Data |Array of [ContactsVO](#contactsvo) |\- |符合条件的联系人的详细信息。 | |PageSize |Integer |30 |分页查询参数，用于设置每页行数。默认值为 30。 | |PageNumber |Integer |1 |分页查询参数，用于设置当前页码。默认值为 1。 | |TotalCount |Integer |2 |符合条件的联系人总数。 | ### ContactsVO |参数 |类型 |示例值 |描述 | |---|---|---|---| |Id |String |145262463627244\*\*\*\* |联系人 ID。 | |Name |String |user\-demo |联系人名称。 | |Email |String |user\-demo@example.com |联系人邮箱地址。 | |Phone |String |1861283\*\*\*\* |联系人手机号码。 | |ContactGroups |Array of [ContactGroupVO](#contactgroupvo) |\- |联系人关联的联系组的信息。 | ### ContactGroupVO |参数 |类型 |示例值 |描述 | |---|---|---|---| |Id |String |145080093687100\*\*\*\* |联系组 ID。 | |Name |String |默认告警联系组 |联系组名称。 | |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. |联系组的描述。 | ## 返回示例 ```json { "ResponseMetadata": { "Action": "ListContacts", "Region": "cn-beijing", "Service": "cloudmonitor", "Version": "2018-01-01", "RequestId": "20230604110420****100232280022D31" }, "Result": { "Data": [ { "Id": "145262463627244****", "Name": "user-demo", "Email": "user-demo@example.com", "Phone": "1861283****", "ContactGroups": [ { "Id": "145080093687100****", "Name": "默认告警联系组", "AccountId": "100000****", "CreatedAt": "2021-10-20T20:27:53+08:00", "UpdatedAt": "2021-10-20T20:27:53+08:00", "Description": "This is a group." } ] } ] } } ``` ## 错误码本接口无特有的错误码。更多信息请参见 [错误码](https://www.volcengine.com/docs/6408/78947)。

云监控