查询告警联系人分组信息。
调试
您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ContactGroupName |
string |
否 |
告警联系人组名称。 |
TestGroup |
| Page |
integer |
是 |
查询页数。 |
1 |
| Size |
integer |
是 |
每页展示的联系人组数。 |
20 |
| IsDetail |
boolean |
否 |
返回的联系人分组信息中是否包含所有联系人。
|
true |
| GroupIds |
string |
否 |
联系人组 ID。 |
12345 |
| RegionId |
string |
否 |
地域 ID。 |
cn-hangzhou |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
请求 ID。 |
4D6C358A-A58B-4F4B-94CE-F5AAF023**** |
| PageBean |
object |
分页对象。 |
|
| Total |
integer |
查询到的联系人组总数。 |
1 |
| Page |
integer |
查询的页数。 |
1 |
| Size |
integer |
每页的联系人组数。 |
20 |
| AlertContactGroups |
array<object> |
告警联系人组列表。 |
|
|
array<object> |
|||
| ContactGroupId |
number |
告警联系人组 ID。 |
123 |
| ContactGroupName |
string |
告警联系人组名称。 |
TestGroup |
| Contacts |
array<object> |
联系人信息。IsDetail 设置为 |
|
|
object |
|||
| ContactId |
number |
联系人 ID。 |
456 |
| ContactName |
string |
联系人姓名。 |
John Doe |
| Phone |
string |
联系人手机号码。 |
1381111**** |
|
string |
联系人邮箱地址。 |
someone@example.com |
|
| ArmsContactId |
integer |
告警联系人 ID。 |
100117 |
| ArmsContactGroupId |
integer |
告警联系人组 ID。 |
83261 |
示例
正常返回示例
JSON格式
{
"RequestId": "4D6C358A-A58B-4F4B-94CE-F5AAF023****",
"PageBean": {
"Total": 1,
"Page": 1,
"Size": 20,
"AlertContactGroups": [
{
"ContactGroupId": 123,
"ContactGroupName": "TestGroup",
"Contacts": [
{
"ContactId": 456,
"ContactName": "John Doe",
"Phone": "1381111****",
"Email": "someone@example.com",
"ArmsContactId": 100117
}
],
"ArmsContactGroupId": 83261
}
]
}
}错误码
访问错误中心查看更多错误码。
变更历史
更多信息，参考变更详情。