Obtener lista de repositorios de backups

Versión del producto: 10.11

Último modificado: 2 de octubre de 2024

Obtiene la lista de repositorios de backups.

Punto final

https://<Director_IP_address>:4443/c/router

Punto final inquilino

Para los inquilinos del producto multi-tenant el punto final debe ser:

https://<Dirección_IP_director>:4443/t/<tenant_UUID>/c/router

Ejemplo de solicitud

rizo

Copiar

curl --request POST \
    --url https://<Director_IP_address>:4443/c/router \
    --header "content-type: application/json" \
    --cookie @cookies.txt \
    --data '{
        "action": "BackupManagement",
        "method": "getBackupRepositories",
        "data": [{"filter": {
                          "start": 0,
                          "count": 60,
                          "sort": "NAME",
                          "sortAsc": true,
                          "criteria": [{
                                      "type": "AND",
                                      "criteria": [{
                                                  "type": "EQ",
                                                  "name": "NAME",
                                                  "value": "aaaa"}]
                                      }]
                            }
                }],
        "type": "rpc",
        "tid": 1}'

Campos de solicitud

Campo	Tipo	Valor(es)
`action`	string	`BackupManagement`
`method`	string	`getBackupRepositories`
`data`	Json	Filtrar parámetros. Consulte la siguiente tabla `filter`
`type`	string	`rpc`
`tid`	int	`1`

Filtrar

Campo	Valor	Descripción
`start`	int	ID de inicio del repositorio de backups que se devolverá.
`count`	int	Número de repositorios de backups a devolver
`sort`	string	Repositorio de backups parámetro a ordenar con
`sortAsc`	boolean	`true` si el orden es ascendente
`criteria`	array	Filtrar criterios. Véanse las filas siguientes
`type`	string	Tipo de criterio
`name`	string	Nombre del criterio. `NAME` significa el nombre del repositorio de backups
`type`	string	Tipo de criterio. `EQ` significa el operador relacional de igualdad
`value`	string	Valor del criterio

Muestra de respuesta

rizo

