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

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

注意

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

ベース URL: https://cloud.mongodb.com/api/public/v1.0

このエンドポイントとなる接続されたデバイスを使用して、プロジェクトの既存のサードパーティサービス統合構成を置き換えます。このエンドポイントとなる接続されたデバイスはアップサートセマンティクスを使用します。指定された統合タイプの構成が既に存在する場合、Cloud Managerはそれを提供された値で置き換えます。この種類の構成が存在しない場合、Cloud Manager は新しい構成を追加します。既存の構成を置き換えずに構成を追加するには、代わりに 構成の作成 エンドポイントとなる接続されたデバイスを使用します。

構文

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

リクエスト パス パラメーター

Parameter
必要性
説明

{PROJECT-ID}

必須

プロジェクト識別子。

{INTEGRATION-TYPE}

必須

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

  • PAGER_DUTY

  • SLACK

  • NEW_RELIC

  • OPS_GENIE

  • VICTOR_OPS

  • WEBHOOK

  • PROMETHEUS

リクエスト クエリ パラメータ

名前
タイプ
必要性
説明
default

pageNum

数値

任意

結果のサブセクションを返す 1 から始まる整数。

1

itemsPerPage

数値

任意

1 ページあたりに返す項目の数は最大 500 です。

100

pretty

ブール値

任意

レスポンス本体を pretty-print形式にするかどうかを示すフラグ。

false

envelope

ブール値

任意

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

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

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

false

backupJobsEnabledOnly

ブール値

任意

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

true

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

リクエスト ボディは、1 つのサードパーティ サービスのための 1 つの統合ビュー (JSON 構成オブジェクトのような) である必要があります。リクエストは、指定された type の構成全体を置き換えます。常に type プロパティを含め、サードパーティサービス INTEGRATION_TYPE と同じ値にします。

PagerDuty

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

プロパティ
説明

type

PAGER_DUTY

serviceKey

サービス キー。

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

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

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

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

Slack

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

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

プロパティ
説明

type

SLACK

apiToken

API トークン。

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

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

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

teamName

チーム名。

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

プロパティ
説明

channelName

再設定するチャンネル名。

Opsgenie

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

プロパティ
説明

type

OPS_GENIE

apiKey

API キー。

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

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

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

region

US または EU のいずれかの API URL を使用するかを指定します。Opsgenie のデフォルトは US です。

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または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。

Opsgenie

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

プロパティ
説明

type

OPS_GENIE

apiKey

API キー。

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

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

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

region

US または EU のいずれかの API URL を使用するかを指定します。Opsgenie のデフォルトは US です。

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

enabled

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

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

プロパティ
説明

tlsPemPassword

PEM ファイルのパスワードがある場合に返される任意のフィールド。

tlsPemPath

PEM ファイルへの絶対パスがある場合に返される任意のフィールド。

リクエストの例

次の例では、プロジェクトの既存の Slack 統合構成が置き換えられます。

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}
戻る
構成の作成
次へ
構成の削除
このページを評価

項目一覧