Docs Home

/ /

Proyecto tarea de copia de seguridad

Docs Home

/ /

Administración de copias de seguridad

Proyecto tarea de copia de seguridad

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Administración de copias de seguridad

Proyecto tarea de copia de seguridad

Actualizar la configuración de trabajos de copia de seguridad de un proyecto

Actualiza la configuración de las tareas de copia de seguridad de un Proyecto.

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

Resource

PUT /groups/{PROJECT-ID}

Parámetros de ruta de solicitud

Nombre	Tipo	Descripción
PROJECT-ID	string	El identificador único que representa este proyecto y la configuración de su tarea de copia de seguridad.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre

Tipo

Necesidad

Descripción

predeterminado

bonito

booleano

Opcional

Indicador que señala si el cuerpo de la respuesta debe estar en un pretty-print formato.

false

envelope

booleano

Opcional

Bandera que indica si se debe o no envolver la respuesta en un sobre.

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

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

Nombre	Descripción
`status`	Código de respuesta HTTP
`content`	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Nombre	Tipo	Descripción
daemonFilter	objeto arreglo	opcional. Un arreglo de pares de hosts de daemon de copias de seguridad y sus directorios principales a los que se limitan las tareas de copia de seguridad de este proyecto. Si se omite, se utilizan todos los demonios de respaldo disponibles.
daemonFilter.headRootDirectory	string	opcional. La ruta relativa a la raíz del directorio principal en este daemon de copias de seguridad host.
daemonFilter.machine	string	La dirección del host de un host daemon de copias de seguridad.
ID	string	El identificador único que representa este proyecto y la configuración de su tarea de copia de seguridad.
kmipClientCertPassword	string	opcional. La contraseña que encripta el certificado de cliente KMIP.
kmipClientCertPath	string	opcional. La ruta relativa a la raíz en el daemon de copias de seguridad host que almacena el certificado de cliente KMIP.
labelFilter	Arreglo de cadenas	opcional. Un arreglo de etiquetas que limita qué daemons de copias de seguridad y almacenamientos de snapshot pueden procesar tareas de copia de seguridad para este Proyecto. Si un almacenamiento de snapshot o cualquier daemon de copias de seguridad tiene el mismo `labels` configurado que este `labelFilter`, ellos pueden procesar las tareas de copia de seguridad para este Proyecto. Si se omite, las tareas de copia de seguridad del Proyecto pueden usar cualquier daemon de copias de seguridad o almacenamiento de snapshot disponible.
oplogStoreFilter	Arreglo de objetos	opcional. Un arreglo de identificadores únicos que representan tiendas Oplog que pueden utilizarse con los trabajos de copia de seguridad de este proyecto. Si se omite, se podrán usar todos los almacenes de oplog disponibles.
oplogStoreFilter.id	string	Identificador único que representa un almacén de oplog que se puede utilizar con las tareas de copia de seguridad de este proyecto. Recupera el `id` del almacén de Oplog que deseas usar con Obtener todas las configuraciones de Oplog.
oplogStoreFilter.type	string	Tipo de almacenamiento de Oplog para usar. Los valores aceptados son: `oplogStore` `s3OplogStore` `thirdPartyOplogStore`
snapshotStoreFilter	Arreglo de objetos	opcional. Arreglo de identificadores únicos que representan almacenes de instantáneas específicos y sus tipos que se pueden utilizar con las tareas de copia de seguridad de este proyecto. Si se omite, se utilizan todos los almacenamientos de snapshot disponibles.
snapshotStoreFilter.id	string	opcional. El identificador único que representa almacenamientos de snapshot específicos que se pueden usar con las tareas de copia de seguridad de este Proyecto.
snapshotStoreFilter.type	string	opcional. El tipo del almacenamiento de snapshot específico proporcionado como `snapshotStoreFilter.id`. Los valores aceptados para esta opción son: `s3blockstore` `blockstore` `fileSystemStore`
syncStoreFilter	Arreglo de cadenas	opcional. Un arreglo de filtros del almacén de sincronización que pueden usarse con las tareas de copia de seguridad de este proyecto. Si se omite, se utilizan todas las tiendas de sincronización disponibles.

Respuesta

Nombre	Tipo	Descripción
daemonFilter	objeto arreglo	Un arreglo de pares de hosts de daemon de copias de seguridad y sus directorios principales a los que se limitan las tareas de copia de seguridad de este Proyecto.
daemonFilter.headRootDirectory	string	La ruta relativa a la raíz del directorio principal en este daemon de copias de seguridad host.
daemonFilter.machine	string	La dirección del host de un host daemon de copias de seguridad.
ID	string	El identificador único que representa este proyecto y la configuración de su tarea de copia de seguridad.
kmipClientCertPassword	string	La contraseña que cifra el certificado de cliente KMIP.
kmipClientCertPath	string	La ruta al directorio en el host del daemon de copias de seguridad que almacena el certificado de cliente KMIP.
enlaces	objeto arreglo	Uno o más enlaces a subrecursos o recursos relacionados. Todos los arreglos `links` en las respuestas incluyen al menos un enlace llamado `self`. Las relaciones entre las URLse explican en la Especificación de enlace web.
labelFilter	Arreglo de cadenas	Una matriz de etiquetas que limita qué demonios de copias de seguridad y almacenamientos de snapshots pueden procesar tareas de copia de seguridad para este proyecto.
oplogStoreFilter	Arreglo de objetos	Un arreglo de identificadores únicos que representan almacenes de Oplog que se pueden usar con las tareas de copia de seguridad de este Proyecto.
oplogStoreFilter.id	string	Identificador único que representa un almacén de oplog que se puede utilizar con las tareas de copia de seguridad de este proyecto.
oplogStoreFilter.type	string	Tipo de almacenamiento de Oplog para usar. Los valores aceptados son: `oplogStore` `s3OplogStore` `thirdPartyOplogStore`
snapshotStoreFilter	Arreglo de objetos	Arreglo de identificadores únicos que representan almacenamientos de snapshot 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 almacenamientos de snapshot disponibles.
snapshotStoreFilter.id	string	El identificador único que representa almacenamientos de snapshot específicos que pueden usarse con las tareas de copia de seguridad de este Proyecto.
snapshotStoreFilter.type	string	El tipo del almacenamiento de snapshot específico dada como `snapshotStoreFilter.id`. Los valores aceptados para esta opción son: `s3blockstore` `blockstore` `fileSystemStore`
syncStoreFilter	Arreglo de cadenas	Una matriz de filtros de almacén de sincronización que se pueden usar con las tareas de copia de seguridad de este proyecto. Si se omite, se utilizan todas las tiendas de sincronización disponibles.

Solicitud de ejemplo

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" ]
 }'

Respuesta de ejemplo

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}

Respuesta del cuerpo

{
  "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

Copia de seguridad de llaves de cifrado