Docs Menu
Docs Home
/
MongoDB Cloud Manager
/
API
/
リソース
/
測定値とアラート
/
サードパーティ統合

サードパーティ サービス統合のすべての構成を取得する

項目一覧

  • 構文
  • リクエスト パス パラメーター
  • リクエスト クエリ パラメータ
  • リクエスト ボディ パラメータ
  • 応答要素
  • リクエストの例
  • 応答例

注意

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

ベース URL: https://cloud.mongodb.com/api/public/v 1.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レスポンス ヘッダーまたはステータス コードにアクセスできません。 これを修正するには、クエリでenvelope : trueを設定します。

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

false

backupJobsEnabledOnly

ブール値

任意

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

true

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

このエンドポイントは、HTTP リクエスト本体パラメータを使用しません。

応答要素

レスポンスには、プロジェクトのすべてのサードパーティ統合構成を オブジェクトとして一覧表示するresults配列と、プロジェクトに統合されているサービスのtotalCountが含まれます。

各サードパーティ統合構成オブジェクトには、独自の統合タイプと等しいtypeプロパティが含まれています（例: PagerDuty サービスの"type": "PAGER_DUTY" ）。 さらに、各サードパーティ サービス構成オブジェクトは、そのサービスに固有の詳細を提供します。 以下は、各サードパーティのサービス構成オブジェクトに対して返されるプロパティを一覧表示したものです。

サービス
結果

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

使用するAPI URLをUSまたはEUのいずれかで示します。 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 ファイルへの絶対パスがある場合に返される任意のフィールド。

リクエストの例

1curl --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 }

戻る

サードパーティ統合

次へ

1 つの構成を取得