获取第三方服务集成的配置

在此页面上

语法

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

注意

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

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

语法

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

请求路径参数

Parameter	必要性	说明
`{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`。对于返回结果列表的端点， `content`对象是一个信封。 Ops Manager 将`status`字段添加到响应正文。	`false`

请求正文参数

此端点不使用 HTTP 请求正文参数。

响应元素

如果已配置该服务，则响应会返回指定的第三方集成配置对象。如果尚未配置，响应将返回INTEGRATION_NOT_CONFIGURED错误。

每个第三方集成配置对象都包含一个等于其自身集成类型的type属性（例如"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 文件的绝对路径，则返回一个可选字段。

请求示例

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"
}

后退

获取第三方服务集成的所有配置

来年

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