Obtenga todas las instantáneas de un servidor de configuración

Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de MongoDB Ops Manager.

Importante

Obsoleto al usar MongoDB 3.4

A partir de MongoDB 3.4, las implementaciones de servidores de configuración reflejados (también conocidos como SCCC) ya no son compatibles. El siguiente método de API solo funciona con servidores de configuración SCCC. Los servidores de configuración de conjuntos de réplicas (también conocidos como CSRS) utilizan Método "Obtener todas las instantáneas para un clúster". Para saber cómo convertir sus servidores de configuración de SCCC a CSRS, consulte "Actualizar servidores de configuración a conjunto de réplicas" en el Manual del servidor MongoDB.

URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0

Resource

GET /groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots

Request Parameters

Parámetros de la ruta de solicitud

Nombre	Tipo	Descripción
PROJECT-ID	string	Identificador único del proyecto propietario de la instantánea.
ID DE HOST	string	Identificador único del host que representa la instantánea.

Parámetros de consulta de solicitud

Los siguientes parámetros de consulta son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
número de página	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
artículos por página	Número	Opcional	Número de artículos a devolver por página, hasta un máximo de 500.	`100`
bonita	booleano	Opcional	Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato.	`false`
envolvente	booleano	Opcional	Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes de API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionarlo, configure `envelope : true` en la consulta. Para los puntos finales que devuelven una lista de resultados, el objeto `results` es un sobre. Ops Manager añade el campo `status` al cuerpo de la respuesta.	`false`
trabajos de respaldo habilitados solamente	booleano	Opcional	Indicador que indica si se deben excluir de la respuesta los daemons no habilitados para realizar copias de seguridad de bases de datos. Establezca este valor en `false` para incluir las configuraciones de daemon con el indicador `backupJobsEnabled` establecido en `false`.	`true`

Parámetros del cuerpo de la solicitud

Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Respuesta

Documento de respuesta

El documento JSON de respuesta incluye una matriz de result objetos, una matriz de link objetos y un recuento del número total de result objetos recuperados.

Nombre	Tipo	Descripción
`results`	arreglo	La matriz incluye un objeto para cada elemento detallado en la `results` sección Documento incrustado.
`links`	arreglo	La matriz incluye uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.
`totalCount`	Número	Número entero del número total de elementos en el conjunto de resultados. Puede ser mayor que el número de objetos en la matriz results si todo el conjunto de resultados está paginado.

`results` Documento incrustado

Cada resultado es una instantánea.

