/ /

Administración de copias de seguridad

Almacén de bloques compatible con S3

Docs Home

MongoDB Ops Manager

API

Recursos

Administración de copias de seguridad

Almacén de bloques compatible con S3

Obtener todas las configuraciones de Blockstore S3

Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de MongoDB Ops Manager.

Recupera las configuraciones de todos los almacenes de bloques s3.

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

Resource

GET /snapshot/s3Configs

Parámetros de la ruta de solicitud

Este punto final no utiliza parámetros de ruta de solicitud HTTP.

Parámetros de consulta de solicitud

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 formato prettyprint 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`

Solo asignable	booleano	Bandera que indica si a este almacén de bloques S3 se le pueden asignar nuevos trabajos de respaldo.	`true`

Parámetros del cuerpo de la solicitud

Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.

Respuesta

Documento de respuesta

El documento JSON de respuesta incluye una matriz de result objetos, una matriz de link objetos y un recuento del número total de result objetos recuperados.

Nombre	Tipo	Descripción
`results`	arreglo	La matriz incluye un objeto para cada elemento detallado en el Sección`results` de documento incrustado.
`links`	arreglo	La matriz incluye uno o más enlaces a subrecursos o recursos relacionados. Las relaciones entre las URLse explican en la Especificación de Enlaces Web.
`totalCount`	Número	Número entero del número total de elementos en el conjunto de resultados. Puede ser mayor que el número de objetos en la matriz results si todo el conjunto de resultados está paginado.

`results` Documento incrustado

Cada resultado es un almacenamiento en bloques S3.

Nombre

Tipo

Descripción

Términos de servicio aceptados

booleano

Marca que indica si aceptó o no los términos de servicio para usar almacenes compatibles con almacenamiento S3con Ops Manager. Debe establecerlo en true para crear un almacén compatible con almacenamiento S3.

asignación habilitada

booleano

Bandera que indica si puede asignar trabajos de respaldo a este almacén de datos.

awsAccessKey

string

ID de clave de acceso deAWS que puede acceder al 3depósito de almacenamiento compatible con S especificado en s3BucketName.

clave secreta de aws

string

Clave de acceso secreta deAWS que puede acceder al 3depósito de almacenamiento compatible con S especificado en s3BucketName.

cerfiticados personalizados

arreglo

Lista de certificados de autoridad de certificación válidos que se aplican al depósito de almacenamiento compatible con S3asociado.

certificados personalizados[n].nombrearchivo

string

Nombre que identifica el archivo PEM de la Autoridad Certificadora.

certificados personalizados[n].certString

string

Contenido del archivo de la Autoridad Certificadora PEM que conforma tu cadena de Autoridad Certificadora.

deshabilitarProxyS3

booleano

Indicador que indica si se debe usar el proxy HTTP al conectarse al almacenamiento compatible con S3.

encryptedCredentials

booleano

Bandera que indica si el nombre de usuario y la contraseña para este3almacén de bloques de almacenamiento compatible con S se cifraron mediante la herramienta de credenciales.

ID.

string

Nombre que identifica de forma única este almacén de bloques de almacenamiento compatible con S3.

Etiquetas

matriz de cadenas

Matriz de etiquetas para administrar qué trabajos de respaldo puede asignar Ops Manager a qué almacenes de3 bloques S.

enlaces

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.

factor de carga

entero

Entero positivo distinto de cero que expresa la cantidad de trabajo de copia de seguridad que realiza este almacén de instantáneas en comparación con otro. Esta opción solo es necesaria si se utilizan más de un almacén de instantáneas.

Para obtener más información Load Factor sobre, consulte Editar un almacén de bloques existente.

pathStyleAccessEnabled

booleano

Bandera que indica el estilo de este punto final.

Valor	Estilo de punto final de Blockstore S3	Ejemplo
`true`	Punto final de URL de estilo de ruta	`s3.amazonaws.com/<bucket>`
`false`	Punto final de URL de estilo de host virtual	`<bucket>.s3.amazonaws.com`

Para revisar las convenciones3 de URL de depósitos de almacenamiento compatibles con S, consulte la documentación de AWS S.3

s3Método de autenticación

string

Método utilizado para autorizar el acceso al depósito de almacenamiento compatible con S3especificado en s3BucketName.

Los valores aceptados para esta opción son: KEYS, IAM_ROLE.

`KEYS` o Ninguno	Ops Manager usa `awsAccessKey` y `awsSecretKey` para autorizar el acceso al depósito de almacenamiento compatible con S3especificado en `s3BucketName`.
`IAM_ROLE`	Ops Manager utiliza un rol de IAM de AWS para autorizar el acceso al 3depósito de almacenamiento compatible con S especificado `s3BucketName` en. `awsAccessKey` Los `awsSecretKey` campos y se ignoran. Para obtener más información, consulte la documentación de AWS.

s3Punto final del depósito

string

URL que Ops Manager utiliza para acceder a este 33depósito de almacenamiento compatible con AWS S o S.

s3Nombre del depósito

string

Nombre del depósito de almacenamiento compatible con S3que aloja el almacén de bloques de almacenamiento compatible con S3.

s3MaxConnections

entero

Entero positivo que indica el número máximo de conexiones a este almacén de bloques de almacenamiento compatible con S3.

s3Anulación de región

string

Región donde3reside su bucket de almacenamiento compatible con S. Este campo solo se aplica si el3 s3BucketEndpoint de su almacén compatible con S no admite el alcance regional.

Ops Manager devuelve este campo solo si lo incluyó cuando creó o actualizó este3almacén de bloques de almacenamiento compatible con S.

sseHabilitado

booleano

Bandera que indica si este3almacén de bloques de almacenamiento compatible con S habilita el cifrado del lado del servidor.

ssl

booleano

Bandera que indica si este3almacén de bloques de almacenamiento compatible con S solo acepta conexiones cifradas mediante TLS.

uri

string

Cadena de conexión que conecta con la base de datos de metadatos de este almacén3de bloques de almacenamiento compatible con S. Esta base de datos almacena las ubicaciones de los bloques en el 3depósito de almacenamiento compatible con AWS S.

writeConcern

string

Nivel de confirmación de escritura (write concern) utilizado por este almacenamiento en bloques.

Ops Manager devuelve uno de los siguientes valores:

ACKNOWLEDGED
W2
JOURNALED
MAJORITY

Para obtener más información sobre los niveles de reconocimiento de escritura en MongoDB, consulte Preocupación de escritura.

Ejemplo de solicitud

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/s3Configs?pretty=true'

Ejemplo de respuesta

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}

Cuerpo de respuesta

{
  "links" : [ {
    "href" : "http://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/s3Configs?pretty=true&pageNum=1&itemsPerPage=100",
    "rel" : "self"
  } ],
  "results" : [ {
    "assignmentEnabled": true,
    "awsAccessKey": "access",
    "awsSecretKey": "secret",
    "encryptedCredentials": false,
    "id": "id",
    "labels": [
      "l1",
      "l2"
    ],
    "links": [
      {
        "href": "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-ID}",
        "rel": "self"
      }
    ],
    "loadFactor": 50,
    "s3BucketEndpoint": "http://example.com/backupbucket",
    "s3BucketName": "buck1",
    "uri": "mongodb://localhost:27017",
    "ssl": true,
    "writeConcern": "W2"
  } ],
  "totalCount" : 1
}

Volver

Obtener por identificación

Crear

Resource

Parámetros de la ruta de solicitud

Parámetros de consulta de solicitud

Parámetros del cuerpo de la solicitud

Respuesta

Documento de respuesta

results Documento incrustado

Ejemplo de solicitud

Ejemplo de respuesta

Encabezado de respuesta

Cuerpo de respuesta

`results` Documento incrustado