atlas api dataFederation downloadFederatedDatabaseQueryLogs
On this page
experimental: Downloads the query logs for the specified federated database instance.
To use this resource, the requesting API Key must have the Project Owner or Project Data Access Read Write roles. 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: 'downloadFederatedDatabaseQueryLogs'. For more information about flags, format of --file and examples, see: https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/downloadFederatedDatabaseQueryLogs
Syntax
atlas api dataFederation downloadFederatedDatabaseQueryLogs [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--endDate | int | false | timestamp that specifies the end point for the range of log messages to download |
--groupId | string | true | unique 24-hexadecimal digit string that identifies your project |
-h, --help | false | help for downloadFederatedDatabaseQueryLogs | |
--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 | timestamp that specifies the starting point for the range of log messages to download |
--tenantName | string | true | human-readable label that identifies the federated database instance for which you want to download query logs |
--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. |