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 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 formato prettyprint formato. |
| ||||||
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:
|
|
Parámetros del cuerpo de la solicitud
Este punto final no utiliza parámetros del cuerpo de la solicitud HTTP.
Respuesta
Nombre | Tipo | Descripción | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Términos de servicio aceptados | booleano | Marca que indica si aceptó o no los términos de servicio para usar almacenes compatibles con almacenamiento S3con Ops Manager. Debe establecerlo en | |||||||||
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 | Bandera que indica si el Se debe utilizarun proxy HTTP al conectarse a un 3almacenamiento compatible con S. | |||||||||
encryptedCredentials | booleano | Bandera que indica si el nombre de usuario y la contraseña para este3almacén de bloques de almacenamiento compatible con S se cifraron mediante la herramienta de credenciales. | |||||||||
ID. | string | Nombre que identifica de forma única este almacén de bloques de almacenamiento compatible con S3. | |||||||||
Etiquetas | matriz de cadenas | Matriz de etiquetas para administrar qué trabajos de respaldo puede asignar Ops Manager a qué almacenes de3 bloques S. | |||||||||
enlaces | matriz de objetos | Uno o más enlaces a subrecursos o recursos relacionados. Todas las | |||||||||
factor de carga | entero | Entero positivo distinto de cero que expresa la cantidad de trabajo de copia de seguridad que realiza este almacén de instantáneas en comparación con otro. Esta opción solo es necesaria si se utilizan más de un almacén de instantáneas. Para obtener más información sobre Load Factor,consulte Editar un almacén de bloques existente. | |||||||||
pathStyleAccessEnabled | booleano | Bandera que indica el estilo de este punto final.
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 | Método utilizado para autorizar el acceso al depósito de almacenamiento compatible con S3especificado en Los valores aceptados para esta opción son:
| |||||||||
s3Punto final del depósito | string | URL que Ops Manager utiliza para acceder a este 33depósito de almacenamiento compatible con AWS S o S. | |||||||||
s3Nombre del depósito | string | Nombre del depósito de almacenamiento compatible con S3que aloja el almacén de bloques de almacenamiento compatible con S3. | |||||||||
s3MaxConnections | entero | Entero positivo que indica el número máximo de conexiones a este almacén de bloques 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 compatible con S no admite el alcance regional. Ops Manager devuelve este campo solo si lo incluyó cuando creó o actualizó este3almacén de bloques de almacenamiento compatible con S. | |||||||||
sseHabilitado | booleano | Bandera que indica si este3almacén de bloques de almacenamiento compatible con S habilita el cifrado del lado del servidor. | |||||||||
ssl | booleano | Bandera que indica si este3almacén de bloques 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 de este almacén3de bloques de almacenamiento compatible con S. Esta base de datos almacena las ubicaciones de los bloques en el 3depósito de almacenamiento compatible con AWS S. | |||||||||
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 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' \ --include \ --request GET 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/s3Configs/{S3-BLOCKSTORE-CONFIG-ID}?pretty=true'
Ejemplo de respuesta
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}
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/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" }