Docs Menu
Docs Home
/
MongoDB Ops Manager
/ / / /

サードパーティ サービス統合の構成を更新

項目一覧

  • 構文
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答要素
  • リクエストの例
  • 応答例

注意

グループとプロジェクトは同義語です。 あなたの {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}
必須

サードパーティのサービス識別子です。 指定できる値は以下のとおりです。

  • DATADOG

  • HIP_CHAT

  • PAGER_DUTY

  • SLACK

  • NEW_RELIC

  • OPS_GENIE

  • VICTOR_OPS

  • WEBHOOK

名前
タイプ
必要性
説明
default
pageNum
数値
任意
結果のサブセクションを返す 1 から始まる整数。
1
itemsPerPage
数値
任意
1 ページあたりに返す項目の数は最大 500 です。
100
pretty
ブール値
任意
レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。
false
envelope
ブール値
任意

応答をエンベロープでラップするかどうかを示すフラグ。

一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope : trueを設定します。

結果のリストを返すエンドポイントの場合、 resultsオブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体にstatusフィールドを追加します。

false
backupJobsEnabledOnly
ブール値
任意
データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これをfalseに設定し、 backupJobsEnabledフラグがfalseに設定されているデーモン構成を含めます。
true

リクエスト本文は、単一のサードパーティ サービスの単一の統合ビュー( JSON構成オブジェクトなど)である必要があります。 同じtypeの構成がすでに存在する場合は、リクエストによって変更されたフィールドが更新されます。 同じtypeの構成が存在しない場合は、追加されます。 サードパーティ サービスINTEGRATION_TYPEと等しいtypeプロパティを常に含めます。

サービス
設定オプション
PagerDuty

PagerDuty 統合を構成するときは、次のフィールドを指定する必要があります。

プロパティ
説明
type
PAGER_DUTY
serviceKey

統合キー。

重要

統合キーを変更しても、この統合を使用するアラートは変更されません。 これらのアラートは、前の統合キーを引き続き使用します。

新しいキーを使用するには、各 PagerDuty 通知を削除して再追加します。

