/
atlas-streams-instances-download.txt
113 lines (87 loc) · 2.72 KB
/
atlas-streams-instances-download.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
.. _atlas-streams-instances-download:
================================
atlas streams instances download
================================
.. default-domain:: mongodb
.. contents:: On this page
:local:
:backlinks: none
:depth: 1
:class: singlecol
Download a compressed file that contains the logs for the specified Atlas Stream Processing instance.
This command downloads a file with a .gz extension. To use this command, you must authenticate with a user account or an API key with the Project Data Access Read/Write role.
Syntax
------
.. code-block::
:caption: Command Syntax
atlas streams instances download <tenantName> [options]
.. Code end marker, please don't delete this comment
Arguments
---------
.. list-table::
:header-rows: 1
:widths: 20 10 10 60
* - Name
- Type
- Required
- Description
* - tenantName
- string
- true
- Label that identifies the tenant that stores the log files that you want to download.
Options
-------
.. list-table::
:header-rows: 1
:widths: 20 10 10 60
* - Name
- Type
- Required
- Description
* - --end
- int
- false
- UNIX Epoch-formatted ending date and time for the range of log messages to retrieve. This value defaults to the current timestamp.
* - --force
-
- false
- Flag that indicates whether to overwrite the destination file.
* - -h, --help
-
- false
- help for download
* - --out
- string
- true
- Output file name. This value defaults to the log name.
* - --projectId
- string
- false
- Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
* - --start
- int
- false
- UNIX Epoch-formatted starting date and time for the range of log messages to retrieve. This value defaults to 24 hours prior to the current timestamp.
Inherited Options
-----------------
.. list-table::
:header-rows: 1
:widths: 20 10 10 60
* - 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.
Output
------
If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.
.. code-block::
Download of <Name> completed.
Examples
--------
.. code-block::
# Download the audit log file from the instance myProcessor for the project with the ID 5e2211c17a3e5a48f5497de3:
atlas streams instance download myProcessor --projectId 5e2211c17a3e5a48f5497de3