Recupera la configuración de un almacén de bloques s3.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
GET /snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}
Parámetros de la ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
S3-BLOCKSTORE-CONFIG-ID | string | El nombre único que etiqueta esta configuración de almacén de 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 señala si el cuerpo de la respuesta debe estar en un pretty-print formato. |
| ||||||
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:
|
|
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 indica si aceptaste o no los términos de servicio para utilizar almacenamiento compatible con S3 con Ops Manager. Debes establecerlo en | |||||||||
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 muestra si la Se debe usar HTTP proxy al conectarse a 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 | Matriz de etiquetas para administrar qué trabajos de respaldo puede asignar Ops Manager a qué almacenes de3 bloques S. | |||||||||
enlaces | objeto arreglo | Uno o más enlaces a subrecursos o recursos relacionados. Todas las | |||||||||
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, consulta Editar un almacenamiento en bloques existente. | |||||||||
objectLockEnabled | booleano | Bandera que indica si el bloqueo de objetos está habilitado para evitar que se eliminen los objetos en un depósito S3. | |||||||||
pathStyleAccessEnabled | booleano | Bandera que indica el estilo de este endpoint.
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 Los valores aceptados para esta opción son:
| |||||||||
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 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 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én de bloques de almacenamiento compatible con S3. | |||||||||
sseEnabled | booleano | Bandera que indica si este3almacén de bloques de almacenamiento compatible con S habilita el 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:
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
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
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" }