Get all Online Archives for Cluster
On this page
You can retrieve all the online archives for
a cluster using the API or the Atlas UI.
You must have GROUP_READ_ONLY (Project Read Only) role to
retrieve the online archives for a cluster.
The Atlas Administration API authenticates using HTTP Digest Authentication. Provide a programmatic API public key and corresponding private key as the username and password when constructing the HTTP request. To learn how to configure API access for an Atlas project, see Get Started with the Atlas Administration API.
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.
https://cloud.mongodb.com/api/atlas/v1.0
Syntax
GET /groups/{GROUP-ID}/clusters/{CLUSTER-NAME}/onlineArchives
Request Parameters
Request Path Parameters
Path Element | Necessity | Description |
|---|---|---|
GROUP-ID | Required | Unique identifier of the project
that contains the specified cluster. |
CLUSTER-NAME | Required | Name of the cluster. |
Request Query Parameters
This endpoint may use any of the HTTP request query parameters available to all Atlas Administration API resources. These are all optional.
Name | Type | Necessity | Description | Default |
|---|---|---|---|---|
pageNum | integer | Optional | Page number, starting with one, that Atlas returns of the
total number of objects. | 1 |
itemsPerPage | integer | Optional | Number of items that Atlas returns per page, up to a maximum
of 500. | 100 |
includeCount | boolean | Optional | Flag that indicates whether Atlas returns the totalCount
parameter in the response body. | true |
pretty | boolean | Optional | Flag that indicates whether Atlas returns the JSON
response in the
prettyprint format. | false |
envelope | boolean | Optional | Flag that indicates whether Atlas wraps the response in an envelope. Some API clients cannot access the HTTP response headers or
status code. To remediate this, set Endpoints that return a list of results use the results object as an envelope. Atlas adds the status parameter to the response body. | false |
Response Elements
The HTTP response returns a JSON document that includes the following elements:
links Array
The links array includes one or more links to sub-resources and/or
related resources. The relations between URLs are explained in the Web
Linking Specification.
results Array
The results array is an array of documents each containing the
following fields:
Name | Type | Description | ||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
id | string | ID of the online archive. | ||||||||||||||||
clusterName | string | Name of the cluster that contains the collection. | ||||||||||||||||
collName | string | Name of the collection. | ||||||||||||||||
collectionType | string | Type of collection. Value can be one of the following:
| ||||||||||||||||
criteria | document | Criteria to use for archiving data. | ||||||||||||||||
criteria.type | string | Type of criteria. Value can be one of the following:
| ||||||||||||||||
criteria.dateField | string | If "criteria.type" : "DATE", name of the date field that
the online archive is based on. Data is archived when the
current date is after the date specified here plus the number of
days specified via the expireAfterDays parameter. | ||||||||||||||||
criteria.dateFormat | enum | If
| ||||||||||||||||
criteria.expireAfterDays | int | If "criteria.type" : "DATE", number of days that specifies
the age limit for the data in the live Atlas cluster. Data is
archived when the current date is greater than the value of the
date field specified via the dateField parameter plus the number
of days specified here. | ||||||||||||||||
criteria.query | int | If "criteria.type" : "CUSTOM", JSON query used to select
documents for archiving. The specified query is used with the
db.collection.find(query) command. | ||||||||||||||||
dataExpirationRule | object | Rule that specifies when data should be deleted from the
archive. The data expiration rule takes effect only after 24
hours. | ||||||||||||||||
dataExpirationRule.expireAfterDays | int | Number of days after which Atlas must delete archived data.
Value can be between 7 and 9125 days (25 years).
Atlas deletes archived data after the number of days you
specify here. | ||||||||||||||||
dbName | string | Name of the database that contains the collection. | ||||||||||||||||
groupId | string | Unique identifier of the project that contains the cluster. | ||||||||||||||||
partitionFields | document array | Fields to use to partition data. | ||||||||||||||||
partitionFields.fieldName | string | Name of the field. | ||||||||||||||||
partitionFields.fieldType | string | Data type of the field. | ||||||||||||||||
partitionFields.order | int | Position of the field in the partition. Value can be:
| ||||||||||||||||
paused | boolean | State of the online archive. Value is:
| ||||||||||||||||
state | string | Status of the online archive. Valid values are:
|
totalCount Field
This value is the count of the total number of items in the result set.
totalCount may be greater than the number of objects in the
results array if the entire result set is paginated.
Example
The following example request retrieves all the online archives for the
cluster. The example response contains two online archives for the
people.employees and accounting.invoices collections in the cluster
named myTestClstr.
Example Request
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --include \ --request GET "https://cloud.mongodb.com/api/atlas/v1.0/groups/5e2211c17a3e5a48f5497de3/clusters/myTestClstr/onlineArchives?pretty=true"
Example Response
{ "links": [ { "href": "https://cloud.mongodb.com/api/atlas/v1.0/groups/5e2211c17a3e5a48f5497de3/clusters/myTestCluster/onlineArchives?pageNum=1&itemsPerPage=100", "rel": "self" } ], "results": [ { "_id": "5ebc2789fe9c0ab8d33b96cd", "clusterName": "myTestCluster", "collName": "invoices", "collectionType": "STANDARD", "criteria": { "dateField": "created", "dateFormat": "ISODATE", "expireAfterDays": 7 }, "dbName": "accounting", "groupId": "5e2211c17a3e5a48f5497de3", "partitionFields": [ { "fieldName": "customerID", "fieldType": "string", "order": 0 }, { "fieldName": "invoiceNumber", "fieldType": "int", "order": 1 }, { "fieldName": "created", "fieldType": "date", "order": 2 } ], "paused": false, "state": "ACTIVE" }, { "_id": "5ebad3c1fe9c0ab8d37d61e1", "clusterName": "myTestCluster", "collName": "employees", "collectionType": "STANDARD", "criteria": { "dateField": "created", "dateFormat": "ISODATE", "expireAfterDays": 5 }, "dataExpirationRule": { "expireAfterDays": 500 }, "dbName": "people", "groupId": "5e2211c17a3e5a48f5497de3", "partitionFields": [ { "fieldName": "firstName", "fieldType": "string", "order": 0 }, { "fieldName": "lastName", "fieldType": "string", "order": 1 }, { "fieldName": "created", "fieldType": "date", "order": 2 } ], "paused": false, "state": "ACTIVE" } ], "totalCount": 2 }
Error Codes
If the request fails, it returns one of the following errors:
Error Code | Description |
|---|---|
INVALID_GROUP_ID | The specified project ID is not valid. |
CLUSTER_NAME_NOT_FOUND | There is no cluster with the specified name in the specified group. |
CLUSTER_DELETE_REQUESTED | The cluster for the online archives is being deleted. |