/ /

Almacenamiento de bloques compatible con S3(v2.0)

/ /

Administración de copias de seguridad

Almacenamiento de bloques compatible con S3(v2.0)

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Administración de copias de seguridad

Almacenamiento de bloques compatible con S3(v2.0)

Actualización de la configuración del almacén de bloques S3 (v2.0)

Actualiza una configuración de almacenamiento en bloques compatible con S3. El recurso v2.0 agrega el keyVault objeto. Con este objeto, el almacén de bloques de almacenamiento compatible con S3lee su Credenciales deAWS de HashiCorp Vault. Para obtener más información, consulte HashiCorp Vault para credenciales de almacenamiento de instantáneas.

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

Resource

PUT /snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}

Parámetros de ruta de solicitud

Nombre	Tipo	Descripción
S3-BLOCKSTORE-CONFIG-ID	string	El nombre único que identifica esta configuración de almacenamiento en bloques compatible con S3.

Parámetros de Solicitud Query

Los siguientes parámetros de query son opcionales:

Nombre	Tipo	Necesidad	Descripción	predeterminado
bonito	booleano	Opcional	Indicador que señala si el cuerpo de la respuesta está en un pretty-print formato.	`false`
envelope	booleano	Opcional	Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, ajusta envelope=true en la query. Para los endpoints que devuelven un resultado, el cuerpo de la respuesta incluye: `status`: Código de respuesta HTTP `content`: Cuerpo de respuesta esperado	`false`

Parámetros del cuerpo de la solicitud

Nombre

Tipo

Necesidad

Descripción

Términos aceptados

booleano

Requerido

Indicador que señala si has aceptado o no los términos de uso para usar almacenes de almacenamiento compatibles con S3 con Ops Manager. Debes establecer esto en true para crear un almacén de almacenamiento compatible con S3.

Si estableces este valor en false, el Administrador de operaciones devuelve un error. El error indica que Ops Manager no puede crear el almacén de almacenamiento compatible con S3.

assignmentEnabled

booleano

Opcional

Indicador que señala si puede asignar tareas de copia de seguridad a este almacén de datos.

awsAccessKey

string

Condicional

ID de clave de acceso AWS que puede acceder al bucket de almacenamiento compatible con S3 especificado en s3BucketName.

Si "s3AuthMethod" : "IAM_ROLE", entonces no es necesario incluir awsAccessKey.

awsSecretKey

string

Condicional

AWS Clave de acceso secreta que puede acceder al bucket de almacenamiento compatible con S3 especificado en <s3BucketName>.

Si "s3AuthMethod" : "IAM_ROLE", entonces no es necesario incluir awsSecretKey.

cerfiticados personalizados

arreglo

Opcional

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

customCertificates[n].filename

string

Opcional

Nombre que identifica el archivo PEM de la Autoridad de Certificación.

customCertificates[n].certString

string

Opcional

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

deshabilitarProxyS3

booleano

Opcional

Indicador que indica si se debe utilizar el proxy HTTP al conectarse a un almacenamiento compatible con S3. No necesitas establecer este valor a menos que hayas configurado Ops Manager para usar el proxy HTTP.

encryptedCredentials

booleano

Opcional

Indicador que señala si el nombre de usuario y la contraseña para este almacenamiento compatible con S3 se cifraron utilizando la herramienta de credenciales.

etiquetas

Arreglo de cadenas

Opcional

Arreglo de etiquetas para gestionar qué tareas de copia de seguridad Ops Manager puede asignar a qué almacenamientos en bloque S3.

Si se establece estas etiquetas se limitan qué tareas de copia de seguridad puede procesar esta tienda de almacenamiento compatible con S3. Si se omite, este almacenamiento en bloques compatible con S3 solo puede procesar tareas de copia de seguridad para proyectos que no utilizan etiquetas para filtrar sus tareas.

factor de carga

Número

Opcional

Un número entero positivo no nulo que expresa la cantidad de trabajo de copia de seguridad que esta almacenamiento de snapshot realiza en comparación con otro almacenamiento de instantáneas. Esta opción solo es necesaria si se utiliza más de un almacenamiento de snapshot.

Para aprender más acerca de Load Factor, consulta Editar un almacenamiento en bloques existente.

objectLockEnabled

booleano

Opcional

Bandera que indica si el bloqueo de objetos está habilitado para evitar que los objetos en un bucket S3 se eliminen.

pathStyleAccessEnabled

booleano

Requerido

Bandera que indica el estilo de este endpoint.

Valor	Estilo del endpoint de almacenamiento en bloques de S3	Ejemplo
`true`	Punto final de URL con estilo de ruta	`s3.amazonaws.com/<bucket>`
`false`	Punto final de URL de estilo host virtual	`<bucket>.s3.amazonaws.com`

Para revisar las convenciones del bucket de almacenamiento URL compatible con S3, consulte la documentación de AWS S3.

s3AuthMethod

string

Opcional

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

Ops Manager acepta los valores siguientes:

