1 つのプロジェクトの 1 つのクラスター ホストのログをダウンロード
非推奨
指定されたプロジェクトの指定されたホストのログメッセージの範囲を含む圧縮（.gz）ログファイルを返します。MongoDB は5 分ごとにクラスターバックエンドストラクチャからのプロセス ログと監査するログを更新します。ログは長さが約 5 分のチャンクで保存されますが、この期間は異なる場合があります。ログファイルのAPIをポーリングする場合は、連続するポーリングに重複するログが含まれる可能性があっても、5 分ごとにポーリングすることをお勧めします。この機能は、M0 無料クラスター、M2、M5、フレキシブルなクラスター、サーバーレス クラスターでは使用できません。このリソースを使用するには、リクエスト元の サービス アカウント またはAPIキーにプロジェクトデータの読み取り専用以上のロールが必要です。API は、 JSON 応答スキーマを使用した直接呼び出しをサポートしていません。形式の accept ヘッダーを使用して gzip レスポンススキーマをリクエスト必要があります。"Accept: アプリケーション/vnd.atlas.YYYY-MM-DD+gzip" となります。
path パラメータ
-
プロジェクトを識別する一意の 24 桁の 16 進数文字列。 認証済みユーザーがアクセスできるすべてのプロジェクトを取得するには、 /groups エンドポイントを使用します。
注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。
形式は次のパターンと一致する必要があります:
^([a-f0-9]{24})$。 -
ダウンロード対象のログファイルを保存するホストを識別する、人間が判読可能なラベル。
形式は次のパターンと一致する必要があります:
^([0-9]{1,3}\.){3}[0-9]{1,3}|([0-9a-f]{1,4}:){7}([0-9a-f]{1,4})|(([a-z0-9]+\.){1,10}[a-z]+)?$。 -
返却対象のログファイルを識別する、人間が判読できるラベル。監査ログを返すには、指定されたプロジェクトのデータベース監査を有効にします。
値は、
mongodb、mongos、mongodb-audit-log、またはmongos-audit-logです。データベース監査の設定
クエリ パラメータ
-
アプリケーションがレスポンスを
envelopeJSON オブジェクトにラップするかどうかを示すフラグ。一部の API クライアントは、HTTP レスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。デフォルト値は
falseです。 -
検索するログメッセージの範囲の終了点の日時を、UNIX エポックからの経過秒数で指定します。この値は、開始日からデフォルトで 24 時間後に設定されます。開始日も指定されていない場合、値はデフォルトでリクエストの時刻になります。
の最小値は
1199145600です。 -
取得するログメッセージの範囲の開始点の日時を、UNIX エポックからの経過秒数で指定します。この値は、デフォルトでは終了日の 24 時間前に設定されます。終了日も指定されていない場合、値はデフォルトでリクエストの時刻の 24 時間前になります。
の最小値は
1199145600です。
atlas api monitoringAndLogs downloadGroupClusterLog --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20230101001/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.DownloadGroupClusterLogApiParams{}
sdkResp, httpResp, err := client.MonitoringandLogsApi.
DownloadGroupClusterLogWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-01-01+gzip" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz" \
--output "file_name.gz"curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-01-01+gzip" \
-X GET "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/clusters/{hostName}/logs/{logName}.gz" \
--output "file_name.gz"{
"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": 409,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
"reason": "Conflict",
"errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}