注意
グループとプロジェクトは同義期間です。あなたの {PROJECT-ID} はグループ ID と同じです。既存のグループの場合、グループ/プロジェクトID は同じままです。このページでは、説明を参照するときに、より一般的な期間のグループ を使用します。エンドポイントとなる接続されたデバイスは、ドキュメントに記載されているままです。
ベース URL: https://cloud.mongodb.com/api/public/v1.0
構文
GET /api/public/v1.0/groups/{GROUP-ID}/integrationsリクエスト パス パラメーター
Parameter | 必要性 | 説明 |
|---|---|---|
| 必須 | プロジェクト識別子。 |
リクエスト クエリ パラメータ
名前 | タイプ | 必要性 | 説明 | default |
|---|---|---|---|---|
pageNum | 数値 | 任意 | 結果のサブセクションを返す 1 から始まる整数。 |
|
itemsPerPage | 数値 | 任意 | 1 ページあたりに返す項目の数は最大 500 です。 |
|
pretty | ブール値 | 任意 | レスポンス本体を pretty-print形式にするかどうかを示すフラグ。 |
|
envelope | ブール値 | 任意 | 応答をエンベロープでラップするかどうかを示すフラグ。 一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで 結果のリストを返すエンドポイントの場合、 |
|
backupJobsEnabledOnly | ブール値 | 任意 | データベースのバックアップ用に有効になっていないデーモンを応答から除外するかどうかを示すフラグ。 これを |
|
リクエスト ボディ パラメータ
このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。
応答要素
レスポンスには、プロジェクトのすべてのサードパーティ統合構成を オブジェクトとして一覧表示するresults配列と、プロジェクトに統合されているサービスのtotalCountが含まれます。
各サードパーティ統合構成オブジェクトには、独自の統合タイプと等しいtypeプロパティが含まれています（例: PagerDuty サービスの"type": "PAGER_DUTY" ）。 さらに、各サードパーティ サービス構成オブジェクトは、そのサービスに固有の詳細を提供します。 以下は、各サードパーティのサービス構成オブジェクトに対して返されるプロパティを一覧表示したものです。
PagerDuty
返された PagerDuty 統合構成オブジェクトには、次のフィールドが含まれています。
プロパティ | 説明 |
|---|---|
|
|
| サービス キー。 API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。
|
Slack
返される Slack 統合構成オブジェクトには、次のフィールドが含まれます。
プロパティ | 説明 |
|---|---|
|
|
| API トークン。 API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。
|
| チーム名。 このフィールドは、レガシー Slack 統合には存在しない場合があります。 |
| 構成された Slack チャンネル名。 値が設定されていない場合は、空の string。 |
Opsgenie
返された Opsgenie 統合構成オブジェクトには、次のフィールドが含まれます。
プロパティ | 説明 |
|---|---|
|
|
| API キー。 API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。
|
|
|
VictorOps
返された VictorOps 統合構成オブジェクトには、次のフィールドが含まれます。
プロパティ | 説明 |
|---|---|
|
|
| API キー。 API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。
|
構成オブジェクトには、構成に応じて次のフィールドも含まれる場合があります。
プロパティ | 説明 |
|---|---|
| ルーティングキー が設定されている場合に返される任意のフィールド。 |
Webhook 設定
返される Webhook 構成オブジェクトには、次のフィールドが含まれます。
プロパティ | 説明 |
|---|---|
|
|
| Webhook URL 。 Webhook 通知の作成後、アラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化されます。 |
構成オブジェクトには、構成に応じて次のフィールドも含まれる場合があります。
プロパティ | 説明 |
|---|---|
| Webhook が シークレット で構成されている場合に返される任意のフィールド。 |
Microsoft Teams
返される Microsoft Teams 構成オブジェクトには、次のフィールドが含まれます。
プロパティ | 説明 |
|---|---|
|
|
| Microsoft Teams の受信 Webhook URL 。 Webhook 通知のアラートを表示または編集すると、URL が部分的に編集され、シークレットは完全に伏字化された状態で表示されます。 |
Prometheus
返される Prometheus 構成オブジェクトには、次のフィールドが含まれます。
プロパティ | 説明 |
|---|---|
|
|
| Prometheus ユーザー名。 |
| Prometheus インスタンスがアクセスする IP アドレスとポート。 |
| どのサービス検出方法が使用されるかを示します。 |
| リクエスト用に構成された Prometheus プロトコル スキーム |
| クラスターで Prometheus が有効になっているかどうか。 |
構成オブジェクトには、構成に応じて次のフィールドも含まれる場合があります。
プロパティ | 説明 |
|---|---|
| PEM ファイルのパスワードがある場合に返される任意のフィールド。 |
| PEM ファイルへの絶対パスがある場合に返される任意のフィールド。 |
リクエストの例
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/integrations"応答例
{ "links": [ { "href": "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/integrations?pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "serviceKey": "******7890", "type": "PAGER_DUTY" }, { "apiToken": "******7890", "channelName": "My Channel", "teamName": "My Team", "type": "SLACK" }, ], "totalCount": 2 }