Nombre	Tipo	Descripción
clusterId	ObjectId	ID del clúster que representa la instantánea.
completar	booleano	Indicador de que se ha creado la instantánea. Este valor es `false` si la tarea de creación de la instantánea aún está en curso.
creado	Documento	Los componentes de una marca de tiempo.
fecha de creación	fecha y hora	El punto exacto en el que se tomó la instantánea en formato de fecha y hora ISO 8601 en UTC.
creado.incremento	entero	El orden de operación en el que se realizó esta instantánea en este momento exacto. Para saber cómo funcionan las marcas de tiempo en MongoDB, consulte Marcas de tiempo.
NoEliminar	booleano	Indicador de que la instantánea no se puede eliminar. Si `doNotDelete` se establece en `true`, se ignora cualquier valor en `expires`.
expira	fecha y hora	La fecha en formato de fecha y hora ISO 8601 en UTC después de la cual se puede eliminar esta instantánea. Si `doNotDelete` está configurado en `true`, se elimina cualquier valor en `expires`. Si el valor `expires` es anterior a la fecha y hora actuales, ya no se podrá editar.
ID de grupo	ObjectId	ID del proyecto propietario de la instantánea.
ID.	ObjectId	ID del snapshot.
última marca de tiempo aplicada del registro de operaciones	Documento	Se aplicaron los componentes de la marca de tiempo de la última entrada del registro de operaciones.
lastOplogAppliedTimestamp.date	fecha y hora	El punto exacto en el tiempo en el que se aplicó el último oplog en el formato de fecha y hora ISO 8601 en UTC.
lastOplogAppliedTimestamp.increment	entero	El orden de operación en el que se aplicó el último registro de operaciones en este momento exacto. Para saber cómo funcionan las marcas de tiempo en MongoDB, consulte Marcas de tiempo.
enlaces	matriz de objetos	Uno o más enlaces a subrecursos o recursos relacionados. Todas las `links` matrices en las respuestas incluyen al menos un enlace `self` llamado. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.
namespaceFilterList	matriz de objetos	Los espacios de nombres que están incluidos o excluidos de esta instantánea.
ListaDeFiltrosDeEspacioDeNombres.ListaDeFiltros	matriz de cadenas	Una lista separada por comas de cualquier combinación de bases de datos o espacios de nombres que se incluyen exclusivamente o se excluyen explícitamente de la instantánea. El valor predeterminado es una matriz vacía (`[]`).
Lista de filtros de espacio de nombres.tipo de filtro	string	Un valor que determina cómo se filtran los espacios de nombres para esta instantánea. Si este valor se establece en `blacklist`, los espacios de nombres en `namespaceFilterList.filterList` se excluyen de la instantánea. Si este valor se establece en `whitelist`, solo se incluyen en la instantánea los espacios de nombres en `namespaceFilterList.filterList`. El valor por defecto es `blacklist`.
partes	matriz de objetos	Las partes individuales que componen la instantánea completa. Esta matriz contiene un solo documento.
partes.dataSizeBytes	Número	El tamaño total de los datos en la instantánea en bytes.
partes.encryptionEnabled	booleano	Indicador del estado de cifrado de los datos de la instantánea.
partes.fileSizeBytes	Número	El tamaño total de los archivos de datos en bytes.
partes.hostId	string	ID de un servidor de configuración.
partes.masterKeyUUID	ObjectId	El ID de clave maestra KMIP utilizado para cifrar los datos de la instantánea. `parts.masterKeyUUID` aparece solo si esta instantánea `parts.encryptionEnabled : true` tiene.
partes.mongodVersion	string	La versión de `mongod` que estaba ejecutándose cuando se creó la instantánea.
partes.storageSizeBytes	Número	El tamaño total del espacio asignado para el almacenamiento de documentos.
partes.typeName	string	El tipo de servidor que representa la parte: `CONFIG_SERVER`

Ejemplo de solicitud

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --header "Accept: application/json" \
 --include \
 --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/hosts/{HOST-ID}/snapshots?pretty=true"

Ejemplo de respuesta

Encabezado de respuesta

HTTP/1.1 401 Unauthorized
Content-Type: application/json;charset=ISO-8859-1
Date: {dateInUnixFormat}
WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false
Content-Length: {requestLengthInBytes}
Connection: keep-alive

HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Cuerpo de respuesta

{
  "links" : [ {
    "href" : "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "clusterId" : "{CLUSTER-ID}",
    "complete" : true,
    "created" : {
      "date" : "2016-08-21T23:47:38Z",
      "increment" : 1
    },
    "doNotDelete" : false,
    "expires" : "2017-08-20T23:47:38Z",
    "groupId" : "{PROJECT-ID}",
    "id" : "{SNAPSHOT-ID}",
    "links" : [ {
      "href" : "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{PROJECT-ID}/clusters/{CLUSTER-ID}/snapshots/{SNAPSHOT-ID}",
      "rel" : "self"
    } ],
    "namespaceFilterList" : {
      "filterList" : [ ],
      "filterType" : "blacklist"
    },
    "parts" : [ {
      "clusterId" : "{CLUSTER-ID}",
      "compressionSetting" : "GZIP",
      "dataSizeBytes" : 503779557,
      "encryptionEnabled" : false,
      "fileSizeBytes" : 2855605344,
      "mongodVersion" : "4.0.9",
      "replicaSetName" : "proton",
      "storageSizeBytes" : 547516416,
      "typeName" : "REPLICA_SET"
    } ]
  }, {
  } ],
  "totalCount" : 28
}

Volver

Remover uno

Obtener uno (Servidor de configuración)