Copiar

 {
  "action": "BackupManagement",
  "method": "getBackupRepositories",
  "tid": "1",
  "type": "rpc",
  "message": null,
  "where": null,
  "cause": null,
  "data": {
    "children": [
      {
        "id": 2,
        "state": "OK",
        "status": "NONE",
        "changeStatus": "NONE",
        "type": "LOCAL",
        "name": "Onboard repository",
        "isAccessible": true,
        "licensed": true,
        "transporterLockedExclusive": true,
        "location": "LOCAL",
        "transporterLockedReasons": [null],
        "description": "This is the built-in backup repository of NAKIVO Backup & Replication. It is located on the same machine where the main part of the product resides.",
        "size": 13128503296,
        "free": 10393382912,
        "allocated": 0,
        "consumed": 0,
        "attached": true,
        "consistent": true,
        "path": "/opt/nakivo/repository",
        "transporterId": 1,
        "transporterName": "Onboard transporter",
        "transporterCaps": {
          "WINDOWS_GUESTS_RECOVERY_SUPPORT": true,
          "CIFS_SHARE_SUPPORT": true,
          "LINUX_GUESTS_RECOVERY_SUPPORT": true,
          "VMWARE_VSPHERE_SUPPORT": true,
          "REPOSITORY_MANAGEMENT_SUPPORT": true,
          "AWS_EC2_SUPPORT ": false,
          "NUTANIX_SUPPORT ": false,
          "FLASH_VM_BOOT_SUPPORT ": true,
          "NFS_SHARE_SUPPORT": true,
          "MS_HYPERV_SUPPORT": false,
          "REPOSITORY_ENCRYPTION_SUPPORT": true
        },
        "username": null,
        "password": null,
        "storageSize": null,
        "chunkSize": null,
        "autoSize": null,
        "volumeType": null,
        "backupCount": 0,
        "hvTypeBackupCount": {},
        "hvTypeBackupHasRootDiskCount": {},
        "compression": "FAST",
        "compressionRatio": 0,
        "deduplication": true,
        "deduplicationRatio": 0,
        "selfHeal": true,
        "encryption": false,
        "encryptionPassword": null,
        "lockedShared": false,
        "lockedExclusive": false,
        "lockReasons": [],
        "preventModification": false,
        "wasEdited": false,
        "wasDiscoveredOnce": true,
        "wasImported": false,
        "wasCreated": false,
        "useSelfHealSchedule": false,
        "selfHealSchedule": null,
        "selfHealOverrideJobs": false,
        "useVerificationSchedule": false,
        "verificationSchedule": null,
        "verificationOverrideJobs": false,
        "useConsolidationSchedule": false,
        "consolidationSchedule": null,
        "consolidationOverrideJobs": false,
        "useDetachSchedule": false,
        "detachSchedule": null,
        "attachSchedule": null,
        "deleteAndRecreateOnAttach": false,
        "progress": 0,
        "operationStart": null,
        "operationStartRelative": 0,
        "alertErrorCode": null,
        "alertTitle": null,
        "alertDescription": null
      },
      {
        "id": 3,
        "state": "OK",
        "status": "NONE",
        "changeStatus": "NONE",
        "type": "SHARE",
        "name": "Repo",
        "isAccessible": true,
        "licensed": true,
        "transporterLockedExclusive": true,
        "location": "LOCAL",
        "transporterLockedReasons": [null],
        "description": "",
        "size": 8999835533312,
        "free": 2891503828992,
        "allocated": 331554388515,
        "consumed": 321726173238,
        "attached": true,
        "consistent": true,
        "path": "\\\\server\\share",
        "transporterId": 1,
        "transporterName": "Onboard transporter",
        "transporterCaps": {
          "WINDOWS_GUESTS_RECOVERY_SUPPORT": true,
          "CIFS_SHARE_SUPPORT": true,
          "LINUX_GUESTS_RECOVERY_SUPPORT": true,
          "VMWARE_VSPHERE_SUPPORT": true,
          "NUTANIX_SUPPORT": true
          "REPOSITORY_MANAGEMENT_SUPPORT ": true,
          "AWS_EC2_SUPPORT": false,
          "FLASH_VM_BOOT_SUPPORT": true,
          "NFS_SHARE_SUPPORT": true,
          "MS_HYPERV_SUPPORT": false,
          "REPOSITORY_ENCRYPTION_SUPPORT": true
        },
        "username": "DOMAIN\\username",
        "password": "$FAKE_PASSWORD$",
        "storageSize": 500,
        "chunkSize": 500,
        "autoSize": true,
        "volumeType": "sc1",
        "backupCount": 18,
        "hvTypeBackupCount": {
          "VMWARE": 11,
          "HYPERV": 7
        },
        "hvTypeBackupHasRootDiskCount": {},
        "compression": "FAST",
        "compressionRatio": 5900,
        "deduplication": true,
        "deduplicationRatio": 1100,
        "selfHeal": true,
        "encryption": false,
        "encryptionPassword": null,
        "lockedShared": false,
        "lockedExclusive": false,
        "lockReasons": [],
        "preventModification": false,
        "wasEdited": false,
        "wasDiscoveredOnce": true,
        "wasImported": false,
        "wasCreated": false,
        "useSelfHealSchedule": false,
        "selfHealSchedule": null,
        "selfHealOverrideJobs": false,
        "useVerificationSchedule": false,
        "verificationSchedule": null,
        "verificationOverrideJobs": false,
        "useConsolidationSchedule": false,
        "consolidationSchedule": null,
        "consolidationOverrideJobs": false,
        "useDetachSchedule": false,
        "detachSchedule": null,
        "attachSchedule": null,
        "deleteAndRecreateOnAttach": false,
        "progress": 0,
        "operationStart": null,
        "operationStartRelative": 0,
        "alertErrorCode": null,
        "alertTitle": null,
        "alertDescription": null
      }
    ],
    "totalCount": 2
  }
}

Campos de respuesta

Campo	Valor	Descripción
`message`	string	Mensaje si la solicitud ha fallado
`where`	string	Referencia al método en el que se ha producido el problema
`cause`	string	Causa del fallo
data	Json	Información sobre repositorios

