Crea un archivo en línea. Este archivo almacena datos de un clúster dentro de un proyecto. Para usar este recurso, la cuenta de servicio o la clave API solicitante debe tener el rol de administrador de acceso a datos del proyecto.
Parámetros de path
-
string única de 24dígitos hexadecimales que identifica tu proyecto. Usa el endpoint /groups para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.
NOTA: Grupos y proyectos son términos sinónimos. El id de tu grupo es el mismo que el id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término grupos.
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$. -
Etiqueta legible por humanos que identifica el clúster que contiene la colección para la que deseas crear un fichero en linea.
El formato debe coincidir con el siguiente patrón:
^[a-zA-Z0-9][a-zA-Z0-9-]*$.
Parámetros de query
-
Bandera que indica si la aplicación envuelve la respuesta en un objeto JSON
envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.El valor por defecto es
false. -
Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.
El valor por defecto es
false.Impresión bonita
Cuerpo
Requerido
Crea un fichero en línea.
-
Etiqueta legible por humanos que identifica la colección para la cual creaste el fichero en línea.
-
Clasificación de la colección de bases de datos MongoDB que desea devolver.
Si estableces este parámetro en
TIMESERIES, configura"criteria.type" : "date"y"criteria.dateFormat" : "ISODATE".Los valores son
TIMESERIESoSTANDARD. El valor por defecto esSTANDARD. -
Regla para especificar cuándo se deben borrar los datos del fichero.
-
Etiqueta legible por humanos de la base de datos que contiene la colección que contiene el fichero en linea.
La longitud máxima es
64. -
Lista que contiene parámetros de documentos para usarlos en una división lógica de datos dentro de una colección. Las particiones proporcionan un nivel áspero de filtrado de los datos de la colección subyacente. Para dividir tus datos, especifica los parámetros que consultas con frecuencia. Si has especificado
criteria.type:DATEen el endpoint Crear un fichero en línea, entonces puedes especificar hasta tres parámetros por los que query. Uno de estos parámetros debe ser el valorDATE, que es obligatorio en este caso. Si especificastecriteria.type:CUSTOMen el endpoint Crear un fichero en línea, entonces puedes especificar hasta dos parámetros por los que hacer la query. Las queries que no utilicen los parámetroscriteria.type:DATEocriteria.type:CUSTOMhacen que MongoDB escanee toda la colección de todos los documentos archivados. Esto toma más tiempo y aumenta tus costos.At least
1element. -
Indicador que indica si este archivo en línea está en pausa. La solicitud de reanudación falla si la colección tiene otro archivo en línea activo. Para pausar un archivo en línea activo o reanudar uno pausado, debe incluir este parámetro. Para pausar un archivo activo, establézcalo en "true". Para reanudar un archivo pausado, establézcalo en "false".
curl \
--request POST 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/clusters/{clusterName}/onlineArchives' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"collName":"string","collectionType":"STANDARD","criteria":{"type":"CUSTOM","query":"string"},"dataExpirationRule":{"expireAfterDays":42},"dataProcessRegion":{"cloudProvider":"AWS","region":"US_EAST_1"},"dbName":"string","partitionFields":[{"fieldName":"string","order":0}],"paused":true,"schedule":{"type":"DEFAULT"}}'{
"collName": "string",
"collectionType": "STANDARD",
"criteria": {
"type": "CUSTOM",
"query": "string"
},
"dataExpirationRule": {
"expireAfterDays": 42
},
"dataProcessRegion": {
"cloudProvider": "AWS",
"region": "US_EAST_1"
},
"dbName": "string",
"partitionFields": [
{
"fieldName": "string",
"order": 0
}
],
"paused": true,
"schedule": {
"type": "DEFAULT"
}
}{
"_id": "32b6e34b3d91647abb20e7b8",
"clusterName": "string",
"collName": "string",
"collectionType": "STANDARD",
"criteria": {
"type": "CUSTOM",
"query": "string"
},
"dataExpirationRule": {
"expireAfterDays": 42
},
"dataProcessRegion": {
"cloudProvider": "AWS",
"region": "US_EAST_1"
},
"dataSetName": "string",
"dbName": "string",
"groupId": "32b6e34b3d91647abb20e7b8",
"partitionFields": [
{
"fieldName": "string",
"fieldType": "date",
"order": 0
}
],
"paused": true,
"schedule": {
"type": "DEFAULT"
},
"state": "PENDING"
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 409,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
"reason": "Conflict",
"errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}