Obtener una configuración de almacenamiento en bloques S3 por ID

Recupera la configuración de un S3 almacenamiento en bloques.

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

Resource

GET /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 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 especifica si el cuerpo de la respuesta está en formato legible.	`false`
envelope	booleano	Opcional	Bandera que indica si se debe o no envolver la respuesta en un sobre. Algunos clientes de API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, establezca envelope=true en la consulta. 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

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

Respuesta

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 deAWS que puede acceder al bucket de almacenamiento compatible con S3 especificado en s3BucketName.
awsSecretKey	string	Clave de acceso secreta deAWS que puede acceder al bucket 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	Conjunto de etiquetas para gestionar qué trabajos de copia de seguridad puede asignar Ops Manager a qué almacenes de bloques 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 URLse explican en la Especificación de enlaces 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ónde autenticación OIDC para este almacén. 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`: cadena. El punto final del token IdP. Presente solo cuando `method` es `callback`. `clientId`: cadena. El ID de cliente registrado con el IdP. `clientSecret`: string. MongoDB Ops Manager redacta este valor en la respuesta y no devuelve el secreto de cliente sin procesar. `scope`: cadena. El ámbito OAuth2 solicitado al IdP. Presente solo 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. `true`: Punto final de URL con formato de ruta. Ejemplo: `s3.amazonaws.com/<bucket>` `false`: Punto final URL de estilo host virtual. Ejemplo: `<bucket>.s3.amazonaws.com` Para revisar las convenciones de URL de los buckets de almacenamiento compatibles 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 cubo de almacenamiento compatible con S3especificado en `s3BucketName`. `IAM_ROLE`Ops Manager utiliza un rol de AWS IAM para autorizar el acceso al bucket de almacenamiento compatible con S3 especificado en `s3BucketName`. Los campos `awsAccessKey` y `awsSecretKey` se ignoran. Para obtener más información, consulte la documentación de AWS.
s3BucketEndpoint	string	URL que utiliza Ops Manager para acceder a este depósito 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 especifica si este almacén de bloques de almacenamiento compatible con S3 solo acepta conexiones cifradas mediante TLS.
uri	string	Cadena de conexión que se conecta a la base de datos de metadatos para este almacén de bloques de almacenamiento compatible con S3. Esta base de datos almacena las ubicaciones de los bloques en el bucket de almacenamiento compatible con AWS 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).

Solicitud de ejemplo

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/{S3-BLOCKSTORE-CONFIG-ID}?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

{
  "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-CONFIG-ID}",
      "rel": "self"
    }
  ],
  "loadFactor": 50,
  "s3BucketEndpoint": "http://example.com/backupbucket",
  "s3BucketName": "buck1",
  "uri": "mongodb://localhost:27017",
  "ssl": true,
  "writeConcern": "W2"
}

Volver

Almacenamiento en bloques compatible con S3

Obtener todo