サードパーティ サービス統合のすべての構成を取得する
注意
グループとプロジェクトは同義語です。 あなたの {PROJECT-ID}はプロジェクト ID と同じです。 既存のグループの場合、グループ/プロジェクト ID は同じままです。 このページでは、説明を参照するときに、より一般的な用語の グループ を使用します。 エンドポイントは ドキュメントに記載されているままです。
ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0
構文
GET /api/public/v1.0/groups/{GROUP-ID}/integrations
リクエスト パス パラメーター
Parameter | 必要性 | 説明 |
|---|---|---|
{PROJECT-ID} | 必須 | プロジェクト識別子。 |
リクエスト クエリ パラメータ
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 | 1 |
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 | 100 |
pretty | ブール値 | 任意 | レスポンス本体を pretty-print に含めるかどうかを示すフラグ 形式。 | false |
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の APIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 | false |
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答要素
レスポンスには、プロジェクトのすべてのサードパーティ統合構成を オブジェクトとして一覧表示するresults配列と、プロジェクトに統合されているサービスのtotalCountが含まれます。
各サードパーティ統合構成オブジェクトには、独自の統合タイプと等しいtypeプロパティが含まれています（例: PagerDuty サービスの"type":
"PAGER_DUTY" ）。 さらに、各サードパーティ サービス構成オブジェクトは、そのサービスに固有の詳細を提供します。 以下は、各サードパーティのサービス構成オブジェクトに対して返されるプロパティを一覧表示したものです。
サービス | 結果 | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
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 --include \ 4 --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/integrations"
応答例
1 { 2 "links": [ 3 { 4 "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/integrations?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 }