`KEYS` o ninguno	Ops Manager utiliza awsAccessKey y awsSecretKey para autorizar el acceso a un depósito de almacenamiento compatible con S3 especificado en s3BucketName.
`IAM_ROLE`	Ops Manager utiliza un rol de AWS IAM para autorizar el acceso al bucket de almacenamiento compatible con S3especificado en s3BucketName. Los campos awsAccessKey y awsSecretKey se pasan por alto. Para obtener más información, consulta la documentación de AWS

s3BucketEndpoint

string

Requerido

URL utilizada para acceder a este bucket de almacenamiento compatible con S3.

s3BucketName

string

Requerido

Nombre del depósito de almacenamiento compatible con S3 que aloja el almacenamiento en bloques compatible con S3.

s3MaxConnections

Número

Requerido

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

s3RegionOverride

string

Condicional

Región donde se encuentra su bucket de almacenamiento compatible con S3.

Utilice este campo solo si el s3BucketEndpoint de su almacén de almacenamiento compatible con S3 no admite el alcance regional. No uses este campo con los bucket AWS S3.

sseEnabled

booleano

Requerido

Bandera que indica si este blockstore de almacenamiento compatible con S3, permite cifrado del lado del servidor.

uri

string

Requerido

Lista separada por comas de hosts en formato <hostname:port> que pueden acceder a este blockstore de almacenamiento compatible con S3.

ssl

booleano

Opcional

Indicador que señala si este almacenamiento de bloque compatible con S3 sólo acepta conexiones cifradas mediante TLS.

writeConcern

string

Opcional

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

Ops Manager acepta los valores siguientes:

ACKNOWLEDGED
W2
JOURNALED
MAJORITY

Para obtener información sobre los niveles de reconocimiento de escritura en MongoDB, consulta nivel de confirmación de escritura (write concern).

Nota

Cuando s3AuthMethod sea KEYS, proporcione exactamente una de las siguientes fuentes de credenciales: el objeto keyVault o ambos, awsAccessKey y awsSecretKey. Cuando s3AuthMethod sea IAM_ROLE, no proporcione el objeto keyVault. Ops Manager devolverá un error si lo hace e ignorará cualquier valor awsAccessKey y awsSecretKey.

El recurso v2.0 agrega los siguientes parámetros de bóveda de clave:

Nombre	Tipo	Necesidad	Descripción
keyVault	Objeto	Condicional	Origen de credenciales respaldado por Vault para este almacén de instantáneas3compatible con S. Cuando `s3AuthMethod` `KEYS`sea, proporcione el `keyVault` objeto o bien `awsAccessKey` `awsSecretKey`y, pero no ambos. Para obtener más información, consulte HashiCorp Vault para credenciales de almacén de instantáneas.
keyVault.vaultId	string	Condicional	Identificador único de la configuración del almacén de claves que almacena las credenciales. Este valor coincide con el `id` de una configuración del almacén de claves. Obligatorio cuando se proporciona `keyVault`.
Ruta de la clave de acceso de AWS de keyVault	string	Condicional	Ruta a la clave de acceso de AWS en el almacén de claves, en el `<secret-path>/<key>` formato. Ops Manager lee el valor `<key>` 2 `<secret-path>secret/data/s3/aws-access-key` del `aws-access-key` campo del secreto de `secret/data/s3` la `/data/` versión del almacén de claves en. Por ejemplo, lee el campo del secreto en. Incluya el segmento que requiere la versión del almacén de 2 claves. No incluya el `/v1/` prefijo de API. Ops Manager agrega el prefijo automáticamente. Obligatorio cuando `keyVault` proporciona.
keyVault.awsSecretKeyPath	string	Condicional	Ruta a la clave secreta de AWS en el almacén de claves. Utiliza el mismo `<secret-path>/<key>` formato `keyVault.awsAccessKeyPath` que. Obligatorio cuando se `keyVault` proporciona.

Respuesta

Nombre

Tipo

Descripción

Términos 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.

assignmentEnabled

booleano

Indicador que señala si puede asignar tareas de copia de seguridad a este almacén de datos.

awsAccessKey

string

ID de clave de acceso AWS que puede acceder al bucket de almacenamiento compatible con S3 especificado en s3BucketName.

awsSecretKey

string

AWS Clave de acceso secreto que puede acceder al depósito de almacenamiento compatible con S3 especificado en s3BucketName.

cerfiticados personalizados

arreglo

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

customCertificates[n].filename

string

Nombre que identifica el archivo PEM de la Autoridad de Certificación.

