/ /

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 Oplog S3.

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

Nombre	Descripción
`status`	Código de respuestaHTTP
`content`	Cuerpo de respuesta esperado

false

Parámetros del cuerpo de la solicitud

Nombre

Tipo

Necesidad

Descripción

Términos de servicio aceptados

booleano

Requerido

Marca que indica si aceptó o no los términos de servicio para usar almacenes de almacenamiento compatibles con S3con Ops Manager. Debe establecerlo 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

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

awsAccessKey

string

Condicional

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

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

clave secreta de aws

string

Condicional

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

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

certificados personalizados[n].nombrearchivo

string

Opcional

Nombre que identifica el archivo PEM de la Autoridad Certificadora.

certificados personalizados[n].certString

string

Opcional

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

deshabilitarProxyS3

booleano

Opcional

Bandera que indica si el Se debe usarun proxy HTTP al conectarse a un 3almacenamiento compatible con S. No es necesario configurar este valor a menos que haya configurado Ops Manager para usarlo.

encryptedCredentials

booleano

Opcional

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

Etiquetas

matriz de cadenas

Opcional

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

La configuración de estas etiquetas limita los trabajos de copia de seguridad que este almacén de registros de operaciones de almacenamiento compatible con S3puede procesar. Si se omite, este almacén de registros de operaciones de almacenamiento compatible con S3solo puede procesar trabajos de copia de seguridad de proyectos que no usan etiquetas para filtrar sus trabajos.

pathStyleAccessEnabled

booleano

Requerido

Bandera que indica el estilo de este punto final.

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

Opcional

Método utilizado para autorizar el acceso al3depósito de almacenamiento compatible con S especificado en s3BucketName.

Ops Manager acepta los siguientes valores:

`KEYS` o Ninguno	Ops Manager usa awsAccessKey y awsSecretKey para autorizar el acceso al3depósito de almacenamiento compatible con S especificado 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 en s3BucketName. Los camposawsAccessKey y awsSecretKey se ignoran. Para obtener más información, consulte la documentación de AWS.

s3Punto final del depósito

string

Requerido

URL utilizada para acceder a este3depósito de almacenamiento compatible con S.

s3Nombre del depósito

string

Requerido

Nombre del depósito de almacenamiento compatible con S3que aloja el almacén de registros de operaciones de almacenamiento 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.

s3Anulación de región

string

Condicional

Región donde reside su depósito de almacenamiento compatible con S3.

Utilice este campo solo si el3 s3BucketEndpoint de su almacén de almacenamiento compatible con S no admite el ámbito regional. No utilice este campo con3 buckets de AWS S.

sseHabilitado

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 formato <hostname:port> que pueden acceder a este almacén de registros de operaciones 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

Escriba la preocupación utilizada para esta tienda de oplog.

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

Respuesta

Nombre

Tipo

Descripción

Términos de servicio aceptados

booleano

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 registros de operaciones de almacenamiento compatible con S se cifraron mediante la herramienta de credenciales.

ID.

string

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

Etiquetas

matriz de cadenas

Matriz de etiquetas para administrar qué trabajos de respaldo puede asignar Ops Manager a qué3almacenes oplog de almacenamiento compatibles con 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.

pathStyleAccessEnabled

booleano

Bandera que indica el estilo de este punto final.

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

s3Punto final del depósito

string

URL que Ops Manager utiliza para acceder a este3depósito de almacenamiento compatible con S.

s3Nombre del depósito

string

Nombre del depósito de almacenamiento compatible con S3que aloja el almacén de registros de operaciones 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 de almacenamiento compatible con S 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.

sseHabilitado

booleano

Bandera que indica si este3almacén de registros de operaciones de almacenamiento compatible con S habilita 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

Escriba la preocupación utilizada para esta tienda de oplog.

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' \
 --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"
 }'

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

{
  "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