Join us Sept 17 at .local NYC! Use code WEB50 to save 50% on tickets. Learn more >
MongoDB Event
Docs Menu
Docs Home
/ /
Atlas CLI
/ / / /

atlas api onlineArchive downloadOnlineArchiveQueryLogs

パブリック プレビュー:フィードバックを提供してください : 指定されたオンライン アーカイブのクエリ ログをダウンロードします。

パブリック プレビュー: MongoDB Atlas Admin APIから自動的に生成される Atlas APIサブコマンドは、Admin APIの完全なフィードバックを提供し、現在パブリック プレビュー段階です(フィードバック 930808-Atlas-cli )。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。

このリソースを使用するには、リクエスト元のサービス アカウントまたは API キーにプロジェクト データアクセスの読み取り専用以上のロールが必要です。API は、JSON 応答スキーマを使用した直接呼び出しをサポートしていません。"Accept: application/vnd.atlas.YYYY-MM-DD+gzip" という形式の Accept ヘッダーを使用して gzip レスポンス スキーマをリクエストする必要があります。

このコマンドは自動生成され、:1 と1 Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-api-v2 / 操作/operation- Downloadingonline Archivequerylogs に対応します。

詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。

コマンド構文
atlas api onlineArchive downloadOnlineArchiveQueryLogs [options]
名前
タイプ
必須
説明

--archiveOnly

false

クエリのログをオンライン アーカイブのみにダウンロードするか、オンライン アーカイブとクラスターの両方に対してダウンロードするかを示すフラグ。

--clusterName

string

true

1 つのオンライン アーカイブからクエリ ログを返却するコレクションを持つクラスターを識別する、人間が判読可能なラベル。

--endDate

整数

false

返却対象のログメッセージの範囲の終了点を指定する日時。このリソースは、[UNIX エポック]( https://en.wiki.org/wiki/Unix_time )からの経過秒数で値を表します。

-- envelope

envelope

false

アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。

--groupId

string

true

プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。

: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。

-h, --help

false

ダウンロードOnlineAr ArchiveQueryLogs のヘルプ

-o, --output

string

false

優先 API形式 は、 ["gzip"] にすることができます。この値のデフォルトは "gzip" です。

-- outputFile

string

false

API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ(例: gzip)で、コマンドがパイプライン化されていない場合(例: Atlas コマンド >out.zip)に必要です。

--startDate

整数

false

返却対象のログメッセージの範囲の開始点を指定する日時。このリソースは、[UNIX エポック]( https://en.wiki.org/wiki/Unix_time )からの経過秒数で値を表します。

--version

string

false

API 呼び出し [options: "2023-01-01"] を呼び出すときに使用する API バージョンは、最新バージョンにデフォルト設定されているか、設定されている場合は api_version 構成値 をプロファイルします。この値のデフォルトは "2023-01-01"

名前
タイプ
必須
説明

-P, --profile

string

false

構成ファイルから使用するプロファイルの名前。 Atlas CLI のプロファイルの詳細については、 https://docub.mongodb.org/core/atlas-cli-save- connection-settings を参照してください。

atlas api onlineArchive downloadOnlineArchiveQueryLogs --version 2023-01-01 --clusterName [clusterName] --endDate 1.636481348e+09 --groupId 32b6e34b3d91647abb20e7b8 --startDate 1.636481348e+09

項目一覧