atlas api onlineArchive downloadOnlineArchiveQueryLogs
On this page
experimental: Downloads query logs for the specified online archive.
To use this resource, the requesting API Key must have the Project Data Access Read Only or higher role. The API does not support direct calls with the json response schema. You must request a gzip response schema using an accept header of the format: "Accept: application/vnd.atlas.YYYY-MM-DD+gzip". This command is invoking the endpoint with OperationID: 'downloadOnlineArchiveQueryLogs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Online-Archive/operation/downloadOnlineArchiveQueryLogs
Syntax
atlas api onlineArchive downloadOnlineArchiveQueryLogs [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--archiveOnly | false | flag that indicates whether to download logs for queries against your online archive only or both your online archive and cluster | |
--clusterName | string | true | human-readable label that identifies the cluster that contains the collection for which you want to return the query logs from one online archive |
--endDate | int | false | date and time that specifies the end point for the range of log messages to return |
--envelope | false | flag that indicates whether Application wraps the response in an envelope JSON object | |
--groupId | string | true | unique 24-hexadecimal digit string that identifies your project |
-h, --help | false | help for downloadOnlineArchiveQueryLogs | |
--output | string | false | preferred api format, can be ["gzip"] This value defaults to "gzip". |
--output-file | string | false | file to write the api output to. This flag is required when the output of an endpoint is binary (ex: gzip) and the command is not piped (ex: atlas command > out.zip) |
--startDate | int | false | date and time that specifies the starting point for the range of log messages to return |
--version | string | false | api version to use when calling the api call [options: "2023-01-01"], defaults to the latest version or the profiles api_version config value if set This value defaults to "2023-01-01". |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |