Configura un nuevo almacenamiento en bloques.
URL base: https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup
Resource
POST /snapshot/mongoConfigs
Parámetros de la ruta de solicitud
Este punto final no utiliza parámetros de ruta de solicitud HTTP.
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
Nombre | Tipo | Descripción |
|---|---|---|
asignación habilitada | booleano | |
encryptedCredentials | booleano | Opcional. Indicador que indica si el nombre de usuario y la contraseña para este almacén de bloques se cifraron mediante el herramienta de credenciales. |
ID. | string | El nombre único que etiqueta esta tienda de bloques. |
Etiquetas | matriz de cadenas | Opcional. Matriz de etiquetas para administrar qué trabajos de respaldo puede asignar Ops Manager a qué almacenes 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 la cantidad de trabajo de copia de seguridad que este almacén de instantáneas debe realizar 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. |
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. Bandera que indica si este almacén de bloques solo acepta conexiones cifradas mediante TLS. |
writeConcern | string | Opcional. La preocupación de escritura utilizada para este almacén de bloques. Los valores aceptados para esta opción son:
Para obtener más información sobre los niveles de reconocimiento de escritura en MongoDB, consulte Preocupación de escritura. |
Respuesta
Nombre | Tipo | Descripción |
|---|---|---|
asignación habilitada | booleano | |
encryptedCredentials | booleano | Bandera que indica si el nombre de usuario y la contraseña para este almacén de bloques se cifraron utilizando la herramienta de credenciales. |
ID. | string | El nombre único que etiqueta esta tienda de bloques. |
Etiquetas | matriz de cadenas | Arreglo de etiquetas para gestionar qué tareas de copia de seguridad Ops Manager puede asignar a qué blockstores. |
enlaces | matriz de objetos | Uno o más enlaces a subrecursos o recursos relacionados. Todas las |
factor de carga | Número | Un entero positivo distinto de cero que expresa la cantidad de trabajo de copia de seguridad que este almacén de instantáneas debe realizar 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 Load Factor sobre, consulte Editar un almacén de 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 | Bandera que indica si este almacén de bloques solo acepta conexiones cifradas mediante TLS. |
tamaño usado | Número | La cantidad de capacidad de respaldo en MB que consumen las copias de seguridad existentes. |
writeConcern | string | La preocupación de escritura utilizada para este almacén de bloques. Los valores aceptados para esta opción son:
Para obtener más información sobre los niveles de reconocimiento de escritura en MongoDB, consulte Preocupación de escritura. |
Ejemplo de solicitud
1 curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \ 2 --header 'Accept: application/json' \ 3 --header 'Content-Type: application/json' \ 4 --include \ 5 --request POST 'https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs?pretty=true' \ 6 --data '{ 7 "assignmentEnabled" : true, 8 "encryptedCredentials" : false, 9 "id" : "{BLOCKSTORE-CONFIG-ID}", 10 "labels" : [ "l1", "l2" ], 11 "loadFactor" : 2, 12 "maxCapacityGB" : 8, 13 "uri" : "mongodb://localhost:27017", 14 "ssl" : true, 15 "writeConcern" : "W2" 16 }'
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
1 { 2 "assignmentEnabled" : true, 3 "encryptedCredentials" : false, 4 "id" : "{BLOCKSTORE-CONFIG-ID}", 5 "labels" : [ "l1", "l2" ], 6 "links" : [ { 7 "href" : "https://{OPSMANAGER-HOST}:{PORT}/api/public/v1.0/admin/backup/snapshot/mongoConfigs", 8 "rel" : "self" 9 }], 10 "loadFactor" : 2, 11 "maxCapacityGB" : 8, 12 "uri" : "mongodb://localhost:27017", 13 "ssl" : true, 14 "usedSize" : 222, 15 "writeConcern" : "W2" 16 }