Algunos Los clientes de laAPI no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta.

Para los puntos finales que devuelven un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
Estado	Código de respuestaHTTP
envolvente	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Nombre	Tipo	Descripción
daemonFilter	matriz de objetos	Opcional. Una matriz de pares de hosts de Backup Daemon y sus Directorios principales a los que se limitan las copias de seguridad de este proyecto. Si se omite, se utilizan todos los daemons de copia de seguridad disponibles.
daemonFilter.headRootDirectory	string	Opcional. Ruta relativa a la raíz del directorio principal en este host del demonio de copia de seguridad.
daemonFilter.máquina	string	La dirección de host de un host de Backup Daemon.
ID.	string	El identificador único que representa este proyecto y su configuración de trabajo de respaldo.
Contraseña del certificado de cliente kmip	string	Opcional. La contraseña que cifra el certificado del cliente KMIP.
kmipClientCertPath	string	Opcional. Ruta relativa a la raíz en el host del demonio de copia de seguridad que almacena el certificado de cliente KMIP.
filtro de etiquetas	matriz de cadenas	Opcional. Una matriz de etiquetas que limita qué daemons de copia de seguridad y almacenes de instantáneas pueden procesar trabajos de copia de seguridad para este proyecto. Si un almacén de instantáneas o cualquier demonio de respaldo tiene el mismo `labels` configurado que este `labelFilter`, pueden procesar trabajos de respaldo para este proyecto. Si se omite, los trabajos de respaldo del proyecto pueden usar cualquier demonio de respaldo o almacén de instantáneas disponible.
oplogStoreFilter	matriz de objetos	Opcional. Una matriz de identificadores únicos que representan los almacenes de registros de operaciones que pueden usarse con las tareas de copia de seguridad de este proyecto. Si se omite, se pueden usar todos los almacenes de registros de operaciones disponibles.
oplogStoreFilter.id	string	Identificador único que representa un almacén de registros de operaciones que se puede utilizar con los trabajos de respaldo de este proyecto. Recupere el `id` del almacén de oplog que desea utilizar con Obtener todas las configuraciones de oplog.
oplogStoreFilter.type	string	Tipo de almacén de registros de operaciones que se utilizará. El único valor admitido `oplogStore` es.
snapshotStoreFilter	matriz de objetos	Opcional. Matriz de identificadores únicos que representan almacenes de instantáneas específicos y sus tipos, que pueden usarse con las tareas de copia de seguridad de este proyecto. Si se omite, se utilizan todos los almacenes de instantáneas disponibles.
snapshotStoreFilter.id	string	Opcional. Identificador único que representa almacenes de instantáneas específicos que se pueden usar con las tareas de respaldo de este proyecto.
tipo de filtro de tienda de instantáneas	string	Opcional. El tipo de almacén de instantáneas específico `snapshotStoreFilter.id` se indica como. Los valores aceptados para esta opción son: `s3blockstore` `blockstore` `fileSystemStore`
Filtro de almacenamiento de sincronización	matriz de cadenas	Opcional. Una matriz de filtros de almacenamiento de sincronización que se pueden usar con las tareas de copia de seguridad de este proyecto. Si se omite, se utilizan todos los almacenes de sincronización disponibles.

Respuesta

Nombre	Tipo	Descripción
daemonFilter	matriz de objetos	Una matriz de pares de hosts de Backup Daemon y sus directorios principales a los que están limitados los trabajos de respaldo de este proyecto.
daemonFilter.headRootDirectory	string	La ruta relativa a la raíz del directorio principal en este host de Backup Daemon.
daemonFilter.máquina	string	La dirección de host de un host de Backup Daemon.
ID.	string	El identificador único que representa este proyecto y su configuración de trabajo de respaldo.
Contraseña del certificado de cliente kmip	string	La contraseña que cifra el certificado del cliente KMIP.
kmipClientCertPath	string	La ruta al directorio en el host de Backup Daemon que almacena el certificado de cliente KMIP.
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.
filtro de etiquetas	matriz de cadenas	Una matriz de etiquetas que limita qué daemons de respaldo y almacenes de instantáneas pueden procesar trabajos de respaldo para este proyecto.
oplogStoreFilter	matriz de objetos	Una matriz de identificadores únicos que representan almacenes Oplog que pueden usarse con los trabajos de respaldo de este proyecto.
oplogStoreFilter.id	string	Identificador único que representa un almacén de registros de operaciones que se puede utilizar con los trabajos de respaldo de este proyecto.
oplogStoreFilter.type	string	Tipo de almacén de registros de operaciones que se utilizará. Este valor siempre `oplogStore` es.
snapshotStoreFilter	matriz de objetos	Matriz de identificadores únicos que representan almacenes de instantáneas específicos y sus tipos, que pueden usarse con las tareas de copia de seguridad de este proyecto. Si se omite, se utilizan todos los almacenes de instantáneas disponibles.
snapshotStoreFilter.id	string	El identificador único que representa almacenes de instantáneas específicos que se pueden utilizar con los trabajos de respaldo de este proyecto.
tipo de filtro de tienda de instantáneas	string	El tipo de almacén de instantáneas específico se indica como `snapshotStoreFilter.id`. Los valores aceptados para esta opción son: `s3blockstore` `blockstore` `fileSystemStore`
Filtro de almacenamiento de sincronización	matriz de cadenas	Una matriz de filtros de almacenamiento de sincronización que se pueden usar con las tareas de copia de seguridad de este proyecto. Si se omite, se utilizan todos los almacenes de sincronización disponibles.

Ejemplo de solicitud

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --header 'Content-Type: application/json' \
 --include \
 --request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/groups/{PROJECT-ID}?pretty=true' \
 --data '{
  "daemonFilter" : [ {
     "headRootDirectory" : "/data/backup",
     "machine" : "http://backup.example.com"
   } ],
   "id" : "{PROJECT-ID}",
   "kmipClientCertPassword" : "P4$$w0rD",
   "kmipClientCertPath" : "/certs/kmip",
   "labelFilter" : [ "label1", "label2" ],
   "oplogStoreFilter" : [ {
     "id" : "oplog1",
     "type" : "oplogStore"
   } ],
   "snapshotStoreFilter" : [ {
     "id" : "sPid",
     "type" : "s3blockstore"
   } ],
   "syncStoreFilter" : [ "s1", "s2" ]
 }'

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

{
  "daemonFilter" : [ {
    "headRootDirectory" : "/data/backup",
    "machine" : "http://backup.example.com"
  } ],
  "id" : "{PROJECT-ID}",
  "kmipClientCertPassword" : "P4$$w0rD",
  "kmipClientCertPath" : "/certs/kmip",
  "labelFilter" : [ "label1", "label2" ],
  "links" : [ {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/groups/{PROJECT-ID}",
    "rel" : "self"
  }, {
    "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/groups/{PROJECT-ID}",
    "rel" : "http://mms.mongodb.com/group"
  } ],
  "oplogStoreFilter" : [ {
    "id" : "oplog1",
    "type" : "oplogStore"
  } ],
  "snapshotStoreFilter" : [ {
    "id" : "sPid",
    "type" : "s3blockstore"
  } ],
  "syncStoreFilter" : [ "s1", "s2" ]
}

Volver

Obtener todo

Claves de cifrado de respaldo