1 つのサードパーティ サービス統合を返す
1 つのサードパーティ サービスとの統合を構成する設定を返します。これらの設定は、1 つの MongoDB Cloud プロジェクトで管理されるすべてのデータベースに適用されます。このリソースを使用するには、リクエスト元のサービスアカウントまたは API キーに Organization Owner または Project Owner のロールが必要です。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$
。 -
MongoDB Cloud と統合するサービスを識別する、人間に判読可能なラベル。
値は、
PAGER_DUTY
、SLACK
、DATADOG
、NEW_RELIC
、OPS_GENIE
、VICTOR_OPS
、WEBHOOK
、HIP_CHAT
、PROMETHEUS
、またはMICROSOFT_TEAMS
です。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelope
JSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
false
です。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
false
です。Prettyprint
curl \
--request GET 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/integrations/{integrationType}' \
--header "Authorization: Bearer $ACCESS_TOKEN"
{
"id": "string",
"type": "DATADOG",
"apiKey": "****************************a23c",
"region": "US",
"sendCollectionLatencyMetrics": false,
"sendDatabaseMetrics": false,
"sendQueryStatsMetrics": false,
"sendUserProvidedResourceTags": false
}
{
"id": "string",
"type": "MICROSOFT_TEAMS",
"microsoftTeamsWebhookUrl": "https://webhook.com/****"
}
{
"id": "string",
"type": "NEW_RELIC",
"accountId": "bcc3c81b344a6030a3935c2527e2216535af7718",
"licenseKey": "bc3768f44193c282b2688ab39e00f8e4fc8d75ea",
"readToken": "193c96aee4a3ac640b98634562e2631f17ae0a69",
"writeToken": "a67b10e5cd7f8fb6a34b501136c409f373edc218"
}
{
"id": "string",
"type": "OPS_GENIE",
"apiKey": "********************************a111",
"region": "US"
}
{
"id": "string",
"type": "PAGER_DUTY",
"region": "US",
"serviceKey": "****************************7890"
}
{
"id": "string",
"type": "PROMETHEUS",
"enabled": true,
"sendUserProvidedResourceTagsEnabled": false,
"serviceDiscovery": "http",
"username": "prom_user_618d48e05277a606ed2496fe"
}
{
"id": "string",
"type": "SLACK",
"apiToken": "**********************************************************************abcd",
"channelName": "alerts",
"teamName": "MongoDB"
}
{
"id": "string",
"type": "VICTOR_OPS",
"apiKey": "********************************9abc",
"routingKey": "test routing"
}
{
"id": "string",
"type": "WEBHOOK",
"secret": "string",
"url": "https://webhook.com/****"
}
{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}
{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}
{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}
{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}
{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}