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://cloud.mongodb.com/api/public/v1.0
Resource
GET /groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}
Request Parameters
Parámetros de la ruta de solicitud
Parameter | Tipo | Necesidad | Descripción |
|---|---|---|---|
PROJECT-ID | string | Requerido | Cadena de dígitos hexadecimales 24única que identifica el proyecto que contiene el clúster con la configuración de respaldo que desea encontrar. |
CLUSTER-ID | string | Requerido | string única de 24 dígitos hexadecimales que identifica el clúster cuya configuración de copia de seguridad deseas encontrar. |
Parámetros de consulta de solicitud
Los siguientes parámetros de consulta son opcionales:
Nombre | Tipo | Necesidad | Descripción | predeterminado | ||||||
|---|---|---|---|---|---|---|---|---|---|---|
bonita | booleano | Opcional | Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint formato. |
| ||||||
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 un resultado, el cuerpo de la respuesta incluye:
|
|
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 |
|---|---|---|
availableMembers | matriz de cadenas | Lista de miembros del clúster disponibles para copia de seguridad. Solo aparece para solicitudes de miembros. |
clusterId | string | Cadena de dígitos hexadecimales 24única que identifica el clúster que se configurará para la copia de seguridad. |
espacios de nombres excluidos | matriz de cadenas | Lista de nombres de bases de datos y colecciones que se omitirán en la copia de seguridad. Cada cadena es un espacio de nombres con el formato Debe enviar la nueva lista completa de espacios de nombres excluidos, incluidos todos los que ya estaban incluidos. Si la nueva lista elimina algún espacio de nombres de la lista anterior, también debe configurar el campo Si la nueva lista solo se agrega a la lista anterior, no es necesario configurar |
ID de grupo | string | Cadena de dígitos hexadecimales 24única que identifica el proyecto que posee esta configuración de respaldo. |
espacios de nombres incluidos | matriz de cadenas | Lista de nombres de bases de datos y colecciones que se incluirán en la copia de seguridad. Cada cadena es un espacio de nombres con el Debe enviar la nueva lista completa de espacios de nombres incluidos, incluidos todos los que ya estaban enumerados. Si la nueva lista añade espacios de nombres a la lista anterior, también debe configurar el campo Si la nueva lista solo elimina espacios de nombres de la lista anterior, no es necesario configurar |
enlaces | matriz de objetos | Uno o más enlaces a subrecursos o recursos relacionados. Todas las |
Miembro preferido | string | Miembro del clúster designado manualmente como miembro preferido para la copia de seguridad. Solo aparece para las solicitudes de miembro cuando el miembro preferido está configurado con el Interfaz de usuario o API. |
SSL habilitado | booleano | Bandera que identifica si TLS está habilitado para la base de datos de origen de sincronización. |
nombreDeEstado | string | Estado actual (o deseado) de la configuración de la copia de seguridad. Los valores posibles son:
|
nombreDeMotorDeAlmacenamiento | string | Motor de almacenamiento utilizado para la copia de seguridad. Los valores posibles son:
|
Ejemplo de solicitud
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}"
Cuando se inicia cada snapshot, Cloud Manager selecciona un miembro del set de réplicas para ejecutar el snapshot. Este nodo seleccionado automáticamente debe tener el menor impacto en el rendimiento del set de réplicas. Puede anular la selección por defecto.
Importante
Usar default selection siempre que sea posible. Esta opción garantiza la disponibilidad de la copia de seguridad.
La siguiente solicitud devuelve los miembros disponibles.
curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \ --header "Accept: application/json" \ --include \ --request GET "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/backupConfigs/{CLUSTER-ID}/availableMembers?pretty=true"
Ejemplo de respuesta
Encabezado de respuesta
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
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
1 { 2 "clusterId" : "{CLUSTER-ID}", 3 "excludedNamespaces" : [ ], 4 "groupId" : "{PROJECT-ID}", 5 "includedNamespaces" : [ ], 6 "links" : [ ], 7 "sslEnabled" : false, 8 "statusName" : "STARTED", 9 "storageEngineName" : "WIRED_TIGER" 10 }
Cuando se inicia cada snapshot, Cloud Manager selecciona un miembro del set de réplicas para ejecutar el snapshot. Este nodo seleccionado automáticamente debe tener el menor impacto en el rendimiento del set de réplicas. Puede anular la selección por defecto.
Importante
Utilice default selection siempre que sea posible. Esta opción garantiza la disponibilidad de la copia de seguridad.
La siguiente respuesta incluye los miembros disponibles y el miembro preferente designado. Si un miembro preferente no está definido, se excluye de la respuesta.
1 { 2 "availableMembers" : [ "{HOSTNAME1}:{PORT1}", "{HOSTNAME2}:{PORT2}", "{HOSTNAME3}:{PORT3}"], 3 "clusterId" : "{CLUSTER-ID}", 4 "excludedNamespaces" : [ ], 5 "groupId" : "{PROJECT-ID}", 6 "includedNamespaces" : [ ], 7 "links" : [ ], 8 "sslEnabled" : false, 9 "statusName" : "STARTED", 10 "storageEngineName" : "WIRED_TIGER", 11 "preferredMember" : "{HOSTNAME1}:{PORT1}" 12 }