/ /

/ /

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

注意

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

ベース URL: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

構文

GET /groups/{PROJECT-ID}/integrations/{INTEGRATION-TYPE}

リクエストパスパラメーター

Parameter	必要性	説明
`{PROJECT-ID}`	必須	プロジェクト識別子。
`{INTEGRATION-TYPE}`	必須	サードパーティのサービス識別子です。指定できる値は以下のとおりです。 `DATADOG` `HIP_CHAT` `PAGER_DUTY` `SLACK` `NEW_RELIC` `OPS_GENIE` `VICTOR_OPS` `WEBHOOK`

リクエストクエリパラメータ

名前	タイプ	必要性	説明	default
pageNum	数値	任意	結果のサブセクションを返す 1 から始まる整数。	`1`
itemsPerPage	数値	任意	1 ページあたりに返す項目の数は最大 500 です。	`100`
pretty	ブール値	任意	レスポンス本体を pretty-print形式にするかどうかを示すフラグ。	`false`
envelope	ブール値	任意	応答をエンベロープでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンスヘッダーまたはステータスコードにアクセスできません。これを修正するには、クエリで `envelope : true` を設定します。結果のリストを返すエンドポイントの場合、 `content`オブジェクトはエンベロープです。 MongoDB Ops Manager は、レスポンス本体に`status`フィールドを追加します。	`false`

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

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

応答要素

レスポンスは、指定されたサードパーティ統合構成オブジェクトを、そのサービスが構成されている場合は返します。設定されていない場合、応答はINTEGRATION_NOT_CONFIGUREDエラーを返します。

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

サービス

結果

PagerDuty

返された PagerDuty 統合構成オブジェクトには、次のフィールドが含まれています。

プロパティ	説明
`type`	`PAGER_DUTY`
`serviceKey`	サービスキー。 API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。 UI を通じてアラートを表示または編集します。 APIを介してサードパーティ統合設定をクエリします。

Slack

返される Slack 統合構成オブジェクトには、次のフィールドが含まれます。

プロパティ	説明
`type`	`SLACK`
`apiToken`	API トークン。 API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。 UI を通じてアラートを表示または編集します。 APIを介してサードパーティ統合設定をクエリします。
`teamName`	チーム名。このフィールドは、レガシー Slack 統合には存在しない場合があります。
`channelName`	構成された Slack チャンネル名。値が設定されていない場合は、空の string。

Datadog

返された Datadog 統合構成オブジェクトには、次のフィールドが含まれています。

プロパティ	説明
`type`	`DATADOG`
`apiKey`	API キー。 API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。 UI を通じてアラートを表示または編集します。 APIを介してサードパーティ統合設定をクエリします。

HipChat

返された HipChat 統合構成オブジェクトには、次のフィールドが含まれています。

プロパティ	説明
`type`	`HIP_CHAT`
`notificationToken`	HipChat ユーザーアカウントの通知トークン。 API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。 UI を通じてアラートを表示または編集します。 APIを介してサードパーティ統合設定をクエリします。
`roomName`	HipChat ルーム名。

Opsgenie

返された Opsgenie 統合構成オブジェクトには、次のフィールドが含まれます。

プロパティ	説明
`type`	`OPS_GENIE`
`apiKey`	API キー。 API または統合キーが必要なサードパーティ統合を作成してから次の操作を行うと、キーは部分的に伏字で表示されます。 UI を通じてアラートを表示または編集します。 APIを介してサードパーティ統合設定をクエリします。
`region`	Indicates which API URL to use, either `US` or `EU`. Opsgenie defaults to `US`.

を regionEUopsgenie.api.urlに設定するには、のカスタマー設定を設定する必要があります。

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 ファイルへの絶対パスがある場合に返される任意のフィールド。

リクエストの例

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/PAGER_DUTY"

応答例

{
  "serviceKey": "******7890",
  "type": "PAGER_DUTY"
}

戻る

すべての構成を取得する

作成

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

構文

リクエスト パス パラメーター

リクエスト クエリ パラメータ

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

応答要素

リクエストの例

応答例

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

リクエストパスパラメーター

リクエストクエリパラメータ

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