获取第三方服务集成的配置
- 用于以编程访问权限Cloud Manager的 OAuth 2.0身份验证作为预览功能。
- 在预览期间，功能和相应的文档可能随时更改。要使用 OAuth 2.0身份验证，请创建一个服务帐户，以便在向Cloud Manager Public API发出的请求中使用。
注意
注意：群组和项目是同义词。您的 {PROJECT-ID} 与您的项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。当引用说明时，此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。
基本 URL： https://cloud.mongodb.com/api/public/v 1.0
语法
GET /groups/{GROUP-ID}/integrations/{INTEGRATION-TYPE}
请求路径参数
Parameter | 必要性 | 说明 |
|---|---|---|
{PROJECT-ID} | 必需 | 项目标识符。 |
{INTEGRATION-TYPE} | 必需 | 第三方服务标识符。 接受的值为：
|
请求查询参数
名称 | 类型 | 必要性 | 说明 | 默认 |
|---|---|---|---|---|
pageNum | 数字 | Optional | 从一开始的整数，用于返回结果的一部分。 | 1 |
itemsPerPage | 数字 | Optional | 每页要返回的项目数，最多 500 个。 | 100 |
pretty | 布尔 | Optional | 指示响应正文是否应采用 美观打印 的标志 格式。 | false |
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 对于返回结果列表的端点， | false |
backupJobsEnabledOnly | 布尔 | Optional | 指示是否从响应中排除未启用备份数据库的守护进程的标志。 将其设置为 false以包含将backupJobsEnabled标志设置为false的守护进程配置。 | true |
请求正文参数
此端点不使用 HTTP 请求正文参数。
响应元素
如果已配置该服务，则响应会返回指定的第三方集成配置对象。 如果尚未配置，响应将返回INTEGRATION_NOT_CONFIGURED错误。
每个第三方集成配置对象都包含一个等于其自身集成类型的type属性（例如"type":
"PAGER_DUTY" ）。 此外，每个第三方服务配置对象都提供特定于该服务的详细信息。 下面列出了为每个第三方服务配置对象返回的属性：
服务 | 结果 | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
PagerDuty | 返回的 PagerDuty 集成配置对象包含以下字段：
| ||||||||||||||||||||
Slack | 返回的 Slack 集成配置对象包含以下字段：
| ||||||||||||||||||||
Opsgenie | 返回的 Opsgenie 集成配置对象包含以下字段：
| ||||||||||||||||||||
VictorOps | 返回的 VictorOps 集成配置对象包含以下字段：
配置对象还可能包含以下字段，具体取决于您的配置：
| ||||||||||||||||||||
Webhook 设置 | 返回的 Webhook 配置对象包含以下字段：
配置对象还可能包含以下字段，具体取决于您的配置：
| ||||||||||||||||||||
Microsoft Teams | 返回的 Microsoft 团队 配置对象将包含以下字段：
| ||||||||||||||||||||
Prometheus | 返回的 Prometheus 配置对象将包含以下字段：
配置对象还可能包含以下字段，具体取决于您的配置：
|
请求示例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/integrations/PAGER_DUTY"
响应示例
{ "serviceKey": "******7890", "type": "PAGER_DUTY" }