Para agentes de IA: hay un índice de documentación disponible en https://www.mongodb.com/es/docs/llms.txt — versiones en markdown de todas las páginas están disponibles agregando .md a cualquier ruta URL.
Docs Menu
Docs Home
/ /
Almacenamiento en bloques compatible con S3(v2.0)
Docs Home
/ /
Administración de copias de seguridad
/
Almacenamiento en bloques compatible con S3(v2.0)
Docs Home
/
Gestión
/
Gerente de Operaciones
/
API
/
Recursos
/
Administración de copias de seguridad
/
Almacenamiento en bloques compatible con S3(v2.0)

Obtener todas las configuraciones de almacenamiento en bloques S3 (v2.0)

recuperar las configuraciones de todos los almacenamientos en bloques compatibles con S3. El2.0 recurso v devuelve el keyVault objeto para cada almacenamiento en3bloques compatible con S que lee sus credenciales de Amazon Web Services de HashiCorp Vault.

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

Resource

GET /snapshot/s3Configs

Parámetros de ruta de solicitud

Este endpoint no utiliza parámetros de ruta de solicitud HTTP.

Parámetros de Solicitud Query

Nombre
Tipo
Necesidad
Descripción
predeterminado

Num. de pág.

Número

Opcional

Entero basado en uno que devuelve una subsección de resultados.

1

elementosPorPágina

Número

Opcional

Número de elementos a devolver por página, hasta un máximo de 500.

100

bonito

booleano

Opcional

Indicador que señala si el cuerpo de la respuesta debe estar en formato prettyprint.

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 o al código de estado. Para remediarlo, establezca envelope : true en la query.

Para los endpoints que devuelven una lista de resultados, el objeto content es un sobre. Ops Manager agrega el campo status al cuerpo de la respuesta.

false

soloasignable

booleano

Opcional

Indica si se deben devolver solo los almacenamientos de bloques de almacenamiento compatibles con S3a los que se pueden asignar nuevas tareas de copia de seguridad.

true

Parámetros del cuerpo de la solicitud

Este endpoint no utiliza parámetros de cuerpo de solicitud HTTP.

Respuesta

Documento de respuesta

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

Nombre
Tipo
Descripción

results

arreglo

El arreglo incluye un objeto para cada elemento detallado en la sección del results documento incrustado.

links

arreglo

El arreglo incluye uno o más enlaces a subrecursos y/o recursos relacionados. Las relaciones entre URLse explican en la Especificación de enlace web.

totalCount

Número

Recuento entero del número total de elementos en el conjunto de resultados. Puede ser superior al número de objetos en el arreglo results si el conjunto de resultados completo está paginado.

results embeddedDocument

Cada resultado es un bloque de almacenamiento compatible con S3.

Nombre
Tipo
Descripción

Términos aceptados

booleano

Indicador que muestra si aceptaste los términos de servicio para usar almacenamiento compatible con S3con MongoDB Ops Manager. Debe 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 utilizar el HTTP proxy al conectar con un 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.

ID

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

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

oidc

Objeto

Configuración de autenticación OIDC para esta tienda. El objeto oidc contiene los siguientes campos:

  • enabled: booleano. Indica si la autenticación OIDC está habilitada para este almacén.

  • method: string. Uno de callback, azure, gcp o k8s.

  • tokenUri: string. El punto final del token del proveedor de identidad. Presente solo cuando method sea callback.

  • clientId: string. El ID de cliente registrado con el proveedor de identidad.

  • clientSecret: string. MongoDB Ops Manager redacta este valor en la respuesta y no devuelve el secreto de cliente sin procesar.

  • scope: string. El ámbito de OAuth2 solicitado al proveedor de identidad. Solo presente cuando method es callback.

  • tokenResource: string. El público o identificador de recursos para el token de identidad de la carga de trabajo. Presente solo cuando method sea azure o gcp.

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

Fuente de credenciales respaldada por Vault para este almacenamiento de snapshot compatible con S3. MongoDB Ops Manager devuelve este objeto solo cuando el almacenamiento de snapshot lee sus credenciales de un almacén de claves.

keyVault.vaultId

string

Identificador único de la configuración del almacén de claves que almacena las credenciales.

keyVault.awsAccessKeyPath

string

Ruta en el almacén de claves a la clave de acceso de Amazon Web Services.

keyVault.awsSecretKeyPath

string

Ruta en el almacén de claves a la clave secreta de Amazon Web Services.

Solicitud de ejemplo

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
     --header 'Accept: application/json' \
     --include \
     --request GET 'https://<OpsManagerHost>:<Port>/api/public/v2.0/admin/backup/snapshot/s3Configs?pretty=true'

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

{
  "links": [
    {
      "href": "https://<OpsManagerHost>:<Port>/api/public/v2.0/admin/backup/snapshot/s3Configs?pretty=true&pageNum=1&itemsPerPage=100",
      "rel": "self"
    }
  ],
  "results": [
    {
      "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": 50,
      "s3BucketEndpoint": "http://example.com/backupbucket",
      "s3BucketName": "buck1",
      "uri": "mongodb://localhost:27017",
      "ssl": true,
      "writeConcern": "W2"
    }
  ],
  "totalCount": 1
}

Volver

Obtener por ID

Next

Crear

En esta página