Skip to content

Commit 09e8851

Browse files
DOCSP-45091 updated snapshot endpoints result doc fields (#558)
1 parent 5ea533b commit 09e8851

File tree

2 files changed

+48
-0
lines changed

2 files changed

+48
-0
lines changed

source/includes/api/list-tables/snapshot-cs-documents.rst

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,10 @@
1010
- :ref:`objectId <document-bson-type-object-id>`
1111
- ID of the cluster the :manual:`snapshot </reference/glossary/#std-term-snapshot>` represents.
1212

13+
* - clusterName
14+
- string
15+
- Label that identifies the cluster.
16+
1317
* - complete
1418
- boolean
1519
- Indicator that the :manual:`snapshot </reference/glossary/#std-term-snapshot>` has been created. This is
@@ -114,6 +118,10 @@
114118
- The individual parts that comprise the complete :manual:`snapshot </reference/glossary/#std-term-snapshot>`.
115119
This array contains a single document.
116120

121+
* - parts.completedTime
122+
- string
123+
- Date and time when the snapshot completed.
124+
117125
* - parts.dataSizeBytes
118126
- number
119127
- The total size of the data in the :manual:`snapshot </reference/glossary/#std-term-snapshot>` in bytes.
@@ -123,6 +131,12 @@
123131
- Indicator of the state of encryption of the :manual:`snapshot </reference/glossary/#std-term-snapshot>`
124132
data.
125133

134+
* - parts.fcv
135+
- string
136+
- Number that indicates the feature compatibility version of
137+
MongoDB that the replica set primary ran when MongoDB Cloud
138+
created the snapshot.
139+
126140
* - parts.fileSizeBytes
127141
- number
128142
- The total size of the data files in bytes.
@@ -131,6 +145,10 @@
131145
- string
132146
- ID of a config server.
133147

148+
* - parts.machineId
149+
- string
150+
- Hostname and port that indicate the node on which MongoDB Cloud created the snapshot.
151+
134152
* - parts.masterKeyUUID
135153
- objectId
136154
- The :abbr:`KMIP (Key Management Interoperability Protocol)`
@@ -143,6 +161,10 @@
143161
- The version of ``mongod`` that was running when the
144162
:manual:`snapshot </reference/glossary/#std-term-snapshot>` was created.
145163

164+
* - parts.replicaState
165+
- string
166+
- The node's role at the time when snapshot process began.
167+
146168
* - parts.storageSizeBytes
147169
- number
148170
- The total size of space allocated for document storage.

source/includes/api/list-tables/snapshot-rs-documents.rst

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,10 @@
1212
- Unique identifier of the cluster the :manual:`snapshot </reference/glossary/#std-term-snapshot>`
1313
represents.
1414

15+
* - ``clusterName``
16+
- string
17+
- Label that identifies the cluster.
18+
1519
* - ``complete``
1620
- boolean
1721
- Flag that indicates the :manual:`snapshot </reference/glossary/#std-term-snapshot>` has been created. This
@@ -193,6 +197,11 @@
193197
- string
194198
- Unique identifier of the :manual:`replica set </reference/glossary/#std-term-replica-set>`.
195199

200+
* - | ``parts``
201+
| ``.completedTime``
202+
- string
203+
- Date and time when the snapshot completed.
204+
196205
* - | ``parts``
197206
| ``.compressionSetting``
198207
- string
@@ -209,11 +218,23 @@
209218
- Indicator of the state of encryption of the :manual:`snapshot </reference/glossary/#std-term-snapshot>`
210219
data.
211220

221+
* - | ``parts``
222+
| ``.fcv``
223+
- string
224+
- Number that indicates the feature compatibility version of
225+
MongoDB that the replica set primary ran when MongoDB Cloud
226+
created the snapshot.
227+
212228
* - | ``parts``
213229
| ``.fileSizeBytes``
214230
- number
215231
- Total size of the data files in bytes.
216232

233+
* - | ``parts``
234+
| ``.machineId``
235+
- string
236+
- Hostname and port that indicate the node on which MongoDB Cloud created the snapshot.
237+
217238
* - | ``parts``
218239
| ``.masterKeyUUID``
219240
- string
@@ -233,6 +254,11 @@
233254
- string
234255
- Name of the :manual:`replica set </reference/glossary/#std-term-replica-set>`.
235256

257+
* - | ``parts``
258+
| ``.replicaState``
259+
- string
260+
- The node's role at the time when snapshot process began.
261+
236262
* - | ``parts``
237263
| ``.storageSizeBytes``
238264
- number

0 commit comments

Comments
 (0)