Actualiza la configuración de un almacenamiento en bloques.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
PUT /snapshot/mongoConfigs/{BLOCKSTORE-ID}
Parámetros de la ruta de solicitud
Nombre | Tipo | Descripción |
|---|---|---|
BLOCKSTORE-ID | string | El nombre único que etiqueta esta configuración de almacenamiento en bloques. |
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
Nombre | Tipo | Descripción |
|---|---|---|
asignación habilitada | booleano | opcional. Indicador de si a este almacenamiento en bloques se le pueden asignar tareas de copia de seguridad. |
encryptedCredentials | booleano | opcional. Bandera que indica si el nombre de usuario y la contraseña para este almacenamiento en bloques fueron cifrados usando el herramienta de credenciales. |
etiquetas | Arreglo de cadenas | opcional. Arreglo de etiquetas para gestionar a qué tareas de copia de seguridad puede asignar Ops Manager a cuál almacén de bloques. Configurar estas etiquetas limita los trabajos de copia de seguridad que este almacén de bloques puede procesar. Si se omite, este almacén de bloques solo puede procesar trabajos de copia de seguridad de proyectos que no usan etiquetas para filtrar sus trabajos. |
factor de carga | Número | opcional. Un entero positivo distinto de cero que expresa cuánto trabajo de copia de seguridad debe realizar este almacenamiento de snapshot en comparación con otro almacenamiento de snapshot. 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. |
maxCapacityGB | Número | Opcional. Capacidad máxima disponible prevista del almacén de bloques para su uso en la alerta OUTSIDE_SPACE_USED_THRESHOLD. |
uri | string | Una lista separada por comas de hosts en el |
ssl | booleano | opcional. Indicador que muestra si este almacenamiento en bloques sólo acepta conexiones cifradas mediante TLS. |
writeConcern | string | opcional. El nivel de confirmación de escritura (write concern) utilizado para este almacenamiento en bloques. Los valores aceptados para esta opción son:
Para obtener información sobre los niveles de reconocimiento de escritura en MongoDB, consulta nivel de confirmación de escritura (write concern). |
Respuesta
Nombre | Tipo | Descripción |
|---|---|---|
asignación habilitada | booleano | Indicador que señala si este almacenamiento en bloques puede asignarse a tareas de copia de seguridad. |
encryptedCredentials | booleano | Indicador que señala si el nombre de usuario y la contraseña de este almacenamiento en bloques se cifraron mediante la credentialstool. |
ID | string | El nombre único que identifica este almacenamiento en bloques. |
etiquetas | Arreglo de cadenas | Arreglo de etiquetas para gestionar qué tareas de copia de seguridad Ops Manager puede asignar a qué blockstores. |
enlaces | objeto arreglo | Uno o más enlaces a subrecursos o recursos relacionados. Todas las |
factor de carga | Número | Un entero positivo y diferente de cero que expresa cuánto trabajo de copia de seguridad debe realizar este almacenamiento de snapshot en comparación con otro almacenamiento de snapshot. 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. |
maxCapacityGB | Número | Opcional. Capacidad máxima disponible prevista del almacén de bloques para su uso en la alerta OUTSIDE_SPACE_USED_THRESHOLD. |
uri | string | Una lista separada por comas de hosts en el |
ssl | booleano | Indicador de si este almacenamiento en bloques sólo acepta conexiones cifradas utilizando TLS. |
usedSize | Número | La cantidad de capacidad de copia de seguridad en MB que consumen las copias de seguridad existentes. |
writeConcern | string | El nivel de confirmación de escritura (write concern) utilizado para este almacenamiento en bloques. Los valores aceptados para esta opción son:
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' \ --header 'Content-Type: application/json' \ --include \ --request PUT 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs/{BLOCKSTORE-ID}?pretty=true' \ --data '{ "assignmentEnabled" : true, "encryptedCredentials" : false, "labels" : [ "l1", "l2" ], "loadFactor" : 2, "maxCapacityGB" : 8, "uri" : "mongodb://localhost:27017", "ssl" : true, "writeConcern" : "W2" }'
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, "encryptedCredentials" : false, "id" : "{BLOCKSTORE-CONFIG-ID}", "labels" : [ "l1", "l2" ], "links" : [ { "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs/{BLOCKSTORE-ID}", "rel" : "self" }], "loadFactor" : 2, "maxCapacityGB" : 8, "uri" : "mongodb://localhost:27017", "ssl" : true, "usedSize" : 222, "writeConcern" : "W2" }