サードパーティ サービス統合の構成を更新
- Cloud Managerへのプログラムによるアクセスのための OAuth 2.0認証はプレビュー機能として利用できます。
- 機能および関連するドキュメントは、プレビュー期間中にいつでも変更される可能性があります。 OAuth2.0 認証を使用するには、 Cloud Manager Public APIへのリクエストで使用する サービス アカウント を作成します。
注意
グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。
ベース URL: https://cloud.mongodb.com/api/public/v 1.0
構文
PUT /groups/{GROUP-ID}/integrations/{INTEGRATION-TYPE}
リクエスト パス パラメーター
Parameter | 必要性 | 説明 |
|---|---|---|
{PROJECT-ID} | 必須 | プロジェクト識別子。 |
{INTEGRATION-TYPE} | 必須 | サードパーティのサービス識別子です。 指定できる値は以下のとおりです。
|
リクエスト クエリ パラメータ
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 | 1 |
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 | 100 |
pretty | ブール値 | 任意 | レスポンス本体を pretty-print にするかどうかを示すフラグ 形式。 | false |
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 | false |
backupJobsEnabledOnly | ブール値 | 任意 | データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これを falseに設定し、 backupJobsEnabledフラグがfalseに設定されているデーモン構成を含めます。 | true |
リクエスト ボディ パラメータ
リクエスト本文は、単一のサードパーティ サービスの単一の統合ビュー（ JSON構成オブジェクトなど）である必要があります。 同じtypeの構成がすでに存在する場合は、リクエストによって変更されたフィールドが更新されます。 同じtypeの構成が存在しない場合は、追加されます。 サードパーティ サービスINTEGRATION_TYPEと等しいtypeプロパティを常に含めます。
サービス | 設定オプション | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
PagerDuty | PagerDuty 統合を構成するときは、次のフィールドを指定する必要があります。
| ||||||||||||||||||||||
Slack | 重要: Slack統合では OAuth 2検証方法が使用されるようになりました。また、 MongoDB Atlasサードパーティ サービス統合ページを通じて最初に構成するか、レガシー統合から更新する必要があります。 レガシー トークンはすぐにサポートされなくなります。 既存の Slack 統合を再構成するときは、次のフィールドを指定する必要があります。
次のフィールドを含めることもできます。
| ||||||||||||||||||||||
Opsgenie | Opsgenie 統合を構成するときは、次のフィールドを指定する必要があります。
| ||||||||||||||||||||||
VictorOps | VictorOps 統合を構成するときは、次のフィールドを指定する必要があります。
次のフィールドを含めることもできます。
| ||||||||||||||||||||||
Webhook 設定 | Webhook 設定を構成するときは、次のフィールドを指定する必要があります。
次のフィールドを含めることもできます。
| ||||||||||||||||||||||
Microsoft Teams | Microsoft Teams 統合を構成するときは、次のフィールドを指定する必要があります。
| ||||||||||||||||||||||
Prometheus | Prometheus 統合を構成するときは、次のフィールドを指定する必要があります。
次のフィールドを含めることもできます。
|
応答要素
レスポンスには、プロジェクトのすべてのサードパーティ統合構成を オブジェクトとして一覧表示するresults配列と、プロジェクトに統合されているサービスのtotalCountが含まれます。
各サードパーティ統合構成オブジェクトには、独自の統合タイプ（PagerDuty サービスの場合は"type":
"PAGER_DUTY" ）と等しいtypeプロパティが含まれています。 さらに、各サードパーティ サービス構成オブジェクトは、そのサービスに固有の詳細を提供します。 以下は、各サードパーティのサービス構成オブジェクトに対して返されるプロパティを一覧表示したものです。
サービス | 結果 | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
PagerDuty | 返された PagerDuty 統合構成オブジェクトには、次のフィールドが含まれています。
| ||||||||||||||||||||
Slack | 返される Slack 統合構成オブジェクトには、次のフィールドが含まれます。
| ||||||||||||||||||||
Opsgenie | 返された Opsgenie 統合構成オブジェクトには、次のフィールドが含まれます。
| ||||||||||||||||||||
VictorOps | 返された VictorOps 統合構成オブジェクトには、次のフィールドが含まれます。
構成オブジェクトには、構成に応じて次のフィールドも含まれる場合があります。
| ||||||||||||||||||||
Webhook 設定 | 返される Webhook 構成オブジェクトには、次のフィールドが含まれます。
構成オブジェクトには、構成に応じて次のフィールドも含まれる場合があります。
| ||||||||||||||||||||
Microsoft Teams | 返される Microsoft Teams 構成オブジェクトには、次のフィールドが含まれます。
| ||||||||||||||||||||
Prometheus | 返される Prometheus 構成オブジェクトには、次のフィールドが含まれます。
構成オブジェクトには、構成に応じて次のフィールドも含まれる場合があります。
|
リクエストの例
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 }