更新第三方服务集成的配置
注意
注意:群组和项目是同义词。您的 {PROJECT-ID}
与您的项目 ID 相同。对于现有群组,群组/项目 ID 保持不变。当引用说明时,此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。
基本 URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
语法
PUT /groups/{GROUP-ID}/integrations/{INTEGRATION-TYPE}
请求路径参数
Parameter | 必要性 | 说明 |
---|---|---|
{PROJECT-ID} | 必需 | 项目标识符。 |
{INTEGRATION-TYPE} | 必需 | 第三方服务标识符。 接受的值为:
|
请求查询参数
名称 | 类型 | 必要性 | 说明 | 默认 |
---|---|---|---|---|
pageNum | 数字 | Optional | 从一开始的整数,用于返回结果的一部分。 | 1 |
itemsPerPage | 数字 | Optional | 每页要返回的项目数,最多 500 个。 | 100 |
pretty | 布尔 | Optional | 指示响应正文是否应采用 prettyprint 格式 的标志 格式。 | false |
envelope | 布尔 | Optional | 指示是否将响应包装在信封中的标志。 某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题,在查询中设置 对于返回结果列表的端点, | false |
backupJobsEnabledOnly | 布尔 | Optional | 指示是否从响应中排除未启用备份数据库的守护进程的标志。 将其设置为 false 以包含将backupJobsEnabled 标志设置为false 的守护进程配置。 | true |
请求正文参数
请求正文应该是单个第三方服务的单个集成视图(如JSON配置对象)。 如果相同type
的配置已存在,则该请求将更新已更改的字段。如果相同type
的配置不存在,则会添加该配置。 始终包含等于第三方服务INTEGRATION_TYPE
的type
属性。
服务 | 配置选项 | ||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
PagerDuty | 配置 PagerDuty 集成时,必须提供以下字段:
| ||||||||||||||||||||||
Slack | 重要Slack集成现在使用 OAuth 2验证方法,并且必须通过MongoDB Atlas 第三方服务集成页面进行初始配置或从传统集成进行更新。 很快将不再支持旧版令牌。 重新配置现有 Slack 集成时,必须提供以下字段:
您还可以包含以下字段:
| ||||||||||||||||||||||
Datadog | 配置 Datadog 集成时,必须提供以下字段:
| ||||||||||||||||||||||
HipChat | 配置 HipChat 集成时,必须提供以下字段:
| ||||||||||||||||||||||
Opsgenie | 配置 Opsgenie 集成时,必须提供以下字段:
要将 | ||||||||||||||||||||||
VictorOps | 配置 VictorOps 集成时,必须提供以下字段:
您还可以包含以下字段:
| ||||||||||||||||||||||
Webhook 设置 | 配置 Webhook 设置时,必须提供以下字段:
您还可以包含以下字段:
| ||||||||||||||||||||||
Microsoft Teams | 配置 Microsoft Teams 集成时,必须提供以下字段:
| ||||||||||||||||||||||
Prometheus | 配置 Prometheus 集成时,必须提供以下字段:
您还可以包含以下字段:
|
响应元素
响应包括一个results
数组(将项目的所有第三方集成配置列为对象)以及与项目集成的服务的totalCount
。
每个第三方集成配置对象都包含一个等于其自身集成类型的type
属性(对于 PagerDuty 服务为"type":
"PAGER_DUTY"
)。 此外,每个第三方服务配置对象都提供特定于该服务的详细信息。 下面列出了为每个第三方服务配置对象返回的属性:
服务 | 结果 | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
PagerDuty | 返回的 PagerDuty 集成配置对象包含以下字段:
| ||||||||||||||||||||
Slack | 返回的 Slack 集成配置对象包含以下字段:
| ||||||||||||||||||||
Datadog | 返回的 Datadog 集成配置对象包含以下字段:
| ||||||||||||||||||||
HipChat | 返回的 HipChat 集成配置对象包含以下字段:
| ||||||||||||||||||||
Opsgenie | 返回的 Opsgenie 集成配置对象包含以下字段:
要将 | ||||||||||||||||||||
VictorOps | 返回的 VictorOps 集成配置对象包含以下字段:
配置对象还可能包含以下字段,具体取决于您的配置:
| ||||||||||||||||||||
Webhook 设置 | 返回的 Webhook 配置对象包含以下字段:
配置对象还可能包含以下字段,具体取决于您的配置:
| ||||||||||||||||||||
Microsoft Teams | 返回的 Microsoft 团队 配置对象将包含以下字段:
| ||||||||||||||||||||
Prometheus | 返回的 Prometheus 配置对象将包含以下字段:
配置对象还可能包含以下字段,具体取决于您的配置:
|
请求示例
1 curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ 2 --header "Accept: application/json" \ 3 --header "Content-Type: application/json" \ 4 --include \ 5 --request PUT "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/integrations/SLACK" \ 6 --data ' 7 { 8 "type": "SLACK", 9 "apiToken": "1234567890", 10 "teamName": "My Team" 11 }'
响应示例
1 { 2 "links": [ 3 { 4 "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/integrations/SLACK?pageNum=1&itemsPerPage=100", 5 "rel": "self" 6 } 7 ], 8 "results": [ 9 { 10 "serviceKey": "******7890", 11 "type": "PAGER_DUTY" 12 }, 13 { 14 "apiToken": "******7890", 15 "channelName": "My Channel", 16 "teamName": "My Team", 17 "type": "SLACK" 18 } 19 ], 20 "totalCount": 2 21 }