パブリック プレビュー:フィードバックを提供してください : クラスター名で識別される 1 つのクラスターのアクセス ログを返します。
パブリック プレビュー: MongoDB Atlas Admin APIから自動的に生成される Atlas APIサブコマンドは、Admin APIの完全なフィードバックを提供し、現在パブリック プレビュー段階です(フィードバック 930808-Atlas-cli )。管理API機能には独自のリリース ライフサイクルがあり、提供されているAPIエンドポイントのドキュメント リンクから確認できます。
アクセス ログには、クラスターに対して行われた認証リクエストの一覧が含まれます。この機能は、テナント階層クラスター(M0、M2、M5)では使用できません。このリソースを使用するには、リクエストを行うサービス アカウントまたは API キーに "プロジェクト モニタリング管理者" ロールまたは "プロジェクト データベース アクセス管理者" ロールが付与されている必要があります。
このコマンドは自動生成され、1:1 と Atlas APIエンドポイント https://www.mongodb.com/ja-jp/docs/api/doc/atlas-admin-v2/ 操作/operation-listaccesslogsbyclustername 。
詳細と例については、上記のリンクで参照されているAPIドキュメントを参照してください。
構文
atlas api accessTracking listAccessLogsByClusterName [options]
オプション
名前 | タイプ | 必須 | 説明 |
---|---|---|---|
--authResult | false | レスポンスが成功した認証試行のみを返すかどうかを示すフラグ。 | |
--clusterName | string | true | クラスターを識別する人間が判読できるラベル。 |
--end | 整数 | false | データベース履歴の取得を停止する日時。end を指定する場合は、start も指定する必要があります。このパラメータは、ミリ秒単位の UNIXエポック時間を使用します。 |
-- envelope | envelope | false | アプリケーションが応答をエンベロープJSONオブジェクトでラップするかどうかを示すフラグ。一部のAPIクライアントは、 HTTPレスポンス ヘッダーまたはステータス コードにアクセスできません。これを修正するには、クエリで envelope=true を設定します。結果のリストを返すエンドポイントは、結果オブジェクトをエンベロープとして使用します。アプリケーションは、レスポンス本体にステータス パラメータを追加します。 |
--groupId | string | true | プロジェクトを識別する一意の 24 桁の 16 進数文字列。 [/groups](# tags/プロジェクト/操作/listProjects) エンドポイントを使用して、認証されたユーザーがアクセスできるすべてのプロジェクトを取得します。 注: グループとプロジェクトは同義語です。そのため、グループ ID はプロジェクト ID と同じです。既存のグループの場合、グループ/プロジェクト ID は同じままです。リソースおよび対応するエンドポイントでは、グループという用語が使用されます。 |
-h, --help | false | listAccessLogsByClusterName のヘルプ | |
--ipAddress | string | false | データベースへの認証を試みた 1 つのインターネット プロトコル アドレス。 |
--nLogs | 整数 | false | ログから返される最大行数。 |
-o, --output | string | false | 優先API形式 は、 ["JSON", go-template] にすることができます。この値のデフォルトは "JSON" です。 |
-- outputFile | string | false | API 出力を書き込むファイル。このフラグは、エンドポイントの出力がバイナリ(例: gzip)で、コマンドがパイプライン化されていない場合(例: Atlas コマンド >out.zip)に必要です。 |
--pretty | false | レスポンス本体を pretty-print 形式にするかどうかを示すフラグ。 | |
--start | 整数 | false | MongoDB Cloud がデータベース履歴の取得を開始する日時。start を指定する場合は、end も指定する必要があります。このパラメータは、ミリ秒単位の UNIXエポック時間を使用します。 |
--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 accessTracking listAccessLogsByClusterName --version 2023-01-01 --clusterName [clusterName] --groupId 32b6e34b3d91647abb20e7b8