Datos.hijos

Información de un único repositorio.

Campo	Valor	Descripción
id	largo	ID del repositorio de backups
`state`	string	Estado del repositorio de backups
`status`	string	El estado de la operación actual en el repositorio de backups. `NONE` si no se está ejecutando ninguna operación. Valores posibles:`NONE, UPDATING, SELF_HEALING, SPACE_RECLAIM, VERIFY_BACKUPS, STOPPING_SELF_HEALING, STOPPING_SPACE_RECLAIM, STOPPING_VERIFY_BACKUPS`
`changeStatus`	string	`NONE` `CREATE_PENDING` Elemento nuevo, es necesaria la detección `CHANGE_PENDING` Algunos atributos han cambiado, es necesaria la detección `IMPORT_PENDING` Elemento importado `RECREATE_PENDING` El elemento se ha destruido y es necesario volver a crearlo.
`type`	string	Tipo de repositorio de backups. Valores posibles: `FOREVER_INCREMENTAL, INCREMENTAL_WITH_FULL_BACKUPS`
`name`	string	Nombre para mostrar
`isAccessible`	boolean	`true` si se puede acceder al repositorio de backups
`licensed`	boolean	`true` si el repositorio de backups tiene licencia
`transporterLockedExclusive`	boolean	`true` si el transportador está bloqueado exclusivamente
`advancedMountOptions`	string	Opciones avanzadas de montaje del repositorio de backups cuando el campo ubicación es cualquiera de los siguientes: `NFS_SHARE, CIFS_SHARE`. Este campo es opcional
`location`	string	Tipo de ubicación del repositorio de backups. Valores posibles: `CIFS_SHARE, LOCAL, NFS_SHARE, AMAZON_EBS`
`transporterLockedReasons`	array	Motivo(s) de bloqueo del transportador
`description`	string	Descripción (si existe)
`size`	largo	Tamaño total del repositorio de backups en bytes
`free`	largo	Espacio libre en bytes
`allocated`	largo	Tamaño de los archivos del repositorio de backups en el sistema de archivos
`consumed`	largo	Tamaño real de los datos del usuario en los archivos del repositorio de backups.
`attached`	boolean	Comprueba si el repositorio de backups está adjunto.
`consistent`	boolean	Comprueba si el repositorio de backups es coherente.
`path`	string	Una ruta al repositorio de backups
`transporterId`	largo	ID del transportador asignado
`transporterName`	string	Nombre del transportador asignado
`transporterCaps`	Json	Capacidades del transportador asignado. Véase más abajo.
`username`	string	Nombre de usuario para acceder al fileshare donde se encuentra el repositorio de backups.
`password`	string	Contraseña para acceder al fileshare donde se encuentra el repositorio de backups.
`storageSize`	largo	Específico de AWS: tamaño del almacenamiento asignado
`chunkSize`	largo	Específico de AWS: tamaño del fragmento de descarga
`autoSize`	boolean	Específico de AWS: `true` si el tamaño de almacenamiento se ajusta automáticamente.
`volumeType`	string	Específico de AWS: el tipo de volumen de almacenamiento.
`backupCount`	largo	El número total de backups
`hvTypeBackupCount`	Json	Número de backups por tipo de plataforma
`hvTypeBackupHasRootDiskCount`	Json	Específico de AWS: recuento de backups cuyos puntos de retorno tienen un volumen Raíz
`compression`	string	Tipo de compresión
`compressionRatio`	int	Relación de compresión
`deduplication`	boolean	Comprueba si la deduplicación está activada.
`deduplicationRatio`	int	Ratio de deduplicación
`selfHeal`	boolean	Comprueba si el autohealing del repositorio de backups está activado.
`encryption`	boolean	Comprueba si el cifrado está activado para el repositorio de backups.
`encryptionPassword`	string	Contraseña de cifrado
`lockedShared`	boolean	`true` si no se pueden ejecutar varias operaciones de lectura en el mismo repositorio de backups al mismo tiempo.
`lockedExclusive`	boolean	`true` si no se pueden realizar varias actualizaciones en el repositorio al mismo tiempo`.`
`lockReasons`	array	Motivos de bloqueo
`preventModification`	boolean	Si `true,` impide la modificación manual del elemento
`wasEdited`	boolean	Comprueba si se ha editado el repositorio de backups.
`wasDiscoveredOnce`	boolean	Comprueba si el repositorio de backups fue detectado una vez.
`importIsPending`	boolean	`true` si `changeStatus` es `IMPORT_PENDING`
`createIsPending`	boolean	`true` si `changeStatus` es `CREATE_PENDING` o `RECREATE_PENDING`
`useSelfHealSchedule`	boolean	Comprueba si la programación de autocuración está activada.
`selfHealSchedule`	Json	Programación de autocuración. Consulte la tabla de datos de Programación más abajo. Ejemplo de datos programados: `%s` %s%18%lkjlkj% %s%18d `fsdf%1881%lkjlkj%` `dayOfWeek: null` `effectiveDate: null` `enabled: true` `endTime: null` `every: null` `everyType: null` `month: null` `monthlyEveryType: null` `xml-ph-0034@deepl.interna` `%lkjlkj%` `%s` %s%19%lkjlkj% %s%19%lkjlkj%d `fsdf%1892%lkjlkj%` `position: null` `startTime: "11:00:00 AM"` `timezone: "Asia/Bangkok"` `timezoneOffsetMs: 25200000` `triggerEvents: null` `triggerItem: null` `triggerItemName: null` `triggerItemTypeName: null` `xml-ph-0034@deepl.interna`
`selfHealOverrideJobs`	boolean	`true` si la autocuración puede anular los jobs actuales
`useVerificationSchedule`	boolean	Comprueba si la programación de verificación está activada.
`verificationSchedule`	Json	Programación de la verificación. Consulte `selfHealSchedule` más arriba para ver un ejemplo de datos programados.
`verificationOverrideJobs`	boolean	`true` si la verificación puede anular los jobs actuales
`useConsolidationSchedule`	boolean	Comprueba si está activado el programa de recuperación de espacio.
`consolidationSchedule`	Json	Programación de recuperación de espacios. Consulte `selfHealSchedule` más arriba para ver un ejemplo de datos programados.
`consolidationOverrideJobs`	boolean	`true` si la recuperación de espacio puede anular los jobs actuales
`useDetachSchedule`	boolean	Comprueba si la programación de desconectar está activada.
`detachSchedule`	Json	Programación de desconectados. Consulte `selfHealSchedule` más arriba para ver un ejemplo de datos programados.
`attachSchedule`	Json	Programación adjunta. Consulte `selfHealSchedule` más arriba para ver un ejemplo de datos programados.
`deleteAndRecreateOnAttach`	boolean	`true` si el repositorio de backups debe ser recreado durante el proceso programado de desconectar-adjuntar.
`progress`	int	El progreso de la operación actual
`operationStart`	string	Marca de tiempo del inicio de la operación actual
`operationStartRelative`	largo	Marca de tiempo relativa (por ejemplo, hora desde el inicio) del comienzo de la operación actual
`alertErrorCode`	largo	El código de error de la alerta (si existe)
`alertTitle`	string	El título de la alerta (si existe)
`alertDescription`	string	La descripción de la alerta (si existe)