PagerDuty 非推奨 REST API v1 キー( の20181キーを使用している場合は、そのキーを MongoDB Ops Manager で引き続き使用できます。 すべての新しい PagerDuty キーはREST API v2 を使用します は、MongoDB Ops Manager が v2 キーをサポートしていません。REST API v1 キーをお持ちでない場合は、 PagerDuty Events API v1 を使用してください ください。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

Slack

重要

Slack 統合は OAuth 2検証方法を使用するようになりました。また、MongoDB Atlas サードパーティ サービス統合ページを通じて最初に構成するか、レガシー統合から更新する必要があります。

レガシー トークンはすぐにサポートされなくなります。

既存の Slack 統合を再構成するときは、次のフィールドを指定する必要があります。

プロパティ
説明
type
SLACK
apiToken

API トークン。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

teamName
チーム名。

次のフィールドを含めることもできます。

プロパティ
説明
channelName
再設定するチャンネル名。
Datadog

Datadog 統合を構成するときは、次のフィールドを指定する必要があります。

プロパティ
説明
type
DATADOG
apiKey

API キー。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

HipChat

HipChat 統合を構成するときは、次のフィールドを指定する必要があります。

プロパティ
説明
type
HIP_CHAT
notificationToken

HipChat ユーザー アカウントの通知トークン。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

roomName
HipChat ルーム名。
Opsgenie

Opsgenie 統合を構成するときは、次のフィールドを指定する必要があります。

プロパティ
説明
type
OPS_GENIE
apiKey

API キー。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

region
使用される API URL を示します( USまたはEU 。 Opsgenie はデフォルトでUSを使用します。

regionEUopsgenie.api.urlに設定するには、 のカスタマー設定 を設定する必要があります。

VictorOps

VictorOps 統合を構成するときは、次のフィールドを指定する必要があります。

プロパティ
説明
type
VICTOR_OPS
apiKey

API キー。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

次のフィールドを含めることもできます。

プロパティ
説明
routingKey
ルーティング キーの任意のフィールドです。
Webhook 設定

Webhook 設定を構成するときは、次のフィールドを指定する必要があります。

プロパティ
説明
type
WEBHOOK
url
Webhook URL 。

次のフィールドを含めることもできます。

プロパティ
説明
secret

Webhook シークレットの任意フィールド。

Webhook 通知の作成後、アラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化されます。

Microsoft Teams

Microsoft Teams 統合を構成するときは、次のフィールドを指定する必要があります。

プロパティ
説明
type
MICROSOFT_TEAMS
microsoftTeamsWebhookUrl

Microsoft Teams の受信 Webhook URL 。

Webhook 通知のアラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化された状態で表示されます。

Prometheus

Prometheus 統合を構成するときは、次のフィールドを指定する必要があります。

プロパティ
説明
type
PROMETHEUS
username
Prometheus ユーザー名。
password
Prometheus のパスワード。
listenAddress
Prometheus インスタンスがアクセスする IP アドレスとポート。
serviceDiscovery
どのサービス検出方法が使用されるかを示します。 fileまたはhttpのいずれかです。
scheme
リクエスト用に構成された Prometheus プロトコル スキームhttpまたはhttpshttpsを構成する場合は、 tlsPemPathを指定する必要があります。
enabled
クラスターで Prometheus が有効になっているかどうか。

次のフィールドを含めることもできます。

プロパティ
説明
tlsPemPassword
PEM ファイルへのパスワードの任意フィールド。
tlsPemPath
PEM ファイルへの絶対パスの任意フィールド。

レスポンスには、プロジェクトのすべてのサードパーティ統合構成を オブジェクトとして一覧表示するresults配列と、プロジェクトに統合されているサービスのtotalCountが含まれます。

各サードパーティ統合構成オブジェクトには、独自の統合タイプ(PagerDuty サービスの場合は"type": "PAGER_DUTY" )と等しいtypeプロパティが含まれています。 さらに、各サードパーティ サービス構成オブジェクトは、そのサービスに固有の詳細を提供します。 以下は、各サードパーティのサービス構成オブジェクトに対して返されるプロパティを一覧表示したものです。

サービス
結果
PagerDuty

返された PagerDuty 統合構成オブジェクトには、次のフィールドが含まれています。

プロパティ
説明
type
PAGER_DUTY
serviceKey

サービス キー。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

Slack

返される Slack 統合構成オブジェクトには、次のフィールドが含まれます。

プロパティ
説明
type
SLACK
apiToken

API トークン。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

teamName
チーム名。 このフィールドは、レガシー Slack 統合には存在しない場合があります。
channelName
構成された Slack チャンネル名。 値が設定されていない場合は、空の string。
Datadog

返された Datadog 統合構成オブジェクトには、次のフィールドが含まれています。

プロパティ
説明
type
DATADOG
apiKey

API キー。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

HipChat

返された HipChat 統合構成オブジェクトには、次のフィールドが含まれています。

プロパティ
説明
type
HIP_CHAT
notificationToken

HipChat ユーザー アカウントの通知トークン。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

roomName
HipChat ルーム名。
Opsgenie

返された Opsgenie 統合構成オブジェクトには、次のフィールドが含まれます。

プロパティ
説明
type
OPS_GENIE
apiKey

API キー。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

region
使用するAPI URLUSまたはEUのいずれかで示します。 Opsgenie のデフォルトはUSです。

regionEUopsgenie.api.urlに設定するには、 のカスタマー設定 を設定する必要があります。

VictorOps

返された VictorOps 統合構成オブジェクトには、次のフィールドが含まれます。

プロパティ
説明
type
VICTOR_OPS
apiKey

API キー。

API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。

  • UI を通じてアラートを表示または編集します。

  • APIを介してサードパーティ統合設定をクエリします。

構成オブジェクトには、構成に応じて次のフィールドも含まれる場合があります。

プロパティ
説明
routingKey
ルーティングキー が設定されている場合に返される任意のフィールド。
Webhook 設定

返される Webhook 構成オブジェクトには、次のフィールドが含まれます。

プロパティ
説明
type
WEBHOOK
url

Webhook URL 。

Webhook 通知の作成後、アラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化されます。

構成オブジェクトには、構成に応じて次のフィールドも含まれる場合があります。

プロパティ
説明
secret
Webhook が シークレット で構成されている場合に返される任意のフィールド。
Microsoft Teams

返される Microsoft Teams 構成オブジェクトには、次のフィールドが含まれます。

プロパティ
説明
type
MICROSOFT_TEAMS
microsoftTeamsWebhookUrl

Microsoft Teams の受信 Webhook URL 。

Webhook 通知のアラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化された状態で表示されます。

Prometheus

返される Prometheus 構成オブジェクトには、次のフィールドが含まれます。

プロパティ
説明
type
PROMETHEUS
username
Prometheus ユーザー名。
listenAddress
Prometheus インスタンスがアクセスする IP アドレスとポート。
serviceDiscovery
どのサービス検出方法が使用されるかを示します。 fileまたはhttpのいずれかです。
scheme
リクエスト用に構成された Prometheus プロトコル スキームhttpまたはhttpshttpsを構成する場合は、 tlsPemPathを指定する必要があります。
enabled
クラスターで Prometheus が有効になっているかどうか。

構成オブジェクトには、構成に応じて次のフィールドも含まれる場合があります。

プロパティ
説明
tlsPemPassword
PEM ファイルのパスワードがある場合に返される任意のフィールド。
tlsPemPath
PEM ファイルへの絶対パスがある場合に返される任意のフィールド。
1curl --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 }

戻る

サードパーティ サービス統合の構成の作成