Obtener todas las regiones de implementación

Nota

Grupos y proyectos son términos sinónimos. Tu {PROJECT-ID} es el mismo que tu id. de proyecto. Para los grupos existentes, su ID de grupo/ID del grupo seguirá siendo el mismo. Esta página utiliza el término más familiar grupo al referirse a descripciones. El endpoint se mantiene tal 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 Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
Num. de pág.	Número	Opcional	Entero basado en uno que devuelve una subsección de resultados.	`1`
elementosPorPágina	Número	Opcional	Número de elementos a devolver por página, hasta un máximo de 500.	`100`
bonito	booleano	Opcional	Bandera que indica si el cuerpo de la respuesta debe estar en una pretty-print formato.	`false`
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 `content` 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

Nombre	Tipo	Descripción
`assignmentEnabled`	booleano	Indicador que señala si puede asignar Regiones de implementación para recursos de copia de seguridad.
`bqProxyEndpoint`	string	Instancia de Ops Manager que presta servicios a las solicitudes de respaldo consultable. El valor está en el siguiente formato: `domain:port`. Por ejemplo, `localhost:8080`.
`deploymentDescription`	string	String que describe el propósito de la región de implementación.
`id`	string	Identificador único que referencia esta región de implementación en las configuraciones.
`ingestionEndpoint`	string	Instancia de Ops Manager a la que el agente de copias de seguridad escribe datos de instantánea u oplog. El valor es una URL válida, como `http://www.mongodb.com`. Admite tanto HTTP como HTTPS.
`links`	objeto arreglo	Uno o más enlaces a subrecursos y/o recursos relacionados. Todos los `links` arreglos en las respuestas incluyen al menos un enlace llamado `self`. Las relaciones entre URLs se explican en la Especificación de Enlaces Web.
`restoreEndpoint`	string	Instancia de Ops Manager que atiende solicitudes de restauración.

Solicitud de ejemplo

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"

Respuesta del cuerpo

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

Obtenga 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	}