注意
グループとプロジェクトは同義語です。あなたの {PROJECT-ID} は、グループ IDと同じです。既存のグループの場合、グループ/グループ ID は同じままです。このページでは、説明を参照するときに、より一般的なタームのグループ を使用します。エンドポイントとなる接続されたデバイスは、ドキュメントに記載されているままです。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
構文
POST /groups/{PROJECT-ID}/integrations/{INTEGRATION-TYPE}
リクエスト パス パラメーター
Parameter | 必要性 | 説明 |
|---|---|---|
| 必須 | プロジェクト識別子。 |
| 必須 | サードパーティのサービス識別子です。 指定できる値は以下のとおりです。
|
リクエスト クエリ パラメータ
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 |
|
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 |
|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 |
|
リクエスト ボディ パラメータ
リクエストボディは、プロジェクトに追加する単一のサードパーティ サービスの単一の統合ビュー（ JSON構成オブジェクトなど）である必要があります。サードパーティ サービス INTEGRATION_TYPE と等しい typeプロパティを常に含めます。
サービス | 設定オプション | ||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
PagerDuty | PagerDuty 統合を構成するときは、次のフィールドを指定する必要があります。
| ||||||||||||||||||||||
Slack | 重要: Slack統合では OAuth 2検証方法が使用されるようになりました。また、 MongoDB Atlasサードパーティ サービス統合ページを通じて最初に構成するか、レガシー統合から更新する必要があります。 レガシー トークンはすぐにサポートされなくなります。 既存の Slack 統合を再構成するときは、次のフィールドを指定する必要があります。
次のフィールドを含めることもできます。
| ||||||||||||||||||||||
Datadog | Datadog 統合を構成するときは、次のフィールドを指定する必要があります。
| ||||||||||||||||||||||
HipChat | HipChat 統合を構成するときは、次のフィールドを指定する必要があります。
| ||||||||||||||||||||||
Opsgenie | Opsgenie 統合を構成するときは、次のフィールドを指定する必要があります。
| ||||||||||||||||||||||
VictorOps | VictorOps 統合を構成するときは、次のフィールドを指定する必要があります。
次のフィールドを含めることもできます。
| ||||||||||||||||||||||
Webhook 設定 | Webhook 設定を構成するときは、次のフィールドを指定する必要があります。
次のフィールドを含めることもできます。
| ||||||||||||||||||||||
Microsoft Teams | Microsoft Teams 統合を構成するときは、次のフィールドを指定する必要があります。
| ||||||||||||||||||||||
Prometheus | Prometheus 統合を構成するときは、次のフィールドを指定する必要があります。
次のフィールドを含めることもできます。
|
応答要素
レスポンスには、プロジェクトのすべてのサードパーティ統合構成を オブジェクトとして一覧表示するresults配列と、プロジェクトに統合されているサービスのtotalCountが含まれます。
各サードパーティ統合構成オブジェクトには、独自の統合タイプ（PagerDuty サービスの場合は"type": "PAGER_DUTY" ）と等しいtypeプロパティが含まれています。 さらに、各サードパーティ サービス構成オブジェクトは、そのサービスに固有の詳細を提供します。 以下は、各サードパーティのサービス構成オブジェクトに対して返されるプロパティを一覧表示したものです。
サービス | 結果 | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
PagerDuty | 返された PagerDuty 統合構成オブジェクトには、次のフィールドが含まれています。
| ||||||||||||||||||||
Slack | 返される Slack 統合構成オブジェクトには、次のフィールドが含まれます。
| ||||||||||||||||||||
Datadog | 返された Datadog 統合構成オブジェクトには、次のフィールドが含まれています。
| ||||||||||||||||||||
HipChat | 返された HipChat 統合構成オブジェクトには、次のフィールドが含まれています。
| ||||||||||||||||||||
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 POST "https://<OpsManagerHost>:<Port>/api/public/v1.0/groups/{PROJECT-ID}/integrations/SLACK" \ 6 --data ' 7 { 8 "type": "SLACK", 9 "apiToken": "1234567890", 10 "teamName": "My Team"
応答例
1 { 2 "links": [ 3 { 4 "href": "https://<OpsManagerHost>:<Port>/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 }