一意のIDによって識別される新しいログ統合構成を作成します。このリソースを使用するには、リクエスト元の サービス アカウント またはAPIキーに組織オーナーまたはプロジェクト オーナーのロールが必要です。これは現在プレビュー段階です。アクセスについては、カスタマー アクセス マネージャー(CSM)にお問い合わせください。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。
デフォルト値は
falseです。Prettyprint
body
必須
S3ログエクスポート統合を作成または更新するためのリクエストスキーマ。
-
MongoDB Cloud と統合するサービスを識別する、人間に判読可能なラベル。値はログ統合タイプと一致する必要があります。
-
ログファイルの保存用の S3バケット名を識別する、人間が判読可能なラベル。
-
MongoDB Cloud が S3バケットにアクセスするために使用するAWS IAM ロールを識別する一意の 24 桁の 16 進数文字列。
-
サーバー側暗号化用のAWS KMS キーIDまたは ARN(任意)。指定しない場合、 はバケットのデフォルトの暗号化設定を使用します。
-
S3 にエクスポートするログタイプの配列。有効な値は MONGOD、MONGOS、MONGOD_AUDIT、MONGOS_AUDIT です。
少なくとも
1を、4以下の要素を含めます。値は、MONGOD、MONGOS、MONGOD_AUDIT、またはMONGOS_AUDITです。 -
ログファイルが保存される S3ディレクトリパス プレフィックス。 MongoDB Cloud は、ログタイプに基づいてさらにサブディレクトリを追加します。
atlas api pushBasedLogExport createGroupLogIntegration --help
import (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20250312001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.CreateGroupLogIntegrationApiParams{}
sdkResp, httpResp, err := client.Push - BasedLogExportApi.
CreateGroupLogIntegrationWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/logIntegrations" \
-d '{ <Payload> }'
curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2025-03-12+json" \
--header "Content-Type: application/json" \
-X POST "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/logIntegrations" \
-d '{ <Payload> }'
{
"bucketName": "my-log-bucket",
"iamRoleId": "507f1f77bcf86cd799439011",
"kmsKey": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012",
"logTypes": [
"MONGOD",
"MONGOS",
"MONGOD_AUDIT",
"MONGOS_AUDIT"
],
"prefixPath": "mongo-logs/"
}
{
"id": "507f1f77bcf86cd799439011",
"type": "S3_LOG_EXPORT",
"bucketName": "my-log-bucket",
"iamRoleId": "507f1f77bcf86cd799439011",
"kmsKey": "arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234-1234-123456789012",
"logTypes": [
"MONGOD",
"MONGOS",
"MONGOD_AUDIT",
"MONGOS_AUDIT"
],
"prefixPath": "mongo-logs/"
}
{
"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"
}