atlas api dataFederation downloadFederatedDatabaseQueryLogs
On this page
Public Preview: please provide feedback at: Downloads the query logs for the specified federated database instance.
To use this resource, the requesting Service Account or 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 autogenerated and corresponds 1:1 with the Atlas API endpoint https://www.mongodb.com/docs/atlas/reference/api-resources-spec/v2/#tag/Data-Federation/operation/downloadFederatedDatabaseQueryLogs.
For more information and examples, see the referenced API documentation linked above.
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. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. |
--groupId | string | true | Unique 24-hexadecimal digit string that identifies your project. Use the [/groups](#tag/Projects/operation/listProjects) endpoint to retrieve all projects to which the authenticated user has access. NOTE: Groups and projects are synonymous terms. Your group id is the same as your project id. For existing groups, your group/project id remains the same. The resource and corresponding endpoints use the term groups. |
-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. MongoDB Cloud expresses this timestamp in the number of seconds that have elapsed since the UNIX epoch. |
--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. |
Examples
atlas api dataFederation downloadFederatedDatabaseQueryLogs --version 2023-01-01 --endDate 1.636481348e+09 --groupId 32b6e34b3d91647abb20e7b8 --startDate 1.636466948e+09 --tenantName [tenantName]