查询指定联系组的详细信息。
使用限制
调用一次接口最多支持查询100个联系组。
请求说明
- 请求方式：POST
- 请求地址：https://open.volcengineapi.com?Action=ListContactGroupByIds&Version=2018-01-01
ServiceName : Volc_Observe
Region : cn-beijing
AccessKey : xxx
SecretKey : xxx
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
Query
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Action | String | 是 | ListContactGroupByIds | 接口名称。当前 API 的名称为 ListContactGroupByIds。 |
| Version | String | 是 | 2018-01-01 | 接口版本。当前 API 的版本为 2018-01-01。 |
Body
| 参数 | 类型 | 是否必选 | 示例值 | 描述 |
|---|
| Ids | Array of String | 是 | ["145258255725730****","145258255725730****"] | 联系组ID。 |
返回参数
| 参数 | 类型 | 示例值 | 描述 |
|---|
| 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. | 联系组的描述。 |
| 参数 | 类型 | 示例值 | 描述 |
|---|
| Id | String | 145262463627244**** | 联系人ID。 |
| Name | String | name1 | 联系人名称。 |
| Email | String | 1234567**** | 联系人邮箱地址。 |
| Phone | String | 1234567**** | 联系人手机号码。 |
请求示例
POST https://open.volcengineapi.com?Action=ListContactGroupByIds&Version=2018-01-01
ServiceName: Volc_Observe
Region: cn-beijing
AccessKey: xxx
SecretKey: xxx
{
"Ids":[
"145258255725730****",
"145258255725730****"
]
}
返回示例
{
"ResponseMetadata": {
"RequestId": "2022092215001701017423503808******",
"Action": "ListContactGroupByIds",
"Version": "2018-01-01",
"Service": "Volc_Observe",
"Region": ""
},
"Result": {
"Data": [
{
"Id": "145258255725730****",
"Name": "group1",
"AccountId": "100000****",
"Description": "",
"CreatedAt": "2021-10-20T20:28:22+08:00",
"UpdatedAt": "2021-10-20T20:28:22+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"
}
]
}
]
}
}
错误码
本接口无特有的错误码。更多信息请参见错误码。