Obtener todas las regiones de implementación

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} Es el mismo que el ID de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. Esta página utiliza el término "grupo" para las descripciones. El punto final se mantiene como se indica en el documento.

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

Resource

GET /admin/backup/backupDeployments

Request Parameters

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 un impresión bonita formato.	`false`
envolvente	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 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

Nombre	Tipo	Descripción
`assignmentEnabled`	booleano	Flag indicating whether you can assign Deployment Regions to backup resources.
`bqProxyEndpoint`	string	Instancia de Ops Manager que atiende solicitudes de copia de seguridad consultables. El valor tiene el siguiente`domain:port` formato:. Por ejemplo,. `localhost:8080`
`deploymentDescription`	string	Cadena que describe el propósito de la región de implementación.
`id`	string	Identificador único que hace referencia a esta región de implementación en las configuraciones.
`ingestionEndpoint`	string	Ops Manager instance to which the Backup Agent writes snapshot or oplog data. Value is a valid URL such as `http://www.mongodb.com`. Supports both HTTP and HTTPS.
`links`	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.
`restoreEndpoint`	string	Instancia de Ops Manager que atiende solicitudes de restauración.

Ejemplo de solicitud

Cuerpo de la solicitud

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --include \
     --request GET "https://{opsManagerHost}:{port}/api/public/v1.0/admin/backup/backupDeployments"

Cuerpo de respuesta

1 {
2   "links" : [ ],
3   "results" : [ {
4     "assignmentEnabled" : true,
5     "bqProxyEndpoint" : "queryable-backup.mongodb.com:27217",
6     "deploymentDescription" : "Eastern US",
7     "id" : "NY_NJ",
8     "ingestionEndpoint" : "https://api-backup.mongodb.com",
9     "links" : [ ],
10     "restoreEndpoint" : "https://api-backup.mongodb.com"
11   } ],
12   "totalCount" : 1
13 }

Volver

Regiones de implementación

Consigue uno

1	{
2	"links" : [ ],
3	"results" : [ {
4	"assignmentEnabled" : true,
5	"bqProxyEndpoint" : "queryable-backup.mongodb.com:27217",
6	"deploymentDescription" : "Eastern US",
7	"id" : "NY_NJ",
8	"ingestionEndpoint" : "https://api-backup.mongodb.com",
9	"links" : [ ],
10	"restoreEndpoint" : "https://api-backup.mongodb.com"
11	} ],
12	"totalCount" : 1
13	}