{"type":"api","title":"Get Backup Status","meta":{"id":"/apps/pubhub/media/nfvis-api/e3678dda6abe6c2a26c7698d553a4574e3f45071/262737b2-b3c2-32cd-b07b-fdbdcd23918f","info":{"title":"NFVIS API","description":"NFVIS RESTCONF API Documentation","version":"4.14.1"},"x-parser-conf":{"overview":{"markdownPath":"reference/overview.md"}},"swagger":"2.0","basePath":"/{nfvis_ip}/restconf","schemes":["https"],"securityDefinitions":{"basicAuth":{"type":"basic"}}},"spec":{"tags":["Host Action Configuration"],"summary":"Get Backup Status","description":"Get the status of system backup including NFVIS configuration and each VM","operationId":"data_hostaction_hostaction_backup_status_get","produces":["application/yang-data+json"],"parameters":[{"name":"content","in":"query","description":"controlling descendant nodes in response","required":false,"type":"string","format":"enumeration","default":"config","enum":["config","nonconfig","all"],"$$ref":"#/parameters/content"}],"responses":{"200":{"description":"This list indicates the status of system backup including NFVIS configuration and each VM","schema":{"type":"object","properties":{"hostaction:status":{"type":"array","description":"This list indicates the status of system backup including NFVIS configuration and each VM (list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"start-time":{"description":"System time when backup is initiated (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"destination":{"description":"Destination of the backup package (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"status":{"description":"Status of backup process (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"SHUTDOWN-INIT","enum":["SHUTDOWN-INIT","SHUTDOWN-IN-PROGRESS","SHUTDOWN-ERROR","BACKUP-INIT","BACKUP-IN-PROGRESS","BACKUP-ERROR","BACKUP-SUCCESS","BACKUP-COMPLETED-PARTIALLY","BACKUP-FORCE-STOPPED","BACKUP-FORCE-STOP-FAILED"]},"size":{"description":"Total size of backup package (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"components":{"type":"array","description":"This list indicates the status of system backup including NFVIS configuration and each VM (list)","x-yang":{"type":"list"},"items":{"type":"object","properties":{"component":{"description":"Indicates the name of the backup task (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"status":{"description":"Indicates status of the task in process (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"enumeration","default":"SHUTDOWN-INIT","enum":["SHUTDOWN-INIT","SHUTDOWN-IN-PROGRESS","SHUTDOWN-ERROR","BACKUP-INIT","BACKUP-IN-PROGRESS","BACKUP-ERROR","BACKUP-SUCCESS","BACKUP-COMPLETED-PARTIALLY","BACKUP-FORCE-STOPPED","BACKUP-FORCE-STOP-FAILED"]},"last-update":{"description":"Indicates the time of the last update made to the task (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"restartvm":{"description":"This field is used for internal purpose.\nIt tracks if the VM has to be started by NFVIS after backing up (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"boolean"},"size":{"description":"Indicates size of backup file (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"},"details":{"description":"Shows more details related to status of the task (leaf)","x-yang":{"type":"leaf"},"type":"string","format":"string"}}}}}}}},"$$ref":"#/definitions/data_hostaction_hostaction_backup_status"}},"204":{"description":"No Content","$$ref":"#/responses/204"},"400":{"description":"Bad Request","$$ref":"#/responses/400"},"401":{"description":"Unauthorized","$$ref":"#/responses/401"},"404":{"description":"Not Found","$$ref":"#/responses/404"},"405":{"description":"Method Not Allowed","$$ref":"#/responses/405"},"409":{"description":"Conflict","$$ref":"#/responses/409"}},"security":[{"basicAuth":[]}],"__originalOperationId":"data_hostaction_hostaction_backup_status_get","consumes":["application/yang-data+json"],"method":"get","path":"/data/hostaction:hostaction/backup/status"}}