返回 Prometheus 的最新目标
2024 年 8 月 30 日以后,Cloud Manager 将不再支持 MongoDB 3.6 和 4.0 的自动化、备份和监控。请升级您的 MongoDB 部署或迁移到 Atlas。
- 用于以编程访问权限Cloud Manager的 OAuth 2.0身份验证作为预览功能。
- 在预览期间,功能和相应的文档可能随时更改。要使用 OAuth 2.0身份验证,请创建一个服务帐户,以便在向Cloud Manager Public API发出的请求中使用。
注意
注意:群组和项目是同义词。您的 {PROJECT-ID}
与您的项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。当引用说明时,此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。
基本 URL: https://cloud.mongodb.com/prometheus/v1.0
语法
GET /groups/{GROUP-ID}/discovery
请求路径参数
名称 | 类型 | 必要性 | 说明 |
---|---|---|---|
{项目ID} | 字符串 | 必需 | 标识项目的唯一 24 位十六进制数字字符串。 |
请求查询参数
以下查询参数为可选参数:
名称 | 类型 | 必要性 | 说明 | 默认 |
---|---|---|---|---|
pageNum | 数字 | Optional | 从一开始的整数,用于返回结果的一部分。 | 1 |
itemsPerPage | 数字 | Optional | 每页要返回的项目数,最多 500 个。 | 100 |
pretty | 布尔 | Optional | 指示响应正文是否应采用 美观打印 的标志 格式。 | false |
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,在查询中设置 对于返回结果列表的端点, | false |
backupJobsEnabledOnly | 布尔 | Optional | 指示是否从响应中排除未启用备份数据库的守护进程的标志。 将其设置为 false 以包含将backupJobsEnabled 标志设置为false 的守护进程配置。 | true |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应元素
响应包括要抓取的最新 targets的数组以及包含其labels的文档。
名称 | 类型 | 说明 |
---|---|---|
target | 阵列 | 要从中抓取指标的每个 host 和port 。 |
labels | 文档 | 包含区分指标的标签和值的文档。 |
labels.group_id | 字符串 | 标识项目的唯一十六进制数字字符串。 |
labels.group_name | 字符串 | 用于标识项目的人类可读标签。 |
labels.org_id | 字符串 | 标识组织的唯一十六进制数字字符串。 |
请求示例
Sets the `Authorization` header on every scrape request with the configured username and password. The URL that Prometheus fetches the targets from. curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/prometheus/v1.0/groups/{PROJECT-ID}/discovery"
响应示例
[ { "targets":[ "mongodbd-prometheus:9216" ], "labels":{ "group_id":"{PROJECT-ID}", "group_name":"CM-Testing", "org_id":"{ORG-ID}" } } ]