Programación

Campo	Tipo	Descripción	Valores posibles o formato
`enabled`	boolean	Si se ha activado una Programación, entonces `%s` `dfsdf` `%1833%lkjlkj%`, `false` en caso contrario
`type`	string	El tipo de programación de backups	`DAILY,` `MONTHLY_YEARLY,` `PERIODICALLY,` `TRIGGER,` `NONE`
`position`	int	Prioridad de la Programación
`startTime`	string	Hora de comienzo	`hh:mm:ss AM/PM`
`endTime`	string	Terminar a las horas. `null` si no está configurado
`timezone`	string	Zona horaria
`on`	int	Representación decimal de una máscara de bits para un día de la semana. El bit más bajo es el lunes, el⁷ es el domingo. Por ejemplo, si necesita ejecutar un job en días laborables, la máscara de bits será `00011111` que es `31` en decimal	`1-127`
`everyType`	string	Si `type` es `PERIODICALLY``or``TRIGGERED`, define la unidad de retardo entre jobs. Por ejemplo, "Ejecutar job cada 30 minutos".	`DAY` (sólo para `PERIODICALLY`), `MINUTE,` `HOUR,` `SECOND`
`every`	int	El número de unidades de retraso entre ejecuciones del job. Por ejemplo, "Ejecutar job cada 30 minutos".
`monthlyEveryType`	string	Si `type` es `MONTHLY_YEARLY`, selecciona el número de día de la semana en un mes o un número de día	`FIRST,` `SECOND,` `THIRD,` CUARTO, `LAST,` `DAY`
`dayOfMonth`	int	Si `%s` `dfsdf` `%1943%lkjlkj%` es `DAY`, selecciona el número de día de un mes.
`dayOfWeek`	int	Si `monthlyEveryType` es de `LAST`, selecciona el número de un día de la semana
`month`	int	Si `type` es `MONTHLY_YEARLY`, el número del mes en el que debe ejecutarse un job.
`triggerItem`	string	VID del job que activa el actual
`triggerRunType`	string	Selecciona si se ejecuta el job inmediatamente después del anterior o con un retraso. Si `DELAYED`se selecciona, el retraso viene definido por los campos `everyType` y `every`	`IMMEDIATELY,` `DELAYED`
`triggerEvents`	array	Activar condiciones de job	`RUN_SUCCESS,` `RUN_FAILURE,` `RUN_STOP`
`nextRun`	string	Hora y fecha del siguiente job ejecutado	`YYYY-MM-DDTHH:MM:SS.SSSZ`
`effectiveDate`	string	Fecha a partir de la cual se activa la Programación. Puede ser `null`, por lo que la Programación es activa desde ahora.
`triggerItemName`	string	Nombre del elemento activado
`triggerItemTypeName`	string	Nombre del tipo de elemento activado
`timezoneOffsetMs`	int	Configurado por el servidor. El desfase horario especificado con respecto a la hora del servidor.
`nextRunRelative`	largo	Hora relativa en ms en la que se ejecutará el job la próxima vez.

