/ /

Administración de copias de seguridad

S3 Oplog

Docs Home

Gestión

Gerente de Operaciones

API

Recursos

Administración de copias de seguridad

S3 Oplog

actualizar One S3 Oplog Configuration

Actualiza la configuración de un almacén de registros de operaciones s3.

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

Resource

PUT /oplog/s3Configs/{S3-OPLOG-CONFIG-ID}

Parámetros de la ruta de solicitud

Nombre	Tipo	Descripción
S3-OPLOG-CONFIG-ID	string	El identificador único que representa esta configuración de S3 Oplog.

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 debe estar en un 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 un resultado, el cuerpo de la respuesta incluye:

Nombre	Descripción
`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 se establece en false, Ops Manager devuelve un error que indica que Ops Manager no puede crear el almacén de almacenamiento compatible con S3.

asignación habilitada

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.

clave secreta de aws

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 depósito de almacenamiento compatible con S3 asociado.

customCertificates[n].filename

string

Opcional

Nombre que identifica el archivo PEM de la Autoridad Certificadora.

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 muestra si la Se debe usar un HTTP proxy al conectarse a un almacenamiento compatible con S3. No necesitas configurar este valor a menos que hayas configurado Ops Manager para usar el HTTP proxy.

encryptedCredentials

booleano

Opcional

Indicador que muestra si el nombre de usuario y la contraseña de este almacén oplog de almacenamiento compatible con S3fueron cifrado utilizando credentialstool.

etiquetas

Arreglo de cadenas

Opcional

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

Configurar estas etiquetas limita qué tareas de copia de seguridad puede procesar esta tienda de oplog de almacenamiento compatible con S3. Si se omite, este almacenamiento de Oplog compatible con S3sólo puede procesar tareas de copia de seguridad para Proyectos que no utilicen etiquetas para filtrar sus tareas.

pathStyleAccessEnabled

booleano

Requerido

Bandera que indica el estilo de este endpoint.

Valor	Estilo de punto final de almacén Oplog 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 depósito de almacenamiento compatible con S3 especificado en s3BucketName.

Ops Manager acepta los siguientes valores:

`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

Punto final del cubo s3

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 S3que aloja el almacén de registro de operaciones compatible con S3.

s3MaxConnections

Número

Requerido

Entero positivo que indica el número máximo de conexiones a este almacén de registros de operaciones de almacenamiento 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

Indicador que señala si este almacén de Oplog compatible con S3habilita el cifrado del lado del servidor.

uri

string

Requerido

Lista separada por comas de hosts en el formato <hostname:port> que pueden acceder a esta tienda de registros de operación de almacenamiento compatible con S3.

ssl

booleano

Opcional

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

writeConcern

string

Opcional

Nivel de confirmación de escritura (write concern) usado para este almacén de oplog.

Ops Manager acepta 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).

Respuesta

Nombre

Tipo

Descripción

Términos aceptados

booleano

asignación habilitada

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.

clave secreta de aws

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 depósito de almacenamiento compatible con S3 asociado.

customCertificates[n].filename

string

Nombre que identifica el archivo PEM de la Autoridad Certificadora.

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 muestra si el nombre de usuario y la contraseña de este almacén oplog de almacenamiento compatible con S3fueron cifrado utilizando credentialstool.

string

Nombre que identifica de manera única esta tienda oplog de almacenamiento compatible con S3.

etiquetas

Arreglo de cadenas

Arreglo de etiquetas para gestionar a qué tareas de copia de seguridad Ops Manager puede asignar a los almacenes de oplog compatibles con S3.

enlaces

objeto arreglo

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.

pathStyleAccessEnabled

booleano

Bandera que indica el estilo de este endpoint.

Valor	Estilo de punto final de almacén Oplog 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.

Punto final del cubo s3

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 S3que aloja el almacén de registro de operaciones compatible con S3.

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 devuelve este campo solo si lo incluyó cuando creó o actualizó este almacén3de registros de operaciones de almacenamiento compatible con S.

sseEnabled

booleano

Bandera que indica si este almacenamiento de oplog compatible con S3habilita el cifrado del lado del servidor.

ssl

booleano

Bandera que indica si este3almacén de registros de operaciones 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 para este almacén3de registros de operaciones de almacenamiento compatible con S. Esta base de datos almacena las ubicaciones de los bloques en el3contenedor de almacenamiento compatible con S.

writeConcern

string

Nivel de confirmación de escritura (write concern) usado para este almacén de oplog.

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).

Solicitud de ejemplo

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --header 'Content-Type: application/json' \
 --include \
 --request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/oplog/s3Configs/{S3-OPLOG-CONFIG-ID}?pretty=true' \
 --data '{
   "assignmentEnabled": true,
   "awsAccessKey": "access",
   "awsSecretKey": "secret",
   "encryptedCredentials": false,
   "labels": [
     "l1",
     "l2"
   ],
   "s3BucketEndpoint": "http://backup.example.com/oplog",
   "s3BucketName": "oplog",
   "uri": "mongodb://localhost:27017",
   "ssl": true,
   "writeConcern": "W2"
 }'

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

{
  "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/oplog/s3Configs/{S3-OPLOG-CONFIG-ID}",
      "rel": "self"
    }
  ],
  "s3BucketEndpoint": "http://backup.example.com/oplog",
  "s3BucketName": "oplog",
  "uri": "mongodb://localhost:27017",
  "ssl": true,
  "writeConcern": "W2"
}

Volver

Crear

Borrar