更新第三方服务集成的配置

在此页面上

语法

请求路径参数
请求查询参数
请求正文参数
响应元素
请求示例
响应示例

注意

注意：群组和项目是同义词。您的 {PROJECT-ID} 与您的项目 ID 相同。对于现有群组，群组/项目 ID 保持不变。当引用说明时，此页面将使用“群组”这个更为人熟知的术语。端点仍如文档中所述。

基本 URL： https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

语法

PUT /groups/{GROUP-ID}/integrations/{INTEGRATION-TYPE}

请求路径参数

范围	必要性	说明
`{PROJECT-ID}`	必需	项目标识符。
`{INTEGRATION-TYPE}`	必需	第三方服务标识符。接受的值为： `DATADOG` `HIP_CHAT` `PAGER_DUTY` `SLACK` `NEW_RELIC` `OPS_GENIE` `VICTOR_OPS` `WEBHOOK`

请求查询参数

名称	类型	必要性	说明	默认
pageNum	数字	Optional	从一开始的整数，用于返回结果的一部分。	`1`
itemsPerPage	数字	Optional	每页要返回的项目数，最多 500 个。	`100`
pretty	布尔	Optional	指示响应正文是否应采用 Prettyprint 格式的标志格式。	`false`
envelope	布尔	Optional	指示是否将响应包装在信封中的标志。某些 API 客户端无法访问 HTTP 响应标头或状态代码。要修复此问题，在查询中设置 `envelope : true`。对于返回结果列表的端点， `results`对象是一个信封。 Ops Manager 将`status`字段添加到响应正文。	`false`
backupJobsEnabledOnly	布尔	Optional	指示是否从响应中排除未启用备份数据库的守护进程的标志。将其设置为`false`以包含将`backupJobsEnabled`标志设置为`false`的守护进程配置。	`true`

请求正文参数

请求正文应该是单个第三方服务的单个集成视图（如JSON配置对象）。如果相同type的配置已存在，则该请求将更新已更改的字段。如果相同type的配置不存在，则会添加该配置。始终包含等于第三方服务INTEGRATION_TYPE的type属性。

服务

配置选项

PagerDuty

配置 PagerDuty 集成时，必须提供以下字段：

属性

说明

type

PAGER_DUTY

serviceKey

您的集成密钥。

重要

更改集成密钥不会更改使用此集成的任何警报。这些警报仍使用以前的集成密钥。

删除并重新添加每个 PagerDuty 通知以使用新密钥。

注意

所有新的 PagerDuty 密钥均使用其 Events API v2 。如果您有 Events API v1 密钥，则可以继续在 Ops Manager 中使用该密钥。

注意

创建需要 API 或集成密钥的第三方集成后，当您执行以下操作时，该密钥将显示为部分经过校订的：

通过用户界面查看或编辑警报。
通过API查询第三方集成设置。

Slack

重要

Slack 集成现在使用 OAuth2 验证方法，必须通过 MongoDB Atlas第三方服务集成页面进行初始配置或从旧版集成进行更新。

很快将不再支持旧版令牌。

重新配置现有 Slack 集成时，必须提供以下字段：

属性	说明
`type`	`SLACK`
`apiToken`	您的 API 令牌。注意创建需要 API 或集成密钥的第三方集成后，当您执行以下操作时，该密钥将显示为部分经过校订的：通过用户界面查看或编辑警报。通过API查询第三方集成设置。
`teamName`	你的团队名称。

您还可以包含以下字段：

属性	说明
`channelName`	要重新配置的渠道名称。

Datadog

配置 Datadog 集成时，必须提供以下字段：

属性	说明
`type`	`DATADOG`
`apiKey`	您的 API 密钥。注意创建需要 API 或集成密钥的第三方集成后，当您执行以下操作时，该密钥将显示为部分经过校订的：通过用户界面查看或编辑警报。通过API查询第三方集成设置。

HipChat

配置 HipChat 集成时，必须提供以下字段：

