Docs Home

/ /

Snapshots

Docs Home

/ /

Copia de seguridad y restauración

Snapshots

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Copia de seguridad y restauración

Snapshots

Crear una snapshot bajo demanda

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

Resource

POST /groups/{groupId}/clusters/{clusterId}/snapshots/onDemandSnapshot

Permisos requeridos

Debes tener el Global Backup Admin para tomar una instantánea a pedido.

Request Parameters

Parámetros de la ruta de solicitud

Nombre	Tipo	Descripción
ID del grupo	string	Identificador único de tu proyecto desde la configuración del proyecto.
CLUSTER-ID	string	Identificador único del clúster que el snapshot represents.

Parámetros de Solicitud Query

Nombre	Tipo	Necesidad	Descripción	Ejemplo
retentionDays	Número	Requerido	Un número entero que indica la cantidad de días que la snapshot on-demand se conservará. Debe ser mayor que 0.	`15`
envelope	booleano	Opcional	Bandera que indica si se debe o no envolver la respuesta en un sobre. 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 endpoints que devuelven una lista de resultados, el objeto `results` es un sobre. Ops Manager agrega el campo `status` al cuerpo de la respuesta.	`false`

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Solicitud de ejemplo

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
 --include \
 --request POST "https://{opsManagerHost}:{port}/api/public/v1.0/groups/{groupId}/clusters/{clusterId}/snapshots/onDemandSnapshot"

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

{
   "clusterName": "myCluster",
   "description": "On demand snapshot request complete .",
   "timestamp": {
       "increment": 1,
       "time": 1719518976,
       "date": "2024-06-27T20:09:36Z"
   }
}

Volver

Remover uno

Obtener todo (Servidor de configuración)