AI エージェント向け: ドキュメントインデックスは https://www.mongodb.com/ja-jp/docs/llms.txt で利用できます。すべてのページの markdown バージョンは、いずれかの URL パスに .md を追加することで利用できます。

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

注意

グループとプロジェクトは同義語です。あなたの {PROJECT-ID} は、グループ IDと同じです。既存のグループの場合、グループ/グループ ID は同じままです。このページでは、説明を参照するときに、より一般的なタームのグループ を使用します。エンドポイントとなる接続されたデバイスは、ドキュメントに記載されているままです。

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

構文

PUT /groups/{PROJECT-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 を設定します。

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

false

リクエスト ボディ パラメータ

リクエスト ボディは、1 つのサードパーティ サービスのための 1 つの統合ビュー (JSON 構成オブジェクトのような) である必要があります。同じtypeの設定が既に存在する場合は、リクエストは変更されたフィールドを更新します。同じ type の構成が存在しない場合、追加されます。サードパーティーサービス INTEGRATION_TYPE に等しい type プロパティを必ず含めてください。

PagerDuty

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

プロパティ
説明

type

PAGER_DUTY

serviceKey

統合キー。

重要:統合キーを変更しても、この統合を使用するアラートは変更されません。 これらのアラートは、前の統合キーを引き続き使用します。 新しいキーを使用するには、各 PagerDuty 通知を削除して再追加します。

すべての新しい PagerDuty キーは Events API v2 を使用します。Events API v1 キーをお持ちの場合は、そのキーをMongoDB Ops Managerで引き続き使用できます。

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

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

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

Slack

重要

Slack 統合は現在 OAuth2 認証方法を使用しています。そのため、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 通知の作成後、アラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化されます。

oauth2Config

任意。Webhook通知のベアラーアクセストークンを取得するためにMongoDB Ops Managerが使用するOAuth 2.0クライアント認証情報。このフィールドを指定する場合は、oauth2Config.tokenUrl、oauth2Config.clientId、およびoauth2Config.clientSecretを一緒に設定してください。

oauth2Config.tokenUrl

MongoDB Ops Managerがベアラーアクセストークンを取得するために呼び出すトークンエンドポイントとなる接続されたデバイス。

oauth2Config.clientId

OAuth 2.0 トークンエンドポイントとなる接続されたデバイスへの認証時に MongoDB Ops Manager が使用するクライアント識別子。

oauth2Config.clientSecret

OAuth 2.0 トークンエンドポイントとなる接続されたデバイスへの認証時に、MongoDB Ops Manager がクライアント ID とともに使用するクライアントシークレット。

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またはhttps 。 httpsを構成する場合は、 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

US または EU のいずれかの API URL を使用するかを指定します。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 がシークレットで構成されている場合にのみ返されます。

oauth2Config

Ops ManagerがWebhook通知用のベアラーアクセストークンを取得するために使用するOAuth 2.0クライアント認証情報。WebhookがOAuth 2.0クライアント認証情報で構成されている場合にのみ返されます。

oauth2Config.tokenUrl

MongoDB Ops Managerがベアラーアクセストークンを取得するために呼び出すトークンエンドポイントとなる接続されたデバイス。

oauth2Config.clientId

OAuth 2.0 トークンエンドポイントとなる接続されたデバイスへの認証時に MongoDB Ops Manager が使用するクライアント識別子。

oauth2Config.clientSecret

OAuth 2.0 トークンエンドポイントとなる接続されたデバイスへの認証時に、MongoDB Ops Manager がクライアント ID とともに使用するクライアントシークレット。

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またはhttps 。 httpsを構成する場合は、 tlsPemPathを指定する必要があります。

enabled

クラスターで Prometheus が有効になっているかどうか。

tlsPemPassword

条件付き。返されるのは、PEM ファイルのパスワードが設定されている場合のみです。

tlsPemPath

条件付き。PEM ファイルへの絶対パスを持っている場合にのみ返されます。

リクエストの例

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \     --header "Accept: application/json" \     --header "Content-Type: application/json" \     --include \     --request PUT "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/integrations/SLACK" \     --data '       {         "type": "SLACK",         "apiToken": "1234567890",         "teamName": "My Team"       }'

応答例

{  "links": [    {      "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/integrations/SLACK?pageNum=1&itemsPerPage=100",      "rel": "self"    }  ],  "results": [    {      "serviceKey": "******7890",      "type": "PAGER_DUTY"    },    {      "apiToken": "******7890",      "channelName": "My Channel",      "teamName": "My Team",      "type": "SLACK"    }  ],  "totalCount": 2 }
戻る
作成
次へ
削除
このページを評価

項目一覧