属性	说明
`type`	`HIP_CHAT`
`notificationToken`	HipChat 用户帐户的通知令牌。注意创建需要 API 或集成密钥的第三方集成后，当您执行以下操作时，该密钥将显示为部分经过校订的：通过用户界面查看或编辑警报。通过API查询第三方集成设置。
`roomName`	您的 HipChat 房间名称。

Opsgenie

配置 Opsgenie 集成时，必须提供以下字段：

属性	说明
`type`	`OPS_GENIE`
`apiKey`	您的 API 密钥。注意创建需要 API 或集成密钥的第三方集成后，当您执行以下操作时，该密钥将显示为部分经过校订的：通过用户界面查看或编辑警报。通过API查询第三方集成设置。
`region`	指示使用哪个 API URL，可以是`US`或`EU` 。默认情况下，Opsgenie 将使用`US` 。

注意

要将region设置为EU ，您必须将客户设置设为 opsgenie.api.url 。

VictorOps

配置 VictorOps 集成时，必须提供以下字段：

属性	说明
`type`	`VICTOR_OPS`
`apiKey`	您的 API 密钥。注意创建需要 API 或集成密钥的第三方集成后，当您执行以下操作时，该密钥将显示为部分经过校订的：通过用户界面查看或编辑警报。通过API查询第三方集成设置。

您还可以包含以下字段：

属性	说明
`routingKey`	路由键的可选字段。

Webhook 设置

配置 Webhook 设置时，必须提供以下字段：

属性	说明
`type`	`WEBHOOK`
`url`	您的 Webhook URL。

您还可以包含以下字段：

属性	说明
`secret`	Webhook 密钥的可选字段。注意创建 Webhook 通知后，当您查看或编辑警报时，URL 将显示为部分校订的，而密钥将显示为已完全校订的。

Microsoft Teams

配置 Microsoft Teams 集成时，必须提供以下字段：

属性	说明
`type`	`MICROSOFT_TEAMS`
`microsoftTeamsWebhookUrl`	您的 Microsoft 团队传入 Webhook URL。注意当您查看或编辑 Webhook 通知的警报时，URL 会显示为部分遮蔽，而密钥显示为完全遮蔽。

Prometheus

配置 Prometheus 集成时，必须提供以下字段：

属性	说明
`type`	`PROMETHEUS`
`username`	您的 Prometheus 用户名。
`password`	您的 Prometheus 密码。
`listenAddress`	Prometheus 实例将连接的 IP 地址和端口。
`serviceDiscovery`	指示使用哪种服务发现方法，为`file`或`http` 。
`scheme`	为请求配置的 Prometheus 协议模式，可以是`http`或`https` 。如果配置`https` ，则必须指定`tlsPemPath` 。
`enabled`	您的集群是否启用了 Prometheus。

您还可以包含以下字段：

属性	说明
`tlsPemPassword`	PEM 文件密码的可选字段。
`tlsPemPath`	PEM 文件绝对路径的可选字段。

响应元素

响应包括一个results数组（将项目的所有第三方集成配置列为对象）以及与项目集成的服务的totalCount 。

每个第三方集成配置对象都包含一个等于其自身集成类型的type属性（对于 PagerDuty 服务为"type": "PAGER_DUTY" ）。此外，每个第三方服务配置对象都提供特定于该服务的详细信息。下面列出了为每个第三方服务配置对象返回的属性：

服务

结果

PagerDuty

返回的 PagerDuty 集成配置对象包含以下字段：

属性	说明
`type`	`PAGER_DUTY`
`serviceKey`	您的服务密钥。注意创建需要 API 或集成密钥的第三方集成后，当您执行以下操作时，该密钥将显示为部分经过校订的：通过用户界面查看或编辑警报。通过API查询第三方集成设置。

Slack

返回的 Slack 集成配置对象包含以下字段：

