托管 Prometheus
托管 Prometheus
托管 Prometheus
文档指南
请输入
产品动态
Prometheus 基础知识
用户指南
工作区
告警中心
接入指南
容器与自建集群接入
自建 Kubernetes 集群接入
最佳实践
Prometheus 数据采集与接入
资源与业务监控
工作区数据写入和查询
多渠道告警通知
API 参考
工作区
告警中心
联系人
告警规则
告警静默策略
SDK 参考
指标参考
容器服务指标
常见问题
视频帮助
- 文档首页
托管 PrometheusAPI 参考告警中心联系人ListContactGroups
复制全文
下载 pdfListContactGroups
文档反馈
问问助手获取告警联系人组列表。
请求说明
- 请求方式：POST
- 请求地址：https://vmp.cn-beijing.volcengineapi.com?Action=ListContactGroups&Version=2021-03-03
调试
API Explorer
您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。
请求参数
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Action | String | 是 | ListContactGroups | 接口名称。当前 API 的名称为 ListContactGroups。 |
Version | String | 是 | 2021-03-03 | 接口版本。当前 API 的版本为 2021-03-03。 |
PageNumber | Long | 否 | 1 | 前页数，最小值或默认值均为 1。 |
PageSize | Long | 否 | 10 | 单页数量：
|
Filter | 否 | - | 联系人组过滤条件。 | |
SortBy | String | 否 | CreatedAt | 查询结果是否进行排序，取值CreatedAt表示进行排序；不配置该字段表示不进行排序。 |
SortOrder | String | 否 | Asc | 查询结果的排序原则，取值：
|
ContactGroupFilter
参数 | 类型 | 是否必选 | 示例值 | 描述 |
参数 | 类型 | 是否必选 | 示例值 | 描述 |
Ids | Array of String | 否 | ["e28ae750-bbb8-4ff4-abf4***"] | 按联系人组 ID 过滤，精确查询。 |
Name | String | 否 | test | 按联系人组名称过滤，模糊查询。 |
请求示例
POST https://vmp.cn-beijing.volcengineapi.com?Action=ListContactGroups&Version=2021-03-03
Content-Type: application/json
{
"PageNumber": 1,
"PageSize": 10,
"Filter": {
"Ids": [
"e28ae750-bbb8-4ff4-abf4***"
],
"Name": "test"
},
"SortBy": "CreatedAt",
"SortOrder": "Asc"
}
返回参数
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
Total | Long | 100 | 联系人组总数。 |
Items | - | 联系人组列表。 |
ContactGroup
参数 | 类型 | 示例值 | 描述 |
参数 | 类型 | 示例值 | 描述 |
Id | String | e28ae750-bbb8-4ff4-abf4*** | 联系人组 ID。 |
Name | String | test | 联系人组名称。 |
ContactIds | Array of String | ["e28ae750-bbb8-4ff4-abf4***"] | 属于该联系人组的联系人 ID 列表。 |
CreateTime | String | 2020-01-01T00:00:00Z | 联系人组创建时间，RFC3339 格式。 |
返回示例
HTTP/1.1: 200 OK
Content-Type: application/json
{
"ResponseMetadata": {
"RequestId": "20230604110420****100232280022D31",
"Action": "ListContactGroups",
"Version": "2021-03-03",
"Service": "vmp",
"Region": "cn-beijing"
},
"Result": {
"Total": 100,
"Items": [
{
"Id": "e28ae750-bbb8-4ff4-abf4***",
"Name": "test",
"ContactIds": [
"e28ae750-bbb8-4ff4-abf4***"
],
"CreateTime": "2020-01-01T00:00:00Z"
}
]
}
}
错误码
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
HTTP 状态码 | 错误码 | 错误信息 | 说明 |
400 | InvalidParameter.{{parameter}} | The specified parameter {{parameter}} is invalid. | 输入不合法，如工作区名称不合法等。 |
403 | ProductUnsubscribed | You are not subscribed to VMP. Please go to the VMP console web page to subscribe to the service | 当前账号未订阅 VMP 服务。 |
最近更新时间：2025.11.05 17:12:26
这个页面对您有帮助吗？
有用
有用
无用
无用