查看报警通知的接收组列表。
请求说明
- 请求方式:POST
- 请求地址:https://open.volcengineapi.com?Action=PCGroupSearch&Version=2022-10-28
ServiceName : apmplus_openapi
Region : cn-beijing
X-App-Ids : xxx
Content-Type : application/json
请求参数
Query
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|
Action | String | 是 | PCGroupSearch | 接口名称。当前 API 的名称为 PCGroupSearch 。 |
Version | String | 是 | 2022-10-28 | 接口版本。当前 API 的版本为 2022-10-28 。 |
Body
参数 | 类型 | 是否必选 | 示例值 | 描述 |
---|
os | String | 否 | pc | 服务类型。 |
keyword | String | 否 | group | 搜索关键词。 |
page_no | Integer | 是 | 1 | 页码。 |
page_size | Integer | 是 | 10 | 每页项数。 |
返回参数
SearchGroupResponseData
参数 | 类型 | 示例值 | 描述 |
---|
total | Integer | 100 | 总数。 |
groups | Array of Group | - | 接收组列表。 |
Group
参数 | 类型 | 示例值 | 描述 |
---|
emails | Array of String | 接收组名称 | 接收组名称。 |
op_user | String | zhangsan | 更新操作人。 |
group_id | Integer | 123 | 接收组ID。 |
group_name | String | bug修复 | 接收组名称。 |
phone_numbers | Array of String | ["183****2313"] | 电话列表。 |
请求示例
POST https://open.volcengineapi.com?Action=PCGroupSearch&Version=2022-10-28
{
"page_no": 1,
"page_size": 10,
"os": "pc",
"keyword": "group"
}
返回示例
{
"data": {
"total": 100,
"groups": [
{
"emails": [
"zhangsan@example.com"
],
"op_user": "zhangsan",
"group_id": 123,
"group_name": "group123",
"phone_numbers": [
"183****2313"
]
}
]
},
"error_msg": "",
"error_no": 200
}
错误码
本接口无特有的错误码。更多信息请参见错误码。