属性	说明
`type`	`SLACK`
`apiToken`	您的 API 令牌。注意创建需要 API 或集成密钥的第三方集成后，当您执行以下操作时，该密钥将显示为部分经过校订的：通过用户界面查看或编辑警报。通过API查询第三方集成设置。
`teamName`	你的团队名称。旧版 Slack 集成中可能不存在此字段。
`channelName`	配置的 Slack 渠道名称。如果未设置该值，则为空字符串。

Datadog

返回的 Datadog 集成配置对象包含以下字段：

属性	说明
`type`	`DATADOG`
`apiKey`	您的 API 密钥。注意创建需要 API 或集成密钥的第三方集成后，当您执行以下操作时，该密钥将显示为部分经过校订的：通过用户界面查看或编辑警报。通过API查询第三方集成设置。

HipChat

返回的 HipChat 集成配置对象包含以下字段：

属性	说明
`type`	`HIP_CHAT`
`notificationToken`	HipChat 用户帐户的通知令牌。注意创建需要 API 或集成密钥的第三方集成后，当您执行以下操作时，该密钥将显示为部分经过校订的：通过用户界面查看或编辑警报。通过API查询第三方集成设置。
`roomName`	您的 HipChat 房间名称。

Opsgenie

返回的 Opsgenie 集成配置对象包含以下字段：

属性	说明
`type`	`OPS_GENIE`
`apiKey`	您的 API 密钥。注意创建需要 API 或集成密钥的第三方集成后，当您执行以下操作时，该密钥将显示为部分经过校订的：通过用户界面查看或编辑警报。通过API查询第三方集成设置。
`region`	指示要使用的API URL ，可以是`US`或`EU` 。 Opsgenie 默认为`US` 。

注意

要将region设置为EU ，您必须将客户设置设为 opsgenie.api.url 。

VictorOps

返回的 VictorOps 集成配置对象包含以下字段：

属性	说明
`type`	`VICTOR_OPS`
`apiKey`	您的 API 密钥。注意创建需要 API 或集成密钥的第三方集成后，当您执行以下操作时，该密钥将显示为部分经过校订的：通过用户界面查看或编辑警报。通过API查询第三方集成设置。

配置对象还可能包含以下字段，具体取决于您的配置：

属性	说明
`routingKey`	如果您配置了路由键，则返回一个字段。

Webhook 设置

返回的 Webhook 配置对象包含以下字段：

属性	说明
`type`	`WEBHOOK`
`url`	您的 Webhook URL。注意创建 Webhook 通知后，当您查看或编辑警报时，URL 将显示为部分校订的，而密钥将显示为已完全校订的。

配置对象还可能包含以下字段，具体取决于您的配置：

属性	说明
`secret`	如果您的 Webhook 配置了密钥，则返回一个可选字段。

Microsoft Teams

返回的 Microsoft 团队配置对象将包含以下字段：

属性	说明
`type`	`MICROSOFT_TEAMS`
`microsoftTeamsWebhookUrl`	您的 Microsoft 团队传入 Webhook URL。注意当您查看或编辑 Webhook 通知的警报时，URL 会显示为部分遮蔽，而密钥显示为完全遮蔽。

Prometheus

返回的 Prometheus 配置对象将包含以下字段：

属性	说明
`type`	`PROMETHEUS`
`username`	您的 Prometheus 用户名。
`listenAddress`	Prometheus 实例将连接的 IP 地址和端口。
`serviceDiscovery`	指示使用哪种服务发现方法，为`file`或`http` 。
`scheme`	为请求配置的 Prometheus 协议模式，可以是`http`或`https` 。如果配置`https` ，则必须指定`tlsPemPath` 。
`enabled`	您的集群是否启用了 Prometheus。

配置对象还可能包含以下字段，具体取决于您的配置：

属性	说明
`tlsPemPassword`	如果您有 PEM 文件的密码，则返回一个可选字段。
`tlsPemPath`	如果您有 PEM 文件的绝对路径，则返回一个可选字段。

请求示例

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  }

← 为第三方服务集成创建配置

删除第三方服务集成的配置 →

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	}