Navigation

View the List of Online Archives

You can view the list of online archives for a cluster through the Atlas UI and API .

To view the list of Online Archives:

1
  1. If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
  2. If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
  3. If the Clusters page is not already displayed, click Clusters in the sidebar.
2
  1. Click the name of the cluster.
  2. Click the Online Archive tab to view the list of online archives, if any, for the cluster.

The page displays the online archives for the cluster. For each online archive, you can see the following information:

Column NameDescription
Archive FieldThe date field based on which documents are archived.
Archive Last UpdatedThe date when the archive was last modified.
Age LimitThe number of days used to qualify documents for archiving.
Partition FieldsThe other commonly used query fields used for partitioning data on the cloud object storage.
Status

The status of the Online Archive. Value can be one of the following:

PendingIndicates documents are queued for archive, but archiving has not yet started.
ArchivingIndicates archiving has started. In this state, the documents that meet the criteria for archiving are being archived.
IdleIndicates online archive is waiting for the next archival job to start.
PausedIndicates archiving has been temporarily stopped. In this state, previously archived documents continue to be available on the cloud object storage, but the specified archiving operation on the active cluster is put on hold. You can resume archiving for paused archives at any time.
OrphanedIndicates collection associated with an active or paused online archive was deleted. Atlas will not automatically delete the archived data. You must manually delete the online archives associated with the deleted collection.
DeletedIndicates online archive was deleted. When you delete an online archive, associated archived documents are removed from the cloud object storage.
ActionsThe operations that you can perform on the Online Archive.

To retrieve an online archive through the API , send a GET request to the onlineArchives endpoint with the unique ID of the online archive to retrieve. To learn more about the API syntax and options, see Get One Online Archive.

To retrieve all the online archives configured for a cluster using the API , send a GET request to the onlineArchives endpoint for the cluster. To learn more about the syntax and options, see Get all Online Archives for Cluster.

Give Feedback