customCertificates[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

Indicador que señala si el nombre de usuario y la contraseña para este almacenamiento compatible con S3 se cifraron utilizando la herramienta de credenciales.

string

Nombre que identifica de manera única a este almacenamiento en bloques compatible con S3.

etiquetas

Arreglo de cadenas

Arreglo de etiquetas para gestionar qué tareas de copia de seguridad Ops Manager puede asignar a qué almacenamientos en bloque S3.

enlaces

objeto arreglo

Uno o más enlaces a subrecursos o recursos relacionados. Todos los arreglos links en las respuestas incluyen al menos un enlace llamado self. Las relaciones entre las URLse explican en la Especificación de enlace web.

factor de carga

entero

Para obtener más información sobre Load Factor, consulte Editar un almacenamiento en bloques existente.

objectLockEnabled

booleano

Bandera que indica si el bloqueo de objetos está habilitado para evitar que los objetos en un bucket S3 se eliminen.

pathStyleAccessEnabled

booleano

Bandera que indica el estilo de este endpoint.

Valor	Estilo del endpoint de almacenamiento en bloques de S3	Ejemplo
`true`	Punto final de URL con estilo de ruta	`s3.amazonaws.com/<bucket>`
`false`	Punto final de URL de estilo host virtual	`<bucket>.s3.amazonaws.com`

Para revisar las convenciones del bucket de almacenamiento URL compatible con S3, consulte la documentación de AWS S3.

s3AuthMethod

string

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

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

`KEYS` o ninguno	Ops Manager utiliza `awsAccessKey` y `awsSecretKey` para autorizar el acceso al almacenamiento compatible con S3 especificado en `s3BucketName`.
`IAM_ROLE`	Ops Manager utiliza un rol de AWS IAM para autorizar el acceso al bucket de almacenamiento compatible con S3especificado en `s3BucketName`. Se ignoran los campos `awsAccessKey` y `awsSecretKey`. Para obtener más información, consulta la documentación de AWS

s3BucketEndpoint

string

URL que Ops Manager utiliza para acceder a este bucket de almacenamiento compatible con S3.

s3BucketName

string

Nombre del depósito de almacenamiento compatible con S3 que aloja el almacenamiento en bloques compatible con S3.

s3MaxConnections

entero

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

s3RegionOverride

string

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

Ops Manager devuelve este campo solo si lo incluiste al crear o actualizar este bloque de almacenamiento compatible con S3.

sseEnabled

booleano

Bandera que indica si este blockstore de almacenamiento compatible con S3, permite cifrado del lado del servidor.

ssl

booleano

Indicador que señala si este almacenamiento de bloque compatible con S3 sólo acepta conexiones cifradas mediante TLS.

uri

string

Cadena de conexión que conecta a la base de datos de metadatos para este bloque de almacenamiento compatible con S3. Esta base de datos almacena las ubicaciones de los bloques en el AWS depósito de almacenamiento compatible con S3.

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 información sobre los niveles de reconocimiento de escritura en MongoDB, consulta nivel de confirmación de escritura (write concern).

El recurso v2.0 agrega el siguiente campo de bóveda de claves:

Nombre	Tipo	Descripción
keyVault	Objeto	Origen de credenciales respaldado por bóveda para este almacén de instantáneas compatible con S3. Ops Manager devuelve este objeto solo cuando el almacén de instantáneas lee sus credenciales de una bóveda de claves.
keyVault.vaultId	string	Identificador único de la configuración del almacén de claves que almacena las credenciales.
Ruta de la clave de acceso de AWS de keyVault	string	Ruta en el almacén de claves a la clave de acceso de AWS.
keyVault.awsSecretKeyPath	string	Ruta en el almacén de claves a la clave secreta de AWS.

Solicitud de ejemplo

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --header 'Content-Type: application/json' \
     --include \
     --request PUT 'https://<OpsManagerHost>:<Port>/api/public/v2.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}?pretty=true' \
     --data '{
       "assignmentEnabled": true,
       "pathStyleAccessEnabled": false,
       "acceptedTos": true,
       "encryptedCredentials": false,
       "loadFactor": 1,
       "s3AuthMethod": "KEYS",
       "s3BucketEndpoint": "s3.amazonaws.com",
       "s3BucketName": "bucketname",
       "s3MaxConnections": 50,
       "sseEnabled": true,
       "uri": "mongodb://127.0.0.1:27017",
       "ssl": false,
       "writeConcern": "ACKNOWLEDGED",
       "keyVault": {
         "vaultId": "{KEY-VAULT-ID}",
         "awsAccessKeyPath": "path/to/awsAccessKey",
         "awsSecretKeyPath": "path/to/awsSecretKey"
       }
     }'

Respuesta de ejemplo

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}

Respuesta del cuerpo

{
  "acceptedTos": true,
  "assignmentEnabled": true,
  "encryptedCredentials": false,
  "id": "{S3-BLOCKSTORE-CONFIG-ID}",
  "keyVault": {
    "vaultId": "{KEY-VAULT-ID}",
    "awsAccessKeyPath": "path/to/awsAccessKey",
    "awsSecretKeyPath": "path/to/awsSecretKey"
  },
  "links": [
    {
      "href": "https://<OpsManagerHost>:<Port>/api/public/v2.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}",
      "rel": "self"
    }
  ],
  "loadFactor": 1,
  "pathStyleAccessEnabled": false,
  "s3AuthMethod": "KEYS",
  "s3BucketEndpoint": "s3.amazonaws.com",
  "s3BucketName": "bucketname",
  "s3MaxConnections": 50,
  "sseEnabled": true,
  "ssl": false,
  "uri": "mongodb://127.0.0.1:27017",
  "writeConcern": "ACKNOWLEDGED"
}

Volver

Crear

Borrar