/ /

Administración de copias de seguridad

Almacén de bloques compatible con S3

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Administración de copias de seguridad

Almacén de bloques compatible con S3

Obtenga todas las configuraciones de S3 Blockstore

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

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

Indicador que indica si aceptaste o no los términos de servicio para utilizar almacenamiento compatible con S3 con Ops Manager. Debes establecerlo en true para crear un almacén de almacenamiento compatible con S3.

asignación habilitada

booleano

Flag that indicates whether you can assign backup jobs to this data store.

awsAccessKey

string

AWS Access Key ID that can access the S3-compatible storage bucket specified in s3BucketName.

clave secreta de aws

string

AWS Secret Access Key that can access the S3-compatible storage bucket specified in s3BucketName.

cerfiticados personalizados

arreglo

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

certificados personalizados[n].nombrearchivo

string

Name that identifies the Certificate Authority PEM file.

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 este almacén de bloques de almacenamiento compatible con S3 se cifraron mediante la herramienta de credenciales.

ID.

string

Name that uniquely identifies this S3-compatible storage blockstore.

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

Flag that indicates the style of this endpoint.

Valor	S3 Blockstore Endpoint Style	Ejemplo
`true`	Path-style URL endpoint	`s3.amazonaws.com/<bucket>`
`false`	Virtual-host-style URL endpoint	`<bucket>.s3.amazonaws.com`

To review the S3-compatible storage bucket URL conventions, see the AWS S3 documentation.

s3AuthMethod

string

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

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

`KEYS` or None	Ops Manager usa `awsAccessKey` y `awsSecretKey` para autorizar el acceso al depósito de almacenamiento compatible con S3 especificado en `s3BucketName`.
`IAM_ROLE`	Ops Manager uses an AWS IAM role to authorize access to S3-compatible storage bucket specified in `s3BucketName`. `awsAccessKey` and `awsSecretKey` fields are ignored. To learn more, see the AWS documentation

Punto final del cubo s3

string

URL that Ops Manager uses to access this S3-compatible storage bucket.

s3BucketName

string

Name of the S3-compatible storage bucket that hosts the S3-compatible storage blockstore.

Conexiones s3Max

entero

Positive integer indicating the maximum number of connections to this S3-compatible storage blockstore.

s3RegionOverride

string

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

Ops Manager returns this field only if you included it when you created or updated this S3-compatible storage blockstore.

sseHabilitado

booleano

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

ssl

booleano

Flag that indicates whether this S3-compatible storage blockstore only accepts connections encrypted using TLS.

uri

string

Connection String that connects to the metadata database for this S3-compatible storage blockstore. This database stores the locations of the blocks in the AWS S3-compatible storage bucket.

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