transporterCaps

Capacidades del transportador

Campo	Valor	Descripción
`WINDOWS_GUESTS_RECOVERY_SUPPORT`	boolean	Comprueba si el transportador es compatible con la recuperación del sistema operativo invitado Windows.
`CIFS_SHARE_SUPPORT`	boolean	Comprueba si el transportador es compatible con recursos compartidos CIFS.
`LINUX_GUESTS_RECOVERY_SUPPORT`	boolean	Comprueba si el transportador es compatible con la recuperación del sistema operativo invitado Linux.
`VMWARE_VSPHERE_SUPPORT`	boolean	Comprueba si el transportador es compatible con VMware vSphere.
`NUTANIX_SUPPORT`	boolean	Comprueba si el transportador es compatible con Nutanix AHV.
`REPOSITORY_MANAGEMENT_SUPPORT`	boolean	Comprueba si el transportador es compatible con la gestión de repositorios de backups.
`AWS_EC2_SUPPORT`	boolean	Comprueba si el transportador es compatible con las Instancias de EC2 de AWS.
`FLASH_VM_BOOT_SUPPORT`	boolean	Comprueba si el transportador es compatible con el inicio rápido de máquinas virtuales en Flash.
`NFS_SHARE_SUPPORT`	boolean	Comprueba si el transportador admite recursos compartidos.
`MS_HYPERV_SUPPORT`	boolean	Comprueba si el transportador es compatible con Microsoft Hyper-V.
`REPOSITORY_ENCRYPTION_SUPPORT`	boolean	Comprueba si el transportador es compatible con el cifrado de los repositorios de backups.
`VMWARE_VSPHERE_PRE55_SUPPORT`	boolean	Comprueba si el transportador es compatible con versiones de VMware vSphere anteriores a la 5.5.