File tree Expand file tree Collapse file tree 3 files changed +115
-14
lines changed
admin/backup/daemonConfigs Expand file tree Collapse file tree 3 files changed +115
-14
lines changed Original file line number Diff line number Diff line change 42
42
object is an envelope. |mms | adds the ``status `` field to the
43
43
response body.
44
44
45
- - ``false ``
46
-
47
- * - backupJobsEnabledOnly
48
- - boolean
49
- - Optional
50
- - Flag indicating whether to exclude daemons not enabled for
51
- backing up databases from the response. Set this to ``false `` to
52
- include daemon configurations with the ``backupJobsEnabled ``
53
- flag set to ``false ``.
54
- - ``true ``
45
+ - ``false ``
Original file line number Diff line number Diff line change @@ -29,7 +29,62 @@ Request Path Parameters
29
29
Request Query Parameters
30
30
~~~~~~~~~~~~~~~~~~~~~~~~
31
31
32
- .. include:: /includes/api/no-query-list-parameters.rst
32
+ The following query parameters are optional:
33
+
34
+ .. list-table::
35
+ :widths: 20 14 11 45 10
36
+ :header-rows: 1
37
+ :stub-columns: 1
38
+
39
+ * - Name
40
+ - Type
41
+ - Necessity
42
+ - Description
43
+ - Default
44
+
45
+ * - pageNum
46
+ - number
47
+ - Optional
48
+ - One-based integer that returns a subsection of results.
49
+ - ``1``
50
+
51
+ * - itemsPerPage
52
+ - number
53
+ - Optional
54
+ - Number of items to return per page, up to a maximum of 500.
55
+ - ``100``
56
+
57
+ * - pretty
58
+ - boolean
59
+ - Optional
60
+ - Flag that indicates whether the response body should be in a
61
+ :wikipedia:`prettyprint </Prettyprint?oldid=791126873>` format.
62
+ - ``false``
63
+
64
+ * - envelope
65
+ - boolean
66
+ - Optional
67
+ - Flag that indicates whether or not to wrap the response in an
68
+ envelope.
69
+
70
+ Some |api| clients cannot access the |http| response headers or
71
+ status code. To remediate this, set ``envelope : true`` in the
72
+ query.
73
+
74
+ For endpoints that return a list of results, the ``results``
75
+ object is an envelope. |mms| adds the ``status`` field to the
76
+ response body.
77
+
78
+ - ``false``
79
+
80
+ * - backupJobsEnabledOnly
81
+ - boolean
82
+ - Optional
83
+ - Flag indicating whether to exclude daemons not enabled for
84
+ backing up databases from the response. Set this to ``false`` to
85
+ include daemon configurations with the ``backupJobsEnabled``
86
+ flag set to ``false``.
87
+ - ``true``
33
88
34
89
Request Body Parameters
35
90
~~~~~~~~~~~~~~~~~~~~~~~
Original file line number Diff line number Diff line change 2
2
Get All Snapshots for One Cluster
3
3
=================================
4
4
5
- .. default-domain:: mongodb
6
-
7
5
.. contents:: On this page
8
6
:local:
9
7
:backlinks: none
@@ -45,7 +43,64 @@ Request Path Parameters
45
43
Request Query Parameters
46
44
~~~~~~~~~~~~~~~~~~~~~~~~
47
45
48
- .. include:: /includes/api/no-query-list-parameters.rst
46
+ The following query parameters are optional:
47
+
48
+ .. list-table::
49
+ :widths: 20 14 11 45 10
50
+ :header-rows: 1
51
+ :stub-columns: 1
52
+
53
+ * - Name
54
+ - Type
55
+ - Necessity
56
+ - Description
57
+ - Default
58
+
59
+ * - pageNum
60
+ - number
61
+ - Optional
62
+ - One-based integer that returns a subsection of results.
63
+ - ``1``
64
+
65
+ * - itemsPerPage
66
+ - number
67
+ - Optional
68
+ - Number of items to return per page, up to a maximum of 500.
69
+ - ``100``
70
+
71
+ * - pretty
72
+ - boolean
73
+ - Optional
74
+ - Flag that indicates whether the response body should be in a
75
+ :wikipedia:`prettyprint </Prettyprint?oldid=791126873>` format.
76
+ - ``false``
77
+
78
+ * - envelope
79
+ - boolean
80
+ - Optional
81
+ - Flag that indicates whether or not to wrap the response in an
82
+ envelope.
83
+
84
+ Some |api| clients cannot access the |http| response headers or
85
+ status code. To remediate this, set ``envelope : true`` in the
86
+ query.
87
+
88
+ For endpoints that return a list of results, the ``results``
89
+ object is an envelope. |mms| adds the ``status`` field to the
90
+ response body.
91
+
92
+ - ``false``
93
+
94
+ * - completed
95
+ - string
96
+ - Optional
97
+ - String that indicates whether to return
98
+ completed or incomplete snapshots:
99
+
100
+ * ``true``: Return only completed snapshots
101
+ * ``false``: Return only incomplete snapshots
102
+ * ``all``: Return both completed and incomplete snapshots
103
+ - ``true``
49
104
50
105
Request Body Parameters
51
106
~~~~~~~~~~~~~~~~~~~~~~~
You can’t perform that action at this time.
0 commit comments