{"openapi":"3.0.0","info":{"version":"3.0","title":"Enterprise Workloads GovCloud"},"x-explorer-enabled":true,"paths":{"/audittrail/v1/orgs/{OrgID}/reports/list":{"get":{"description":"Returns audit trail based on the specified filters.","tags":["Audit Trail"],"summary":"List audit trails","operationId":"ListAuditTrailRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"ResourceType","description":"Filter audit trails for specific resource type. For example, Files, MS-SQL, CloudCache, VMware, and so on. Specify multiple resource type values by separating them with commas.","name":"resourceType","in":"query","schema":{"type":"string","enum":["Configuration","Storage Config","CloudCache","File Server","MS-SQL","VMWare","Disaster Recovery","Device Config","NAS","Hyper-V","Billing","Snowball Edge","Oracle"]}},{"x-go-name":"EntityType","description":"Filter audit trails for specific entity type. Specify multiple entity type values by separating them with commas.","name":"entityType","in":"query","schema":{"type":"string","enum":["Content Rule","Backup Policy","Backup Set","Admin Group","Admin","Cloud Cache","Seeding","Snowball Edge","DR Proxy","DR Plan","AWS Account","Admin Alert","Admin Report","Non Admin Alert","Non Admin Report","Server","VMWare VM","Backup Proxy","Backup Proxy Pool","VM Auto Config Rule","vCenter ESXi","NAS Device","NAS Proxy","NAS Share","HyperV VM","HyperV Host","HyperV FLR Proxy","Billing Cost Code","Billing Global Cost Allocation Rate","Password Setting","Oraganization","SSO Setting","SQL Availability Group","Backup Store","All Organizations Admin Report","All Organizations Non Admin Report","Geo Fencing"]}},{"x-go-name":"EntityName","description":"Filter audit trails for specific entity name. Specify multiple entity name values by separating them with commas.","name":"entityName","in":"query","schema":{"type":"string"}},{"x-go-name":"Action","description":"Filter audit trails for specific entity name on which the administrator has performed the action. Specify multiple entity name values by separating them with commas.","name":"action","in":"query","schema":{"type":"string","enum":["Update","Create","Delete","Backup Now","Restore","Restore to Original","Restore to Alternate","Delete Snapshot","Delete Cold Snapshot","Defreeze","Log Request","Map","Unmap","Login","Logout","Reset Password","Download Report","Email Report","Enable Backup","Disable Backup","Upgrade","Reconfigure","Re-register","Configure","Unconfigure","Enable DR","Disable DR","Regenerate Token","Decommission Cache","Add Cache Volume","Generate Token","Delete AWS Account","Edit DR Failover Setting","Add VM to DR Plan","Remove VM from DR Plan","Generate SSO Token","Edit SSO Configuration","Add Non Admin Subscription","Update Non Admin Subscription","Delete Non Admin Subscription","Refresh","Trigger DR Failover","Update Credentials","Update DR Copy","Acknowledge","Edit SSO Settings","Reconfigure VM(s) Administrative Group","Reconfigure VM(s) Backup Proxy Pool","Reconfigure VM(s) Proxy Pool","Reconfigure VM(s) Backup Policy","Remove Token","Change Password","Apply Rule(s)","Change Backup Proxy Pool","Ship Back","Snowball Request","Map to Cache","Unmap from Cache","Map for Seeding","Unmap for Seeding","Change Backup Method to RCT","Disable Backup Store","Create Cloud Administrator","Create Organization Administrator","Create Group Administrator","Create Data Protection Officer","Delete Cloud Administrator","Delete Organization Administrator","Delete Group Administrator","Delete Data Protection Officer","Cancel DR Job","DR Failover"]}},{"x-go-name":"AdminEmail","description":"Filter audit trails for specific action performed by the administrator. For example, Create, Update, Delete, Login, Backup Now, and so on. Specify multiple action values by separating them with commas.","name":"adminEmail","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAuditTrailResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/draasconfig/v2/orgs/{OrgID}/drplans":{"get":{"description":"Lists the DR Plan details for all DR Plans in the organization.","tags":["DRaaS"],"summary":"List all DR Plans","operationId":"ListRequest","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"SiteID","description":"The organization ID of your organization. Set it to a value greater than \"0\" to select your organization. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/ListResponse"}]}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud."}}}},"/draasconfig/v2/orgs/{OrgID}/jobs/failover":{"post":{"description":"Executes the Test or Production DR failover jobs for all virtual machines in the selected DR Plan.","tags":["DRaaS"],"summary":"Execute DR Failover jobs","operationId":"FailoverRequest","security":[{"Bearer":[]}],"parameters":[{"description":"The organization ID of your organization. Set it to a value greater than \"0\" to select your organization. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FailoverRequestParams"}}},"description":"All the parameters required for the DR failover job.","required":true},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/FailoverJobResponse"}]}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud."}}}},"/fileserver/v1/orgs/{OrgID}/reports/backupsets":{"get":{"description":"Returns all backup sets for Windows/Linux servers","tags":["File Server"],"summary":"List all backup sets","operationId":"FSGetBackupsetsRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"ServerName","description":"Specify the name of the Windows/Linux server. Specify multiple server names by separating them with commas. Get the name of all servers using the 'List all Windows/Linux Servers' API.","name":"serverName","in":"query","schema":{"type":"string"}},{"x-go-name":"BackupEnable","description":"Specifies whether the backup is enabled for the backup set. Example: Select 'true' if the backup is enabled for the backup set","name":"backupEnable","in":"query","schema":{"type":"boolean"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FSGetBackupsetsResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/fileserver/v1/orgs/{OrgID}/reports/contentrules":{"get":{"description":"Returns all content rules for Windows/Linux servers","tags":["File Server"],"summary":"List all content rules","operationId":"FSGetContentRulesRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FSGetContentRulesResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/fileserver/v1/orgs/{OrgID}/reports/jobs":{"get":{"description":"Returns all jobs for Windows/Linux servers","tags":["File Server"],"summary":"List all jobs","operationId":"FSGetAllJobsReportRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"JobType","description":"Specify the type of the job. This parameter can be set to one or more of the following values: Backup, Restore and Log Request. Specify multiple job types by separating them with commas. See Job Types.","name":"jobType","in":"query","schema":{"type":"string"}},{"x-go-name":"ServerName","description":"Specify the name of the Windows/Linux server. Specify multiple server names by separating them with commas. Get the name of all servers using the 'List all Windows/Linux Servers' API.","name":"serverName","in":"query","schema":{"type":"string"}},{"x-go-name":"Status","description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","schema":{"type":"string"}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FSGetAllJobsReportResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/fileserver/v1/orgs/{OrgID}/reports/jobs/backups":{"get":{"description":"Returns all backup jobs for Windows/Linux servers","tags":["File Server"],"summary":"List all backup jobs","operationId":"FSGetBackupJobReportRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"ServerName","description":"Specify the name of the Windows/Linux server. Specify multiple server names by separating them with commas. Get the name of all servers using the 'List all Windows/Linux Servers' API.","name":"serverName","in":"query","schema":{"type":"string"}},{"x-go-name":"Status","description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","schema":{"type":"string"}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FSGetBackupJobReportResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/fileserver/v1/orgs/{OrgID}/reports/jobs/restores":{"get":{"description":"Returns all restore jobs for Windows/Linux servers","tags":["File Server"],"summary":"List all restore jobs","operationId":"FSGetRestoreJobReportRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"SourceServerName","description":"Specify the name of the Windows/Linux server from which the backup job is initiated. Specify multiple server names by separating them with commas.","name":"sourceServerName","in":"query","schema":{"type":"string"}},{"x-go-name":"DestServerName","description":"Specify the name of the Windows/Linux server to which the restore job is initiated. Specify multiple server names by separating them with commas.","name":"destServerName","in":"query","schema":{"type":"string"}},{"x-go-name":"Status","description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","schema":{"type":"string"}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FSGetRestoreJobReportResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/fileserver/v1/orgs/{OrgID}/reports/jobs/uploadlogs":{"get":{"description":"Returns all upload logs jobs for Windows/Linux servers","tags":["File Server"],"summary":"List all upload logs jobs","operationId":"FSGetUploadLogJobReportRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"ServerName","description":"Specify the name of the Windows/Linux server. Specify multiple server names by separating them with commas. Get the name of all servers using the 'List all Windows/Linux Servers' API.","name":"serverName","in":"query","schema":{"type":"string"}},{"x-go-name":"Status","description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","schema":{"type":"string"}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FSGetUploadLogJobReportResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/fileserver/v1/orgs/{OrgID}/reports/policies":{"get":{"description":"Returns all policies for Windows/Linux servers","tags":["File Server"],"summary":"List all policies","operationId":"FSGetPoliciesRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FSGetPoliciesResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/fileserver/v1/orgs/{OrgID}/reports/servers":{"get":{"description":"Returns all Windows/Linux servers","tags":["File Server"],"summary":"List all Windows/Linux Servers","operationId":"FSListFileServerRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"ServerName","description":"Specify the name of the Windows/Linux server. Specify multiple server names by separating them with commas. Get the name of all servers using the 'List all Windows/Linux Servers' API.","name":"serverName","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FSListFileServerResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/fileserver/v2/orgs/{orgID}/backupsets/{backupsetID}/snapshots":{"get":{"description":"Returns snapshots for the specified backup set.","tags":["File Server"],"summary":"List all snapshots","operationId":"FSGetSnapshotsRequest","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"OrgID","description":"Specify the ID of your organization. Get the ID of an organization using the 'List all organizations' API.","name":"orgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"BackupSetID","description":"Specify the ID of your backup set. Get the ID using the 'List backup sets' API.","name":"backupsetID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"SnapshotTypes","description":"Specify the type of snapshot. The possible values for the snapshot type are: \"HOT\", \"WARM\", and \"COLD\". Specify multiple snapshot types by separating the values with commas.","name":"snapshotTypes","in":"query","schema":{"type":"string","enum":["HOT","WARM","COLD"]}},{"x-go-name":"FromTime","description":"Specify a date and time in the UTC format YYYY-MM-DDTHH:MM:SSZ to display all snapshots created after this date and time.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"ToTime","description":"Specify a date and time in the UTC format YYYY-MM-DDTHH:MM:SSZ to display all snapshots created before this date and time.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Specify whether to sort the returned snapshots in ascending or descending order of the snapshot creation time. Set it to \"ASC\" or \"DESC\" to sort the list in ascending or descending order respectively. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the results on the next page. Keep this field blank for the first request. To view the results on the next page, use the value received in the 'nextPageToken' parameter of the previous response.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/FSGetSnapshotsResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/fileserver/v2/orgs/{orgID}/jobs/backupNow":{"post":{"description":"Initiates an on-demand backup for a File Server backup set.","tags":["File Server"],"summary":"On-demand backup","operationId":"FSBackupNowRequest","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"OrgID","name":"orgID","in":"path","required":true,"description":"Specify the ID of your organization. Get the ID of an organization using the 'List all organizations' API.","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FSBackupNowRequestParams"}}},"required":true,"x-go-name":"Params"},"responses":{"200":{"description":"Result schema with Response set to job ID of newly created job","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FSBackupNowResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud."}}}},"/fileserver/v2/orgs/{orgID}/jobs/restores/originalServer":{"post":{"description":"Create a restore job for the original server at original or custom location.","tags":["File Server"],"summary":"Create a restore job for the original server","operationId":"FSOriginalRestoreRequest","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"OrgID","name":"orgID","in":"path","required":true,"description":"Specify the ID of your organization. Get the ID of an organization using the 'List all organizations' API.","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FSOriginalRestoreParams"}}},"required":true,"x-go-name":"OriginalRestoreParams"},"responses":{"200":{"description":"Successfully triggered restore job","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/FSRestoreResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud."}}}},"/fileserver/v2/orgs/{orgID}/jobs/restores/alternateServer":{"post":{"description":"Create a restore job for the alternate server.","tags":["File Server"],"summary":"Create a restore job for the alternate server","operationId":"FSAlternateRestoreRequest","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"OrgID","name":"orgID","in":"path","required":true,"description":"Specify the ID of your organization. Get the ID of an organization using the 'List all organizations' API.","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FSAlternateRestoreParams"}}},"required":true,"x-go-name":"AlternateRestoreParams"},"responses":{"200":{"description":"Successfully triggered restore job","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/FSRestoreResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud."}}}},"/fileserver/v2/orgs/{orgID}/jobs/cancel":{"post":{"description":"Cancels the specified job.","tags":["File Server"],"summary":"Cancel a job","operationId":"FSCancelJobRequest","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"SiteID","name":"orgID","in":"path","required":true,"description":"Specify the ID of your organization. Get the ID of an organization using the 'List all organizations' API.","schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FSCancelJobParams"}}},"required":true,"x-go-name":"Params"},"responses":{"200":{"description":"Result schema with response set to JobID cancelled","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FSCancelJobResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud."}}}},"/storageconfig/v2/csets/{csetID}/snapshots":{"get":{"description":"List snapshots for the specified backup set.","tags":["NAS"],"summary":"List all snapshots","operationId":"ListSnapshots","parameters":[{"x-go-name":"AuthHeader","description":"Specify atleast one authentication token.","name":"X-Drv-Product-Jwt","in":"header","required":true,"schema":{"type":"string"}},{"x-go-name":"AuthEntities","name":"authEntities","description":"Specify the authorization information. It should be in the format: \"pType=org;pID=orgID\", where orgID is the ID of your organization.","in":"header","required":true,"schema":{"type":"string"}},{"x-go-name":"CSetID","name":"csetID","description":"Specify the csetID of the corresponding backup set.","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"SnapshotTypes","name":"snapshotTypes","description":"Specify the type of snapshot. The possible values for the snapshot type are: \"HOT\", \"WARM\", and \"COLD\". Specify multiple snapshot types by separating the values with commas. Available values: HOT, WARM, COLD","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"FromTime","name":"fromTime","description":"Specify a date and time in the UTC format YYYY-MM-DD THH:MM:SSZ to display all snapshots created after this date and time.","in":"query","schema":{"type":"string"}},{"x-go-name":"ToTime","name":"toTime","description":"Specify a date and time in the UTC format YYYY-MM-DD THH:MM:SSZ to display all snapshots created before this date and time.","in":"query","schema":{"type":"string"}},{"x-go-name":"SortBy","name":"sortBy","description":"Sort the returned snapshots in ascending or descending order of the snapshot creation time. Set it to \"ASC\" or \"DESC\" to sort the list in ascending or descending order. The default value is DESC. ","in":"query","schema":{"type":"string","default":"DESC"}},{"x-go-name":"PageSize","name":"pageSize","description":"Specify the number of records that must be displayed on a page.","in":"query","schema":{"type":"integer","format":"int32"}},{"x-go-name":"PageToken","name":"pageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","in":"query","schema":{"type":"string"}},{"x-go-name":"UseCtime","name":"useCtime","description":"The parameter indicating whether the time is displayed in Epoch or CTime format.","in":"query","schema":{"type":"boolean"}}],"responses":{"200":{"description":"The list of all snapshots.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ListSnapshotsResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud."}}}},"/nas/v1/orgs/{OrgID}/reports/backupsets":{"get":{"description":"Returns a list of all backup sets for NAS hosts.","tags":["NAS"],"summary":"List all backup sets","operationId":"NASGetBackupsetsRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"HostName","description":"Specify the host name. You can specify multiple host names by separating them with commas. Get the list of the NAS host names using the 'ListHost' API.","name":"hostName","in":"query","schema":{"type":"string"}},{"x-go-name":"ProxyName","description":"Specify the proxy name. You can specify multiple proxy names by separating them with commas. (This is deprecated)","name":"proxyName (deprecated)","in":"query","schema":{"type":"string"}},{"x-go-name":"PoolName","description":"Specify the pool name. You can specify multiple pool names by separating them with commas.","name":"poolName","in":"query","schema":{"type":"string"}},{"x-go-name":"BackupEnable","description":"Specify whether the backup is enabled for the backup set. Set the value to 'true' if the backup is enabled for the backup set, else set it to 'false'.","name":"backupEnable","in":"query","schema":{"type":"boolean"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NASGetBackupsetsResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/nas/v1/orgs/{OrgID}/reports/contentrules":{"get":{"description":"Returns a list of all content rule for NAS devices.","tags":["NAS"],"summary":"List all content rules","operationId":"NASGetContentRulesRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NASGetContentRulesResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/nas/v1/orgs/{OrgID}/reports/hosts":{"get":{"description":"Returns a list of all NAS hosts.","tags":["NAS"],"summary":"ListHost","operationId":"NASListHostRequest","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"HostName","description":"Specify the name of the NAS host. Multiple host names can be separated by commas. Get the list of the NAS host names using the 'ListHost' API.","name":"hostName","in":"query","schema":{"type":"string"}},{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Result schema for 200 Response of GET ListHostResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NASListHostResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/nas/v1/orgs/{OrgID}/reports/jobs":{"get":{"description":"Returns a list of all jobs for NAS hosts.","tags":["NAS"],"summary":"List all jobs","operationId":"NASGetAllJobsReportRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"JobType","description":"Specify the type of the job. This parameter can be set to one or more of the following values: Backup, Restore, Log Request and Defreeze. Specify multiple job types by separating them with commas. See Job Types.","name":"jobType","in":"query","schema":{"type":"string"}},{"x-go-name":"HostName","description":"Specify the name of the NAS host. Multiple host names can be separated by commas. Get the list of the NAS host names using the 'ListHost' API.","name":"hostName","in":"query","schema":{"type":"string"}},{"x-go-name":"ProxyName","description":"Specify the name of the NAS proxy. Multiple proxy names can be separated by commas. Get the list of the NAS proxy names using the 'ListProxy' API.","name":"proxyName","in":"query","schema":{"type":"string"}},{"x-go-name":"Status","description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","schema":{"type":"string"}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NASGetAllJobsReportResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/nas/v1/orgs/{OrgID}/reports/jobs/backups":{"get":{"description":"Returns a list of all backup jobs for the NAS hosts.","tags":["NAS"],"summary":"List all backup jobs","operationId":"NASGetBackupJobReportRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"HostName","description":"Specify the name of the NAS host. Multiple host names can be separated by commas. Get the list of the NAS host names using the 'ListHost' API.","name":"hostName","in":"query","schema":{"type":"string"}},{"x-go-name":"ProxyName","description":"Specify the name of the NAS proxy. Multiple proxy names can be separated by commas. Get the list of the NAS proxy names using the 'ListProxy' API.","name":"proxyName","in":"query","schema":{"type":"string"}},{"x-go-name":"Status","description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","schema":{"type":"string"}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Result schema for 200 Response of GET GetBackupJobReport","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NASGetBackupJobReportResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/nas/v1/orgs/{OrgID}/reports/jobs/restores":{"get":{"description":"Returns a list of all restore jobs for NAS hosts.","tags":["NAS"],"summary":"List all restore jobs","operationId":"NASGetRestoreJobReportRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"HostName","description":"Specify the name of the NAS host. Multiple host names can be separated by commas. Get the list of the NAS host names using the 'ListHost' API.","name":"hostName","in":"query","schema":{"type":"string"}},{"x-go-name":"DestHostName","description":"Specify the name of the NAS host to which restore was initiated. Specify multiple host names by separating them with commas.","name":"destHostName","in":"query","schema":{"type":"string"}},{"x-go-name":"ProxyName","description":"Specify the name of the NAS proxy. Multiple proxy names can be separated by commas. Get the list of the NAS proxy names using the 'ListProxy' API.","name":"proxyName","in":"query","schema":{"type":"string"}},{"x-go-name":"Status","description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","schema":{"type":"string"}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Result schema for 200 Response of GET GetBackupJobReport","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NASGetRestoreJobReportResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in the Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/nas/v1/orgs/{OrgID}/reports/jobs/uploadlogs":{"get":{"description":"Returns a list of all upload logs jobs for the NAS hosts.","tags":["NAS"],"summary":"List all upload logs jobs","operationId":"NASGetUploadLogJobReportRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"HostName","description":"Specify the name of the NAS host. Multiple host names can be separated by commas. Get the list of the NAS host names using the 'ListHost' API.","name":"hostName","in":"query","schema":{"type":"string"}},{"x-go-name":"Status","description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","schema":{"type":"string"}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Result schema for 200 Response of GET GetUploadLogJobReport","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NASGetUploadLogJobReportResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/nas/v1/orgs/{OrgID}/reports/policies":{"get":{"description":"Returns a list of all NAS policies.","tags":["NAS"],"summary":"GetPolicies for policies","operationId":"NASGetPoliciesRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Result schema for 200 Response of GET GetPolicies","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NASGetPoliciesResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/nas/v1/orgs/{OrgID}/reports/proxies":{"get":{"description":"Returns a list of all configured NAS proxies.","tags":["NAS"],"summary":"ListProxy","operationId":"NASListProxyRequest","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"ProxyName","description":"Specify the name of the NAS proxy. Multiple proxy names can be separated by commas. Get the list of the NAS proxy names using the 'ListProxy' API.","name":"proxyName","in":"query","schema":{"type":"string"}},{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Result schema for 200 Response of GET ListProxyResponse","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NASListProxyResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/hyperv/v1/orgs/{OrgID}/reports/backupsets":{"get":{"description":"Returns a list of all backup sets for Hyper-V.","tags":["Hyper-V"],"summary":"List all backupsets","operationId":"HVGetBackupSetReportRequest","parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/HVGetBackupSetReportResponse"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}},"500":{"description":"The request was not processed due to an internal error in the Cloud.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}}},"security":[{"Bearer":[]}]}},"/hyperv/v1/orgs/{OrgID}/reports/flrproxies":{"get":{"description":"Returns a list of FLR proxies for Hyper-V.","tags":["Hyper-V"],"summary":"List all FLR proxies","operationId":"HVGetFLRProxyReportRequest","parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"HostName","description":"The name of the Hyper-V host on which the FLR proxy is deployed. Multiple host names can be separated by commas.","name":"hostName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/HVGetFRLProxyReportResponse"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}},"500":{"description":"The request was not processed due to an internal error in the Cloud.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}}},"security":[{"Bearer":[]}]}},"/hyperv/v1/orgs/{OrgID}/reports/hosts":{"get":{"description":"Returns a list of host proxies for Hyper-V.","tags":["Hyper-V"],"summary":"List all hosts","operationId":"HVGetHostReportRequest","parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"HostName","description":"The name of the Hyper-V host on which the FLR proxy is deployed. Multiple host names can be separated by commas.","name":"hostName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/HVGetHostReportResponse"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}},"500":{"description":"The request was not processed due to an internal error in the Cloud.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}}},"security":[{"Bearer":[]}]}},"/hyperv/v1/orgs/{OrgID}/reports/jobs":{"get":{"description":"Returns a list of all jobs for Hyper-V.","tags":["Hyper-V"],"summary":"List all jobs","operationId":"HVGetAllJobsReportRequest","parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"JobType","description":"Specify the type of the job. This parameter can be set to one or more of the following values: Backup, Restore, Log Request and Defreeze. Specify multiple job types by separating them with commas. See Job Types.","name":"jobType","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"x-go-name":"Status","description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}},{"x-go-name":"VMName","description":"The name of the virtual machine (VM) for which the job has been initiated. Specify multiple VM names by separating them with commas.","name":"vmName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"HostName","description":"The name of the Hyper-V host on which the FLR proxy is deployed. Multiple host names can be separated by commas.","name":"hostName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"integer","format":"int64"}},{"x-go-name":"EndTime","description":"Specify a time to filter jobs that were run before it. The time should be specified in the UTC format and must be lesser than the current date. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"integer","format":"int64"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/HVGetAllJobsReportResponse"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}},"500":{"description":"The request was not processed due to an internal error in the Cloud.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}}},"security":[{"Bearer":[]}]}},"/hyperv/v1/orgs/{OrgID}/reports/jobs/backups":{"get":{"description":"Returns a list of all backup jobs for Hyper-V.","tags":["Hyper-V"],"summary":"List all backup jobs","operationId":"HVGetBackupJobReportRequest","parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"VMName","description":"The name of the virtual machine (VM) for which the job has been initiated. Specify multiple VM names by separating them with commas.","name":"vmName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"HostName","description":"The name of the Hyper-V host on which the FLR proxy is deployed. Multiple host names can be separated by commas.","name":"hostName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"integer","format":"int64"}},{"x-go-name":"EndTime","description":"Specify a time to filter jobs that were run before it. The time should be specified in the UTC format and must be lesser than the current date. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"integer","format":"int64"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"Status","description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/HVGetBackupJobsReportResponse"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}},"500":{"description":"The request was not processed due to an internal error in the Cloud.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}}},"security":[{"Bearer":[]}]}},"/hyperv/v1/orgs/{OrgID}/reports/jobs/restores":{"get":{"description":"Returns a list of all restore jobs for Hyper-V.","tags":["Hyper-V"],"summary":"List all restore jobs","operationId":"HVGetRestoreJobReportRequest","parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"VMName","description":"The name of the virtual machine (VM) for which the job has been initiated. Specify multiple VM names by separating them with commas.","name":"vmName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"integer","format":"int64"}},{"x-go-name":"EndTime","description":"Specify a time to filter jobs that were run before it. The time should be specified in the UTC format and must be lesser than the current date. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"integer","format":"int64"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"Status","description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/HVGetRestoreJobsReportResponse"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}},"500":{"description":"The request was not processed due to an internal error in the Cloud.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}}},"security":[{"Bearer":[]}]}},"/hyperv/v1/orgs/{OrgID}/reports/jobs/uploadlogs":{"get":{"description":"Returns a list of all upload jobs for Hyper-V.","tags":["Hyper-V"],"summary":"List all upload logs jobs","operationId":"HVGetUploadLogJobReportRequest","parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"integer","format":"int64"}},{"x-go-name":"EndTime","description":"Specify a time to filter jobs that were run before it. The time should be specified in the UTC format and must be lesser than the current date. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"integer","format":"int64"}},{"x-go-name":"VMName","description":"The name of the virtual machine (VM) for which the job has been initiated. Specify multiple VM names by separating them with commas.","name":"vmName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"Status","description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/HVGetUploadLogJobReportResponse"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}},"500":{"description":"The request was not processed due to an internal error in the Cloud.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}}},"security":[{"Bearer":[]}]}},"/hyperv/v1/orgs/{OrgID}/reports/policies":{"get":{"description":"Returns a list of all backup policies for Hyper-V.","tags":["Hyper-V"],"summary":"List all backup policies","operationId":"HVGetBackupPoliciesReportRequest","parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/HVGetBackupPoliciesReportResponse"}]}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}},"404":{"description":"The requested resource was not found.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}},"500":{"description":"The request was not processed due to an internal error in the Cloud.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/APIError"}]}}}}},"security":[{"Bearer":[]}]}},"/cloudcache/v1/orgs/{OrgID}/reports/config":{"get":{"description":"Returns cache configuration information, such as cache server information, cache schedules, volumes and volumes usage.","tags":["CloudCache"],"summary":"List cloudcache config","operationId":"GetAllCloudCacheConfigRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"State","description":"Specify the current network status of the Cloudcache server.","name":"state","in":"query","schema":{"type":"integer","format":"int32","enum":["unconfigured","configured"]}},{"x-go-name":"CacheName","description":"Specify the name of Cloudcache(s). Specify multiple cloudcache names by separating them with commas.","name":"cacheName","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllCacheConfigResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/organization/v1/orgs":{"get":{"description":"Returns a list of all organizations.","tags":["Organization"],"summary":"List all organizations","operationId":"ListOrgRequest","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListOrgResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/storage/v1/orgs/{OrgID}/reports/usage":{"get":{"description":"Returns storage usage details for an organization, such as size of the data on the source server(s), the amount of backup data generated at the source, and the amount of storage consumed post deduplication.","tags":["Storage"],"summary":"List storage usage.","operationId":"GetStorageUsagePerOrganizationRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetStorageUsagePerOrganizationResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/vmware/v1/orgs/{OrgID}/reports/backupsets":{"get":{"description":"Returns all backup sets for VMware","tags":["VMware"],"security":[{"Bearer":[]}],"summary":"List all backup sets","operationId":"VMwareGetBackupsetsRequest","parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"VMNames","description":"Specify the name of the virtual machine (VM). Specify multiple VM names by separating them with commas.","name":"vmName","in":"query","schema":{"type":"string"}},{"x-go-name":"BackupEnable","description":"Specify whether the backup is enabled for the virtual machine. Example: Enabled, Disabled.","name":"backupEnable","in":"query","schema":{"type":"boolean"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VMwareGetBackupsetsResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/vmware/v1/orgs/{OrgID}/reports/proxies":{"get":{"description":"Returns all Backup Proxies for VMware","tags":["VMware"],"security":[{"Bearer":[]}],"summary":"List all backup proxies","operationId":"VMwareGetBackupProxiesRequest","parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"VCNames","description":"Specify the name of the VCenter registered with Phoenix. Specify multiple VCenter names by separating them with commas.","name":"vcenterName","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VMwareGetBackupProxiesResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/vmware/v1/orgs/{OrgID}/reports/jobs":{"get":{"description":"Returns all jobs for VMware","tags":["VMware"],"security":[{"Bearer":[]}],"summary":"List all jobs","operationId":"VMwareGetAllJobsInfoRequest","parameters":[{"x-go-name":"JobType","description":"Specify the type of the job. This parameter can be set to one or more of the following values: Backup, Restore, Log Request and Defreeze. Specify multiple job types by separating them with commas. See Job Types.","name":"jobType","in":"query","schema":{"type":"string"}},{"x-go-name":"Status","description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","schema":{"type":"string"}},{"x-go-name":"VMName","description":"Specify the name of the virtual machine (VM). Specify multiple VM names by separating them with commas.","name":"vmName","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}},{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VMwareGetAllJobsInfoResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/vmware/v1/orgs/{OrgID}/reports/jobs/backups":{"get":{"description":"Returns all backup jobs for VMware","tags":["VMware"],"security":[{"Bearer":[]}],"summary":"List all backup jobs","operationId":"VMwareGetAllBackupJobsInfoRequest","parameters":[{"x-go-name":"Status","description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","schema":{"type":"string"}},{"x-go-name":"VMNameList","description":"Specify the name of the virtual machine (VM). Specify multiple VM names by separating them with commas.","name":"vmName","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}},{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VMwareGetAllBackupJobsInfoResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/vmware/v1/orgs/{OrgID}/reports/jobs/restores":{"get":{"description":"Returns all restore jobs for VMware","tags":["VMware"],"security":[{"Bearer":[]}],"summary":"List all restore jobs","operationId":"VMwareGetAllRestoreJobsInfoRequest","parameters":[{"x-go-name":"Status","description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","schema":{"type":"string"}},{"x-go-name":"VMNameList","description":"Specify the name of the virtual machine (VM). Specify multiple VM names by separating them with commas.","name":"vmName","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}},{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VMwareGetAllRestoreJobsInfoResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/vmware/v1/orgs/{OrgID}/reports/jobs/uploadlogs":{"get":{"description":"Returns all upload log jobs for VMware","tags":["VMware"],"security":[{"Bearer":[]}],"summary":"List all upload logs jobs","operationId":"VMwareGetAllUploadLogsJobsInfoRequest","parameters":[{"x-go-name":"Status","description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","schema":{"type":"string"}},{"x-go-name":"VMNameList","description":"Specify the name of the virtual machine (VM). Specify multiple VM names by separating them with commas.","name":"vmName","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}},{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VMwareGetAllUploadLogsJobsInfoResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/vmware/v1/orgs/{OrgID}/reports/policies":{"get":{"description":"Returns all backup policies for VMware","tags":["VMware"],"security":[{"Bearer":[]}],"summary":"List all policies","operationId":"VMwareGetPoliciesRequest","parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VMwareGetPoliciesResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/vmware/v1/orgs/{orgID}/jobs/backupNow":{"post":{"description":"Initiates an on-demand backup for a configured virtual machine.","tags":["VMware"],"summary":"On-demand backup","operationId":"BackupNowRequest","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"OrgID","description":"Specify the organization ID of your organization. Get the ID of an organization using the 'List all organizations' API.","name":"orgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VMBackupNowRequestParams"}}},"description":"Body parameters","required":true,"x-go-name":"Params"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/VMBackupNowResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud."}}}},"/vmware/v1/orgs/{orgID}/jobs/cancel":{"post":{"description":"Cancels the specified job.","tags":["VMware"],"summary":"Cancel a job","operationId":"CancelJobRequest","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"OrgID","description":"Specify the organization ID of your organization. Get the ID of an organization using the 'List all organizations' API.","name":"orgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VMCancellationParams"}}},"description":"Body parameters","required":true,"x-go-name":"Params"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/VMCancelJobResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud."}}}},"/vmware/v1/orgs/{orgID}/backupsets/{backupsetID}/snapshots":{"get":{"description":"Returns all snapshots for the specified backup set.","tags":["VMware"],"summary":"List all snapshots","operationId":"GetSnapshotRequest","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"OrgID","description":"Specify the ID of your organization. Get the ID of an organization using the 'List all organizations' API.","name":"orgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"BackupSetID","description":"Specify the ID of your backup set. Get the ID using the 'List all backup sets' API.","name":"backupsetID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"SnapshotTypes","description":"Specify the type of snapshot. The possible values for the snapshot type are: \"HOT\", \"WARM\", and \"COLD\". Specify multiple snapshot types by separating the values with commas.","name":"snapshotTypes","in":"query","schema":{"type":"string","enum":["HOT","WARM","COLD"]}},{"x-go-name":"FromTime","description":"Specify a date and time in the UTC format YYYY-MM-DDTHH:MM:SSZ to display all snapshots created after this date and time.","name":"fromTime","in":"query","schema":{"type":"string"}},{"x-go-name":"ToTime","description":"Specify a date and time in the UTC format YYYY-MM-DDTHH:MM:SSZ to display all snapshots created before this date and time.","name":"toTime","in":"query","schema":{"type":"string"}},{"x-go-name":"SortOrder","description":"Specify whether to sort the returned snapshots in ascending or descending order of the snapshot creation time. Set it to \"ASC\" or \"DESC\" to sort the list in ascending or descending order respectively. The default value is ASC. ","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the results on the next page. Keep this field blank for the first request. To view the results on the next page, use the value received in the 'nextPageToken' parameter of the previous response.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/VMGetSnapshotResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud."}}}},"/vmware/v1/orgs/{orgID}/jobs/restores/original":{"post":{"description":"Performs a FULL restore of the VM to the original location.","tags":["VMware"],"summary":"Restore VM to original location","operationId":"RestoreOriginalRequest","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"OrgID","description":"Specify the organization ID of your organization. Get the ID of an organization using the ‘List all organizations’ API","name":"orgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VMRestoreOriginalParams"}}},"description":"Body parameters","required":true,"x-go-name":"Params"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/VMRestoreOriginalResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud."}}}},"/alerts/v1/orgs/{OrgID}/alerts":{"get":{"description":"Returns a paginated list of all alerts","tags":["Alerts"],"security":[{"Bearer":[]}],"summary":"List of Alerts","operationId":"ListAlertsRequest","parameters":[{"name":"OrgID","description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"workloadType","description":"Specify the type of the workload for which you want to see the alerts. This parameter can be set to one of the following values: fs, sql, nas, hyperv, vmware, or oracle.","in":"query","schema":{"type":"string"}},{"name":"minGeneratedOn","description":"Specify the lower bound value of the time window. The time should be specified in the UTC format and must be greater than the value of (current time - 6 months). The format of this parameter is YYYY-MM-DDTHH:MM:SSZ.","in":"query","schema":{"type":"string"}},{"name":"maxGeneratedOn","description":"Specify the upper bound value of the time window. The time should be specified in the UTC format and must be greater than the value of (current time - 6 months). The format of this parameter is YYYY-MM-DDTHH:MM:SSZ.","in":"query","schema":{"type":"string"}},{"name":"resourceType","description":"Specify the type of the resource. This parameter can be set to one of the following values: physicalServer, vmwareVM, hyperVM, nasShare, sqlAvailabilityGroup, sqlStandaloneInstance, or oracle.","in":"query","schema":{"type":"string"}},{"name":"resourceID","description":"Specify the resource ID of the resource.","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Result schema for 200 Response of GET ListAlerts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAlertsResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/alerts/v1/orgs/{OrgID}/alerts/{type}":{"get":{"description":"Returns a paginated list of all alerts of the specified type","tags":["Alerts"],"security":[{"Bearer":[]}],"summary":"List of Alerts by type","operationId":"ListAlertsByTypeRequest","parameters":[{"name":"OrgID","description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"type","description":"Specify the alert type. This parameter can be set to one of the following values: cloudcache, license, jobs, upgrade, configuration, seeding, oracle, billing.","in":"path","required":true,"schema":{"type":"string"}},{"name":"workloadType","description":"Specify the type of the workload for which you want to see the alerts. This parameter can be set to one of the following values: fs, sql, nas, hyperv, vmware, or oracle.","in":"query","schema":{"type":"string"}},{"name":"minGeneratedOn","description":"Specify the lower bound value of the time window. The time should be specified in the UTC format and must be greater than the value of (current time - 6 months). The format of this parameter is YYYY-MM-DDTHH:MM:SSZ.","in":"query","schema":{"type":"string"}},{"name":"maxGeneratedOn","description":"Specify the upper bound value of the time window. The time should be specified in the UTC format and must be greater than the value of (current time - 6 months). The format of this parameter is YYYY-MM-DDTHH:MM:SSZ.","in":"query","schema":{"type":"string"}},{"name":"resourceType","description":"Specify the type of the resource. This parameter can be set to one of the following values: physicalServer, vmwareVM, hyperVM, nasShare, sqlAvailabilityGroup, sqlStandaloneInstance, or oracle.","in":"query","schema":{"type":"string"}},{"name":"resourceID","description":"Specify the resource ID of the resource.","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Result schema for 200 Response of GET ListAlerts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAlertsResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/alerts/v1/orgs/{OrgID}/alerts/jobs/backupFailures":{"get":{"description":"ListAlerts returns a list of backup failure alerts with generic details, resource details, failed job IDs and the last successful job timestamp, if applicable","tags":["Alerts"],"security":[{"Bearer":[]}],"summary":"List backup failure alerts","operationId":"ListBackupFailureAlertsRequest","parameters":[{"name":"OrgID","description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"name":"failureNumberSinceLastSuccess","description":"Once this parameter is specified, the API returns the nth alert (where n is the value of this parameter) in the sequence since the last successful backup job, provided it lies within the time window bound by the minGeneratedOn and maxGeneratedOn. If the time window is not specified, the minGeneratedOn gets the default value as the timestamp of the last successful backup job and maxGeneratedOn gets the default value as the current time. In addition, the alert details also include the list of consecutively failed backup job IDs and the timestamp of the last successful backup job.","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"workloadType","description":"Specify the type of the workload for which you want to see the alerts. This parameter can be set to one of the following values: fs, sql, nas, hyperv, vmware, or oracle.","in":"query","schema":{"type":"string"}},{"name":"minGeneratedOn","description":"Specify the lower bound value of the time window. The time should be specified in the UTC format and must be greater than the value of (current time - 6 months). The format of this parameter is YYYY-MM-DDTHH:MM:SSZ.","in":"query","schema":{"type":"string"}},{"name":"maxGeneratedOn","description":"Specify the upper bound value of the time window. The time should be specified in the UTC format and must be greater than the value of (current time - 6 months). The format of this parameter is YYYY-MM-DDTHH:MM:SSZ.","in":"query","schema":{"type":"string"}},{"name":"resourceType","description":"Specify the type of the resource. This parameter can be set to one of the following values: physicalServer, vmwareVM, hyperVM, nasShare, sqlAvailabilityGroup, sqlStandaloneInstance, or oracle.","in":"query","schema":{"type":"string"}},{"name":"resourceID","description":"Specify the resource ID of the resource.","in":"query","schema":{"type":"integer","format":"int32"}},{"name":"pageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Result schema for 200 Response of GET ListAlerts","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBackupAlertsResponse"}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/sqlserver/v1/orgs/{OrgID}/reports/availabilitygroup":{"get":{"description":"Returns all SQL availability groups.","tags":["SQLServer"],"summary":"List all SQL availability groups","operationId":"SQLListSQLAvailabilityGroupRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"AgID","description":"Specify the ID of the SQL availability group.","name":"agID","in":"query","schema":{"type":"integer","format":"int32"}},{"x-go-name":"SQLResourceName","description":"Specify the name of the SQL availability group.","name":"resourceName","in":"query","schema":{"type":"string"}},{"x-go-name":"SQLResourceType","description":"Specify the resource type of the SQL Server. The possible values for the resource type are \"SA\" and \"AG\".","name":"resourceType","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the results on the next page. Keep this field blank for the first request. To view the results on the next page, use the value received in the 'nextPageToken' parameter of the previous response.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SQLListSQLAvailabilityGroupResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in the Cloud.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/sqlserver/v1/orgs/{OrgID}/reports/backupsets":{"get":{"description":"Returns all backup sets for SQL Servers.","tags":["SQLServer"],"summary":"List all backupsets","operationId":"SQLGetBackupsetsRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"ResourceName","description":"Specify the name of the SQL standalone instance or availability group. Specify multiple resource names by separating them with commas.","name":"resourceName","in":"query","schema":{"type":"string"}},{"x-go-name":"SQLResourceType","description":"Specify the resource type of the SQL Server, such as a standalone instance (SA) or an availability group (AG).","name":"resourceType","in":"query","schema":{"type":"string"}},{"x-go-name":"BackupEnable","description":"Specifies whether the backup is enabled for the backup set. Example: Select 'true' if the backup is enabled for the backup set","name":"backupEnable","in":"query","schema":{"type":"boolean"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SQLGetBackupsetsResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in the Cloud.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/sqlserver/v1/orgs/{OrgID}/reports/instances":{"get":{"description":"Returns all SQL instances.","tags":["SQLServer"],"summary":"List all SQL instances","operationId":"SQLListSQLInstancesRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"SQLResourceName","description":"Specify the name of the SQL standalone instance.","name":"resourceName","in":"query","schema":{"type":"string"}},{"x-go-name":"SQLResourceType","description":"Specify the resource type of the SQL Server, such as a standalone instance (SA) or an availability group (AG).","name":"resourceType","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SQLListSQLInstancesResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in the Cloud.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/sqlserver/v1/orgs/{OrgID}/reports/jobs":{"get":{"description":"Returns all jobs for SQL.","tags":["SQLServer"],"summary":"List all jobs","operationId":"SQLGetAllJobsReportRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"JobType","description":"Specify the type of the job. The possible values for the job type are: \"Backup\", \"Restore\", \"Log Request\", and \"Defreeze\". Specify multiple job types by separating the values with commas. For more information, see Job Types.","name":"jobType","in":"query","schema":{"type":"string"}},{"x-go-name":"SQLResourceName","description":"Specify the name of the SQL standalone instance or availability group for which the job is initiated. Specify multiple resource names by separating the values with commas.","name":"resourceName","in":"query","schema":{"type":"string"}},{"x-go-name":"SQLResourceType","description":"Specify the resource type of the SQL Server. The possible values for the resource type are \"SA\" and \"AG\".","name":"resourceType","in":"query","schema":{"type":"string"}},{"x-go-name":"Status","description":"Specify the status of the job. The possible values for status are: \"Queued\", \"Running\", \"Successful\", \"Successful with errors\" and \"Failed\". Specify multiple job statuses by separating the values with commas.","name":"status","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the results on the next page. Keep this field blank for the first request. To view the results on the next page, use the value received in the 'nextPageToken' parameter of the previous response.","name":"pageToken","in":"query","schema":{"type":"string"}},{"x-go-name":"StartTime","description":"Specify a date and time in the UTC format YYYY-MM-DDTHH:MM:SSZ to display all jobs created after this date and time. The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specify a date and time in the UTC format YYYY-MM-DDTHH:MM:SSZ to display all jobs created before this date and time. The timestamp must be within six months from the current date.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SQLGetAllJobsReportResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in the Cloud.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/sqlserver/v1/orgs/{OrgID}/reports/jobs/backups":{"get":{"description":"Returns all backup jobs for SQL Servers.","tags":["SQLServer"],"summary":"List all backup jobs","operationId":"SQLGetBackupJobReportRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"SQLResourceName","description":"Specify the name of the SQL standalone instance or availability group for which the job is initiated. Specify multiple resource names by separating them with commas.","name":"resourceName","in":"query","schema":{"type":"string"}},{"x-go-name":"SQLResourceType","description":"Specify the resource type of the SQL Server, such as a standalone instance (SA) or an availability group (AG).","name":"resourceType","in":"query","schema":{"type":"string"}},{"x-go-name":"Status","description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","schema":{"type":"string"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SQLGetBackupJobReportResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in the Cloud.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/sqlserver/v1/orgs/{OrgID}/reports/jobs/defreezes":{"get":{"description":"Returns all defreeze jobs for SQL Servers.","tags":["SQLServer"],"summary":"List all defreeze jobs","operationId":"SQLGetDefreezeJobReportRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"SQLResourceName","description":"Specify the name of the SQL standalone instance or availability group for which the job is initiated. Specify multiple resource names by separating them with commas.","name":"resourceName","in":"query","schema":{"type":"string"}},{"x-go-name":"SQLResourceType","description":"Specify the resource type of the SQL Server, such as a standalone instance (SA) or an availability group (AG).","name":"resourceType","in":"query","schema":{"type":"string"}},{"x-go-name":"Status","description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","schema":{"type":"string"}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SQLGetDefreezeJobReportResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in the Cloud.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/sqlserver/v1/orgs/{OrgID}/reports/jobs/restores":{"get":{"description":"Returns all restore jobs for SQL Servers.","tags":["SQLServer"],"summary":"List all restore jobs","operationId":"SQLGetRestoreJobReportRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"SourceDeviceName","description":"Specify the name of the SQL standalone instance or availability group for which the job is initiated. Specify multiple resource names by separating them with commas.","name":"resourceName","in":"query","schema":{"type":"string"}},{"x-go-name":"SQLResourceType","description":"Specify the resource type of the SQL Server, such as a standalone instance (SA) or an availability group (AG).","name":"resourceType","in":"query","schema":{"type":"string"}},{"x-go-name":"Status","description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","schema":{"type":"string"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"DestServerName","description":"Specify the name of the SQL server to which the restore job is initiated. Specify multiple server names by separating them with commas.","name":"destServerName","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SQLGetRestoreJobReportResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in the Cloud.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/sqlserver/v1/orgs/{OrgID}/reports/jobs/uploadlogs":{"get":{"description":"Returns all upload logs jobs for SQL Servers.","tags":["SQLServer"],"summary":"List all uploadlogs jobs","operationId":"SQLGetUploadLogJobReportRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"SQLResourceName","description":"Specify the name of the SQL standalone instance or availability group for which the job is initiated. Specify multiple resource names by separating them with commas.","name":"resourceName","in":"query","schema":{"type":"string"}},{"x-go-name":"SQLResourceType","description":"Specify the resource type of the SQL Server, such as a standalone instance (SA) or an availability group (AG).","name":"resourceType","in":"query","schema":{"type":"string"}},{"x-go-name":"Status","description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","schema":{"type":"string"}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SQLGetUploadLogJobReportResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in the Cloud.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/sqlserver/v1/orgs/{OrgID}/reports/policies":{"get":{"description":"Returns all policies for SQL Server for the given query parameters.","tags":["SQLServer"],"summary":"List all policies","operationId":"SQLGetPoliciesRequest","security":[{"Bearer":[]}],"parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"*/*":{"schema":{"$ref":"#/components/schemas/SQLGetPoliciesResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in the Cloud.","content":{"*/*":{"schema":{"$ref":"#/components/schemas/ServiceError"}}}}}}},"/sqlserver/v2/orgs/{orgID}/jobs/backupNow":{"post":{"description":"Initiates an on-demand backup for a SQL Server backup set.","tags":["SQLServer"],"summary":"On-demand backup","operationId":"SQLBackupNowRequest","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"OrgID","description":"Specify the ID of your organization under which the SQL Server is registered. Get the ID of an organization using the 'List all organizations' API.","name":"orgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SQLBackupNowRequestParams"}}},"description":"The inputs to the BackupNow job request","required":true,"x-go-name":"Params"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/SQLBackupNowResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud."}}}},"/sqlserver/v2/orgs/{orgID}/jobs/cancel":{"post":{"description":"Cancels the specified job.","tags":["SQLServer"],"summary":"Cancel a job","operationId":"SQLCancelJobRequest","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"OrgID","description":"Specify the ID of your organization under which the SQL Server is registered. Get the ID of an organization using the 'List all organizations' API.","name":"orgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SQLCancellationParams"}}},"description":"Body parameters","required":true,"x-go-name":"Params"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/SQLCancelJobResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud."}}}},"/sqlserver/v2/orgs/{orgID}/backupsets/{backupsetID}":{"get":{"description":"Returns details of the specified backup set.","tags":["SQLServer"],"summary":"Get backup set details","operationId":"SQLGetBackupsetDetailsRequest","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"OrgID","description":"Specify the ID of your organization under which the SQL Server is registered. Get the ID of an organization using the 'List all organizations' API.","name":"orgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"BackupSetID","description":"Specify the ID of your backup set. Get the ID using the 'List backup sets' API","name":"backupsetID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/SQLGetBackupsetDetailsResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud."}}}},"/sqlserver/v2/orgs/{orgID}/backupsets/{backupsetID}/snapshots":{"get":{"description":"Returns snapshots for the specified backup set.","tags":["SQLServer"],"summary":"List all snapshots","operationId":"SQLListSnapshotRequest","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"OrgID","description":"Specify the ID of your organization under which the SQL Server is registered. Get the ID of an organization using the 'List all organizations' API.","name":"orgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"BackupSetID","description":"Specify the ID of your backup set. Get the ID using the 'List backup sets' API.","name":"backupsetID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"SnapshotTypes","description":"Specify the type of snapshot. The possible values for the snapshot type are: \"HOT\", \"WARM\", and \"COLD\". Specify multiple snapshot types by separating the values with commas.","name":"snapshotTypes","in":"query","schema":{"type":"string"}},{"x-go-name":"FromTime","description":"Specify a date and time in the UTC format YYYY-MM-DDTHH:MM:SSZ to display all snapshots created after this date and time.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"ToTime","description":"Specify a date and time in the UTC format YYYY-MM-DDTHH:MM:SSZ to display all snapshots created before this date and time.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Specify whether to sort the returned snapshots in ascending or descending order of the snapshot creation time. Set it to \"ASC\" or \"DESC\" to sort the list in ascending or descending order respectively. The default value is DESC.","name":"sortOrder","in":"query","schema":{"type":"string","enum":["ASC","DESC"]}},{"x-go-name":"PageToken","description":"Specify the token to access the results on the next page. Keep this field blank for the first request. To view the results on the next page, use the value received in the 'nextPageToken' parameter of the previous response.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/SQLListSnapshotResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud."}}}},"/sqlserver/v2/orgs/{orgID}/jobs/restores/alternate":{"post":{"description":"Performs a full restore of SQL Server database(s) to an alternate instance or availability group.","tags":["SQLServer"],"summary":"Restore SQL Server database(s) to an alternate location","operationId":"SQLRestoreToAlternateInstanceRequest","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"SiteID","description":"Specify the ID of your organization under which the SQL Server is registered. Get the ID of an organization using the 'List all organizations' API.","name":"orgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SQLRestoreToAlternateParams"}}},"description":"Body parameters","required":true,"x-go-name":"Params"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/SQLRestoreToAlternateInstanceResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud."}}}},"/sqlserver/v2/orgs/{orgID}/jobs/restores/original":{"post":{"description":"Performs a FULL restore of SQL Server database(s) to the original location.","tags":["SQLServer"],"summary":"Restore SQL Server database(s) to the original location","operationId":"SQLRestoreToOriginalInstanceRequest","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"OrgID","description":"Specify the ID of your organization under which the SQL Server is registered. Get the ID of an organization using the 'List all organizations' API.","name":"orgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SQLRestoreToOriginalParams"}}},"description":"Body parameters","required":true,"x-go-name":"Params"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/SQLRestoreToOriginalInstanceResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud."}}}},"/oraclesbt/v1/orgs/{OrgID}/reports/databases":{"get":{"description":"Returns all databases","tags":["OracleDTC"],"summary":"List all databases","operationId":"ListDatabaseRequest","parameters":[{"description":"The organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"ServerName","description":"The name of the Oracle server host registered with Enterprise Workloads. Specify multiple server names by separating them with commas.","name":"serverName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"DBName","description":"The name of the database. Specify multiple names by separating them with commas.","name":"dbName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"Token","description":"The token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDatabaseReportResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}},"security":[{"Bearer":[]}]}},"/oraclesbt/v1/orgs/{OrgID}/reports/servers":{"get":{"description":"Returns all servers","tags":["OracleDTC"],"summary":"List all servers","operationId":"ListServerRequest","parameters":[{"description":"The organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"ServerName","description":"The name of the Oracle server host registered with Enterprise Workloads. Specify multiple server names by separating them with commas.","name":"serverName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"Token","description":"The token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListServerReportResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}},"security":[{"Bearer":[]}]}},"/oraclesbt/v1/orgs/{OrgID}/reports/policies":{"get":{"description":"Returns all backup polices","tags":["OracleDTC"],"summary":"List all backup polices","operationId":"ListPolicyRequest","parameters":[{"description":"The organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"Token","description":"The token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPolicyReportResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}},"security":[{"Bearer":[]}]}},"/oraclesbt/v1/orgs/{OrgID}/reports/backupsets":{"get":{"description":"Returns all backup sets","tags":["OracleDTC"],"summary":"List all backup sets","operationId":"ListBackupsetReportRequest","parameters":[{"description":"The organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"ServerName","description":"The name of the Oracle server host registered with Enterprise Workloads. Specify multiple server names by separating them with commas.","name":"serverName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"DBName","description":"The name of the database. Specify multiple names by separating them with commas.","name":"dbName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"Token","description":"The token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListBackupsetReportResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}},"security":[{"Bearer":[]}]}},"/oraclesbt/v1/orgs/{OrgID}/reports/jobs":{"get":{"description":"Returns all jobs","tags":["OracleDTC"],"summary":"List all jobs","operationId":"OracleSBTGetAllJobsReportRequest","parameters":[{"description":"The organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"JobType","description":"The type of the job. This parameter can be set to one or more of the following values: Backup, Restore, and Log Request. Specify multiple job types by separating them with commas. For more information, see Job Types.","name":"jobType","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"x-go-name":"JobSubType","description":"The subtype of the job. This parameter can be set to one or more of the following values: Full Backup, Incremental Backup, and Log Backup. Specify multiple job subtypes by separating them with commas.","name":"jobSubType","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"x-go-name":"ServerName","description":"The name of the Oracle server host for which the job is initiated. Specify multiple server names by separating them with commas.","name":"serverName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"DatabaseName","description":"The name of the database for which the job is initiated. Specify multiple database names by separating them with commas.","name":"dbName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"Status","description":"Status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful and Failed. Specify multiple status values by separating them with commas. For more information, see Job Types.","name":"status","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"x-go-name":"StartTime","description":"Specifies the lower bound value of the filter range. The time should be specified in the UTC format and must be greater than the value of (current time - 6 months). The format of this parameter is YYYY-MM-DDTHH:MM:SSZ.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specifies the upper bound value of the filter range. The time should be specified in the UTC format and must be lesser than the current date. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"The token to access the next page of results. Keep this field blank in the first request.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OracleSBTGetAllJobsReportResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}},"security":[{"Bearer":[]}]}},"/oraclesbt/v1/orgs/{OrgID}/reports/jobs/backups":{"get":{"description":"Returns all backup jobs","tags":["OracleDTC"],"summary":"List all backup jobs","operationId":"OracleSBTGetBackupJobReportRequest","parameters":[{"description":"The organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"ServerName","description":"The name of the Oracle server host for which the job is initiated. Specify multiple server names by separating them with commas.","name":"serverName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"DatabaseName","description":"The name of the database for which the job is initiated. Specify multiple names by separating them with commas.","name":"dbName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"JobSubType","description":"The subtype of the job. This parameter can be set to one or more of the following values: Full Backup, Incremental Backup, and Log Backup. Specify multiple job subtypes by separating them with commas.","name":"jobSubType","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"x-go-name":"Status","description":"Status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"x-go-name":"StartTime","description":"Specifies the lower bound value of the filter range. The time should be specified in the UTC format and must be greater than the value of (current time - 6 months). The format of this parameter is YYYY-MM-DDTHH:MM:SSZ.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specifies the upper bound value of the filter range. The time should be specified in the UTC format and must be lesser than the current date. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"The token to access the next page of results. Keep this field blank in the first request.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OracleSBTGetBackupJobReportResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}},"security":[{"Bearer":[]}]}},"/oraclesbt/v1/orgs/{OrgID}/reports/jobs/restores":{"get":{"description":"Returns all restore jobs","tags":["OracleDTC"],"summary":"List all restore jobs","operationId":"OracleSBTGetRestoreJobReportRequest","parameters":[{"description":"The organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"SourceServerName","description":"The name of the Oracle server host whose database is backed up when a backup job is initiated. Specify multiple server names by separating them with commas.","name":"sourceServerName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"DestServerName","description":"The name of the Oracle server host on which the backup data is downloaded when the restore job completes. Specify multiple server names by separating them with commas.","name":"destServerName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"DatabaseName","description":"The name of the database for which the job is initiated. Specify multiple names by separating them with commas.","name":"dbName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"Status","description":"Status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"x-go-name":"StartTime","description":"Specifies the lower bound value of the filter range. The time should be specified in the UTC format and must be greater than the value of (current time - 6 months). The format of this parameter is YYYY-MM-DDTHH:MM:SSZ.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specifies the upper bound value of the filter range. The time should be specified in the UTC format and must be lesser than the current date. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"The token to access the next page of results. Keep this field blank in the first request.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OracleSBTGetRestoreJobReportResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}},"security":[{"Bearer":[]}]}},"/oraclesbt/v1/orgs/{OrgID}/reports/jobs/uploadlogs":{"get":{"description":"Returns all upload logs jobs","tags":["OracleDTC"],"summary":"List all upload logs jobs","operationId":"OracleSBTGetUploadLogJobReportRequest","parameters":[{"description":"The organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"ServerName","description":"The name of the Oracle server host for which the job is initiated. Specify multiple server names by separating them with commas.","name":"serverName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"DatabaseName","description":"The name of the database for which the job is initiated. Specify multiple database names by separating them with commas.","name":"dbName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"Status","description":"Status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"x-go-name":"StartTime","description":"Specifies the lower bound value of the filter range. The time should be specified in the UTC format and must be greater than the value of (current time - 6 months). The format of this parameter is YYYY-MM-DDTHH:MM:SSZ.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specifies the upper bound value of the filter range. The time should be specified in the UTC format and must be lesser than the current date. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"The token to access the next page of results. Keep this field blank in the first request.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OracleSBTGetUploadLogJobReportResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}},"security":[{"Bearer":[]}]}},"/oraclesbt/v1/orgs/{orgID}/jobs/backupNow":{"post":{"description":"Initiates an on-demand backup for an Oracle Direct To Cloud backup set","tags":["OracleDTC"],"summary":"On-demand backup","operationId":"BackupJobBackupNow","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"OrgID","description":"Specify the ID of your organization. Get the ID of an organization using the 'List all organizations' API.","name":"orgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OracleDTCBackupNowRequestParams"}}},"description":"The inputs to the BackupNow job request","required":true,"x-go-name":"Params"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/OracleDTCBackupNowResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud."}}}},"/oraclesbt/v1/orgs/{orgID}/jobs/cancel":{"post":{"description":"Cancels the specified job.","tags":["OracleDTC"],"summary":"Cancel a job","operationId":"AllJobCancelJob","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"OrgID","description":"Specify the ID of your organization. Get the ID of an organization using the 'List all organizations' API.","name":"orgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OracleDTCCancellationParams"}}},"description":"Body parameters","required":true,"x-go-name":"Params"},"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/OracleDTCCancelJobResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud."}}}},"/oraclesbt/v1/orgs/{orgID}/backupsets/{backupsetID}/snapshots":{"get":{"description":"Returns snapshots for the specified backup set.","tags":["OracleDTC"],"summary":"List all snapshots","operationId":"OracleDTCGetSnapshotsRequest","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"OrgID","description":"Specify the ID of your organization. Get the ID of an organization using the 'List all organizations' API.","name":"orgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"BackupSetID","description":"Specify the ID of your backup set. Get the ID of your backup set using the 'List all backup sets' API.","name":"backupsetID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"SnapshotTypes","description":"Specify the type of snapshot. Set it to \"HOT\", \"WARM\", or \"COLD\" to display all snapshots of the specified type. Specify multiple snapshot types by separating the values with commas.","name":"snapshotTypes","in":"query","schema":{"type":"string"}},{"x-go-name":"FromTime","description":"Specify a date and time in the UTC format YYYY-MM-DDTHH:MM:SSZ to display all snapshots created after this date and time.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"ToTime","description":"Specify a date and time in the UTC format YYYY-MM-DDTHH:MM:SSZ to display all snapshots created before this date and time.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Specify whether to sort the returned snapshots in ascending or descending order of the snapshot creation time. Set it to \"ASC\" or \"DESC\" to sort the list in ascending or descending order respectively. The default value is DESC.","name":"sortOrder","in":"query","schema":{"type":"string","enum":["ASC","DESC"]}},{"x-go-name":"PageToken","description":"Specify the token to access the results on the next page. Keep this field blank for the first request. To view the results on the next page, use the value received in the 'nextPageToken' parameter of the previous response.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/OracleDTCGetSnapshotsResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud."}}}},"/oraclesbt/v1/orgs/{orgID}/jobs/restores/original":{"post":{"description":"Automatically restores the specified database to the original server.","tags":["OracleDTC"],"summary":"Full database restore to original","operationId":"OracleDTCRestoreOriginalRequest","security":[{"Bearer":[]}],"parameters":[{"x-go-name":"OrgID","description":"Specify the ID of your organization. Get the ID of an organization using the 'List all organizations' API.","name":"orgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OracleDTCRestoreOriginalParams"}}},"description":"Body parameters","required":true,"x-go-name":"Params"},"responses":{"200":{"description":"Successfully triggered restore job","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/OracleDTCRestoreOriginalResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud."}}}},"/pbs/v1/orgs/{OrgID}/reports/backupsets":{"get":{"description":"Returns all backupsets for Phoenix Backup Stores.","tags":["PBS"],"summary":"List all backupsets","operationId":"PBSGetBackupsetsRequest","security":[{"Bearer":[]}],"parameters":[{"description":"The ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"ServerName","description":"The name of the Oracle server host or the Phoenix Backup Store. Specify multiple server names by separating them with commas.","name":"serverName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"BackupEnabled","description":"Specifies whether the backup is enabled for the backup set. Select 'true' if the backup is enabled for the backup set.","name":"backupEnabled","in":"query","schema":{"type":"boolean"}},{"x-go-name":"PageToken","description":"The token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PBSGetBackupsetsResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/pbs/v1/orgs/{OrgID}/reports/backupstores":{"get":{"description":"Returns all backupstores","tags":["PBS"],"summary":"List all backupstores","operationId":"PBSListBackupstoreRequest","security":[{"Bearer":[]}],"parameters":[{"description":"The ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"ServerName","description":"The name of the Oracle server host or the Phoenix Backup Store. Specify multiple server names by separating them with commas.","name":"serverName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"PageToken","description":"The token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PBSBackupstoreResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/pbs/v1/orgs/{OrgID}/reports/jobs":{"get":{"description":"Returns all jobs for Phoenix Backup Stores.","tags":["PBS"],"summary":"List all jobs","operationId":"PBSGetAllJobsReportRequest","security":[{"Bearer":[]}],"parameters":[{"description":"The ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"JobType","description":"The type of the job. This parameter can be set to one or more of the following values: Backup, Restore and Log Request. Specify multiple job types by separating them with commas. See Job Types.","name":"jobType","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"x-go-name":"ServerName","description":"The name of the Oracle server host or the Phoenix Backup Store. Specify multiple server names by separating them with commas.","name":"serverName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"Status","description":"The status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"x-go-name":"StartTime","description":"The date and time to filter jobs that were run after the specified timestamp. Specify the date and time in UTC format and the timestamp must be greater than the value of (current time - 6 months). The format is YYYY-MM-DDTHH:MM:SSZ.","name":"fromTime","in":"query","schema":{"type":"integer","format":"int64"}},{"x-go-name":"EndTime","description":"The date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"integer","format":"int64"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"The token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PBSGetAllJobsReportResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/pbs/v1/orgs/{OrgID}/reports/jobs/backups":{"get":{"description":"Returns all backup jobs for Phoenix Backup Stores.","tags":["PBS"],"summary":"List all backup jobs","operationId":"PBSGetBackupJobReportRequest","security":[{"Bearer":[]}],"parameters":[{"description":"The ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"ServerName","description":"The name of the Oracle server host or the Phoenix Backup Store. Specify multiple server names by separating them with commas.","name":"serverName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"Status","description":"The status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"x-go-name":"StartTime","description":"The date and time to filter jobs that were run after the specified timestamp. Specify the date and time in UTC format and the timestamp must be greater than the value of (current time - 6 months). The format is YYYY-MM-DDTHH:MM:SSZ.","name":"fromTime","in":"query","schema":{"type":"integer","format":"int64"}},{"x-go-name":"EndTime","description":"The date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"integer","format":"int64"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"The token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PBSGetBackupJobReportResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/pbs/v1/orgs/{OrgID}/reports/jobs/restores":{"get":{"description":"Returns all restore jobs for Phoenix Backup Stores.","tags":["PBS"],"summary":"List all restore jobs","operationId":"PBSGetRestoreJobReportRequest","security":[{"Bearer":[]}],"parameters":[{"description":"The ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"SourceServerName","description":"The name of the Oracle server host or the Phoenix Backup Store whose database is backed up when a backup job is initiated. Specify multiple server names by separating them with commas.","name":"sourceServerName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"DestServerName","description":"The name of the Oracle server host or the Phoenix Backup Store on which the backup data is downloaded when the restore job completes. Specify multiple server names by separating them with commas.","name":"destServerName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"Status","description":"The status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"x-go-name":"StartTime","description":"The date and time to filter jobs that were run after the specified timestamp. Specify the date and time in UTC format and the timestamp must be greater than the value of (current time - 6 months). The format is YYYY-MM-DDTHH:MM:SSZ.","name":"fromTime","in":"query","schema":{"type":"integer","format":"int64"}},{"x-go-name":"EndTime","description":"The date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"integer","format":"int64"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"The token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PBSGetRestoreJobReportResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/pbs/v1/orgs/{OrgID}/reports/jobs/uploadlogs":{"get":{"description":"Returns all uploadlogs jobs for Phoenix Backup Stores.","tags":["PBS"],"summary":"List all uploadlogs jobs","operationId":"PBSGetUploadLogJobReportRequest","security":[{"Bearer":[]}],"parameters":[{"description":"The ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"ServerName","description":"The name of the Oracle server host or the Phoenix Backup Store. Specify multiple server names by separating them with commas.","name":"serverName","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"string"}}},{"x-go-name":"Status","description":"The status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","name":"status","in":"query","style":"form","explode":false,"schema":{"type":"array","items":{"type":"integer","format":"int32"}}},{"x-go-name":"StartTime","description":"Specifies the lower bound value of the filter range. The time should be specified in the UTC format and must be greater than the value of (current time - 6 months). The format of this parameter is YYYY-MM-DDTHH:MM:SSZ.","name":"fromTime","in":"query","schema":{"type":"integer","format":"int64"}},{"x-go-name":"EndTime","description":"Specifies the upper bound value of the filter range. The time should be specified in the UTC format and must be lesser than the current date. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"integer","format":"int64"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"The token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PBSGetUploadLogJobReportResponse"}}}},"400":{"description":"Bad Request"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/APIError"}}}}}}},"/ahv/v1/orgs/{OrgID}/reports/backupsets":{"get":{"description":"Returns all backup sets","tags":["AHV"],"security":[{"Bearer":[]}],"summary":"List all backup sets","operationId":"AHVGetBackupsetsRequest","parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"VMNames","description":"Specify the name of the virtual machine. Specify multiple virtual machine names by separating names with commas.","name":"vmName","in":"query","schema":{"type":"string"}},{"x-go-name":"BackupEnable","description":"Specify whether the backup is enabled or disabled for the virtual machine.","name":"backupEnable","in":"query","schema":{"type":"boolean"}},{"x-go-name":"PageToken","description":"Specify the token to access the results on the next page. Keep this field blank for the first request. To view the results on the next page, use the value received in the 'nextPageToken' parameter of the previous response.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/AHVGetBackupsetsResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/ServiceError"}]}}}}}}},"/ahv/v1/orgs/{OrgID}/reports/jobs":{"get":{"description":"Returns all jobs","tags":["AHV"],"security":[{"Bearer":[]}],"summary":"List all jobs","operationId":"AHVGetAllJobsInfoRequest","parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"JobType","description":"Specify the type of the job. Set this value as \"Backup\", \"Restore\", or \"Log Request\". Specify multiple job types by separating them with commas.","name":"jobType","in":"query","schema":{"type":"string"}},{"x-go-name":"Status","description":"Specify the status of the job. Set this value as \"Queued\", \"Running\", \"Successful\", \"Successful with errors\", or \"Failed\". Specify multiple status values by separating them with commas.","name":"status","in":"query","schema":{"type":"string"}},{"x-go-name":"VMName","description":"Specify the name of the VM. Specify multiple VM names by separating them with commas.","name":"vmName","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the results on the next page. Keep this field blank for the first request. To view the results on the next page, use the value received in the 'nextPageToken' parameter of the previous response.","name":"pageToken","in":"query","schema":{"type":"string"}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/AHVGetAllJobsInfoResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/ServiceError"}]}}}}}}},"/ahv/v1/orgs/{OrgID}/reports/jobs/backups":{"get":{"description":"Returns all backup jobs","tags":["AHV"],"security":[{"Bearer":[]}],"summary":"List all backup jobs","operationId":"AHVGetAllBackupJobsInfoRequest","parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"Status","description":"Specify the status of the job. Set this value as \"Queued\", \"Running\", \"Successful\", \"Successful with errors\", or \"Failed\". Specify multiple job statuses by separating the values with commas.","name":"status","in":"query","schema":{"type":"string"}},{"x-go-name":"VMNameList","description":"Specify the name of the VM. Specify multiple VM names by separating them with commas.","name":"vmName","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the results on the next page. Keep this field blank for the first request. To view the results on the next page, use the value received in the 'nextPageToken' parameter of the previous response.","name":"pageToken","in":"query","schema":{"type":"string"}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/AHVGetAllBackupJobsInfoResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/ServiceError"}]}}}}}}},"/ahv/v1/orgs/{OrgID}/reports/jobs/restores":{"get":{"description":"Returns all restore jobs","tags":["AHV"],"security":[{"Bearer":[]}],"summary":"List all restore jobs","operationId":"AHVGetAllRestoreJobsInfoRequest","parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"Status","description":"Specify the status of the job. Set the status as \"Queued\", \"Running\", \"Successful\", \"Successful with errors\", or \"Failed\". Specify multiple job statuses by separating the values with commas.","name":"status","in":"query","schema":{"type":"string"}},{"x-go-name":"VMNameList","description":"Specify the name of the virtual machine. Specify multiple virtual machine names by separating names with commas.","name":"vmName","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the results on the next page. Keep this field blank for the first request. To view the results on the next page, use the value received in the 'nextPageToken' parameter of the previous response.","name":"pageToken","in":"query","schema":{"type":"string"}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/AHVGetAllRestoreJobsInfoResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/ServiceError"}]}}}}}}},"/ahv/v1/orgs/{OrgID}/reports/jobs/uploadlogs":{"get":{"description":"Returns all upload log jobs","tags":["AHV"],"security":[{"Bearer":[]}],"summary":"List all upload log jobs","operationId":"AHVGetAllUploadLogsJobsInfoRequest","parameters":[{"description":"Organization ID of the organization under which your ahv hosts are registered. Set it to \"0\" to select all organizations","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"Status","description":"Specify the status of the job. Set the values to \"Queued\", \"Running\", \"Successful\", \"Successful with errors\", or \"Failed\". Specify multiple job statuses by separating the values with commas.","name":"status","in":"query","schema":{"type":"string"}},{"x-go-name":"VMNameList","description":"Specify the name of the VM. Specify multiple VM names by separating them with commas.","name":"vmName","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the results on the next page. Keep this field blank for the first request. To view the results on the next page, use the value received in the 'nextPageToken' parameter of the previous response.","name":"pageToken","in":"query","schema":{"type":"string"}},{"x-go-name":"StartTime","description":"Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.","name":"fromTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"EndTime","description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.","name":"toTime","in":"query","schema":{"type":"string","format":"date-time"}},{"x-go-name":"SortOrder","description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.","name":"sortOrder","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/AHVGetAllUploadLogsJobsInfoResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/ServiceError"}]}}}}}}},"/ahv/v1/orgs/{OrgID}/reports/policies":{"get":{"description":"Returns all backup policies","tags":["AHV"],"security":[{"Bearer":[]}],"summary":"List all policies","operationId":"AHVGetPoliciesRequest","parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"PageToken","description":"Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/AHVGetPoliciesResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/ServiceError"}]}}}}}}},"/ahv/v1/orgs/{OrgID}/reports/proxies":{"get":{"description":"Returns all backup proxies","tags":["AHV"],"security":[{"Bearer":[]}],"summary":"List all backup proxies","operationId":"AHVGetBackupProxiesRequest","parameters":[{"description":"Specify the organization ID of your organization. Set it to \"0\" to select all organizations. Get the ID of an organization using the 'List all organizations' API.","name":"OrgID","in":"path","required":true,"schema":{"type":"integer","format":"int32"}},{"x-go-name":"ClusterNames","description":"Specify the name of the cluster registered with Druva. Specify multiple cluster names by separating them with commas.","name":"clusterName","in":"query","schema":{"type":"string"}},{"x-go-name":"PageToken","description":"Specify the token to access the results on the next page. Keep this field blank for the first request. To view the results on the next page, use the value received in the 'nextPageToken' parameter of the previous response.","name":"pageToken","in":"query","schema":{"type":"string"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/AHVGetBackupProxiesResponse"}]}}}},"400":{"description":"Bad Request"},"401":{"description":"The request did not include an authentication token or the authentication token was expired."},"403":{"description":"Forbidden"},"404":{"description":"The requested resource was not found."},"500":{"description":"The request was not processed due to an internal error in Cloud.","content":{"application/json":{"schema":{"type":"object","allOf":[{"$ref":"#/components/schemas/ServiceError"}]}}}}}}}},"servers":[{"url":"//govapis.druva.com/phoenix"}],"components":{"securitySchemes":{"OAuth2":{"type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://apis.druva.com/token","scopes":{"read":"Grants read access"}}}},"Bearer":{"type":"apiKey","name":"Authorization","in":"header"}},"schemas":{"CreateBackupTriggerArgs":{"description":"TriggerArgs bundles all job creations params in single data type","type":"object","required":["backupsetID"],"properties":{"backupsetID":{"description":"Specify the ID of the backup set. Get the ID using the 'List backup sets' API.","type":"integer","format":"int64","x-go-name":"BackupsetID"},"jobParams":{"$ref":"#/components/schemas/JSONMap"}},"x-go-name":"TriggerArgs","x-go-package":"git.druva.org/foundation/jobmgmt/haydn/spec/enterpriseworkload/backup/base"},"CreateRestoreTriggerArgs":{"description":"TriggerArgs bundles all job creations params in single data type","type":"object","required":["backupsetID","snapshotID"],"properties":{"backupsetID":{"description":"Specify the ID of the backup set. Get the ID using the 'List backup sets' API.","type":"integer","format":"int32","x-go-name":"BackupsetID"},"jobParams":{"$ref":"#/components/schemas/JSONMap"},"restoreType":{"type":"string","x-go-name":"RestoreType"},"rwcConfig":{"$ref":"#/components/schemas/RWCConfig"},"snapshotID":{"type":"string","x-go-name":"SnapshotID"},"snapshotName":{"description":"UI visibile snapshot name","type":"string","x-go-name":"SnapshotName"},"sourceList":{"type":"array","items":{"type":"string"},"x-go-name":"SourceList"}},"x-go-name":"TriggerArgs","x-go-package":"git.druva.org/foundation/jobmgmt/haydn/spec/enterpriseworkload/restore/base"},"CreateBackupResponse":{"description":"CreateResponse is response schema for Create Request","type":"object","properties":{"job":{"$ref":"#/components/schemas/Job"}},"x-go-name":"CreateResponse","x-go-package":"git.druva.org/foundation/jobmgmt/haydn/spec/enterpriseworkload/backup/base"},"CreateRestoreResponse":{"description":"CreateResponse is response schema for Create Request","type":"object","properties":{"job":{"$ref":"#/components/schemas/Job"}},"x-go-name":"CreateResponse","x-go-package":"git.druva.org/foundation/jobmgmt/haydn/spec/enterpriseworkload/restore/base"},"Job":{"description":"Job defines the schema for a job","type":"object","properties":{"actualErrorCode":{"type":"string","x-go-name":"ActualErrorCode"},"attemptNo":{"type":"integer","format":"int64","x-go-name":"AttemptNo"},"createdTS":{"type":"integer","format":"int64","x-go-name":"CreatedTS"},"endedTS":{"type":"integer","format":"int64","x-go-name":"EndedTS"},"entityID":{"type":"integer","format":"int64","x-go-name":"EntityID"},"entityName":{"type":"string","x-go-name":"EntityName"},"entityType":{"type":"string","x-go-name":"EntityType"},"errorCategory":{"type":"string","x-go-name":"ErrorCategory"},"errorCode":{"type":"integer","format":"int64","x-go-name":"ErrorCode"},"errorDetails":{"$ref":"#/components/schemas/JSONMap"},"errorMsg":{"type":"string","x-go-name":"ErrorMsg"},"extendedParams":{"type":"object","additionalProperties":{"type":"object"},"x-go-name":"ExtendedParams"},"globalCustomerID":{"description":"GlobalCustomerID is global ID of customer for whom this job is created","type":"string","x-go-name":"GlobalCustomerID"},"jobConfig":{"$ref":"#/components/schemas/JSONMap"},"jobID":{"type":"integer","format":"int64","x-go-name":"JobID"},"jobType":{"description":"JobType is consumer service defined job type","type":"string","x-go-name":"JobType"},"percent":{"description":"TODO: How to update this efficiently. For agent it is better to update just stats. This would be unwanted additional call.","type":"integer","format":"int64","x-go-name":"Percent"},"primaryAuthEntityID":{"type":"string","x-go-name":"PrimaryAuthEntityID"},"primaryAuthEntityType":{"type":"string","x-go-name":"PrimaryAuthEntityType"},"productCustomerID":{"type":"integer","format":"int64","x-go-name":"ProductCustomerID"},"productID":{"type":"integer","format":"int32","x-go-name":"ProductID"},"requestParams":{"$ref":"#/components/schemas/JSONMap"},"resourceID":{"type":"integer","format":"int64","x-go-name":"ResourceID"},"resourceName":{"type":"string","x-go-name":"ResourceName"},"resourceType":{"type":"string","x-go-name":"ResourceType"},"retryCount":{"type":"integer","format":"int64","x-go-name":"RetryCount"},"retryEnabled":{"type":"boolean","x-go-name":"RetryEnabled"},"retryWaitinterval":{"type":"integer","format":"int64","x-go-name":"RetryWaitinterval"},"scheduleEventID":{"type":"string","x-go-name":"ScheduleEventID"},"scheduleID":{"type":"string","x-go-name":"ScheduleID"},"secondaryAuthEntityID":{"type":"string","x-go-name":"SecondaryAuthEntityID"},"secondaryAuthEntityType":{"type":"string","x-go-name":"SecondaryAuthEntityType"},"startedTS":{"type":"integer","format":"int64","x-go-name":"StartedTS"},"state":{"type":"string","x-go-name":"State"},"stateID":{"type":"integer","format":"int32","x-go-name":"StateID"},"stateLabel":{"type":"string","x-go-name":"StateLabel"},"targetID":{"type":"integer","format":"int64","x-go-name":"TargetID"},"targetName":{"type":"string","x-go-name":"TargetName"},"targetType":{"type":"string","x-go-name":"TargetType"},"updatedTS":{"type":"integer","format":"int64","x-go-name":"UpdatedTS"},"windowEndTS":{"type":"integer","format":"int64","x-go-name":"WindowEndTS"},"workloadName":{"description":"WorkloadName is consumer WorkloadName","type":"string","x-go-name":"WorkloadName"}},"x-go-package":"git.druva.org/foundation/jobmgmt/job/spec"},"RWCConfig":{"description":"RWCConfig struct","type":"object","properties":{"continueIrrespectiveOfSnapshotState":{"type":"boolean","x-go-name":"ContinueIrrespectiveOfSnapshotState"},"doRWC":{"type":"boolean","x-go-name":"DoRWC"}},"x-go-package":"git.druva.org/foundation/jobmgmt/haydn/spec/enterpriseworkload/restore/base"},"OracleDTCBackupNowRequestParams":{"description":"OracleDTCBackupNowRequestParams is the input to the BackupNow job request","type":"object","properties":{"backupType":{"description":"Specify the type of backup. Set this parameter to one of the following values: FULL, INCR, LOG.","type":"string","enum":["FULL","INCR","LOG"],"x-go-name":"BackupType"},"backupsetID":{"description":"Specify the ID of your backup set. Get the ID of your backup set using the 'List all backup sets' API.","type":"integer","format":"int32","x-go-name":"BackupsetID"}},"x-go-package":"phoenix/oraclesbt/cloud/configserver/spec/job"},"OracleDTCBackupNowResponse":{"description":"OracleDTCBackupNowResponse is the response to the BackupNow job request","type":"object","properties":{"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"}},"x-go-package":"phoenix/oraclesbt/cloud/configserver/spec/job"},"OracleDTCCancelJobResponse":{"description":"OracleDTCCancelJobResponse is response to cancel job API","type":"object","properties":{"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"CancelledJobID"}},"x-go-package":"phoenix/oraclesbt/cloud/configserver/spec/job"},"OracleDTCCancellationParams":{"description":"OracleDTCCancellationParams is job cancellation request inputs","type":"object","properties":{"jobID":{"description":"Specify the ID of the job that you want to cancel. Get the ID of the job using the 'List all jobs' API.","type":"integer","format":"int32","x-go-name":"JobID"}},"x-go-package":"phoenix/oraclesbt/cloud/configserver/spec/job"},"OracleDTCGetSnapshotsResponse":{"description":"OracleDTCGetSnapshotsResponse is the response schema for List all snapshots API","type":"object","properties":{"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"NextPageToken"},"snapshots":{"type":"array","items":{"$ref":"#/components/schemas/OracleDTCSnapshot"},"x-go-name":"OracleDTCSnapshot"}},"x-go-package":"phoenix/oraclesbt/cloud/configserver/spec/backupset"},"OracleDTCRestoreOriginalParams":{"description":"OracleDTCRestoreOriginalParams is the restore to original job request inputs.","type":"object","properties":{"backupsetID":{"description":"Specify the ID of your backup set. Get the ID of your backup set using the 'List all backup sets' API.","type":"integer","format":"int32","x-go-name":"BackupsetID"},"cancelRunningJob":{"description":"Specify if you want to cancel the ongoing backup jobs running on the database.","type":"boolean","x-go-name":"CancelRunningJob"},"restoreWallet":{"description":"Specify if you want to restore the wallet files present (if any) in the snapshot mentioned.","type":"boolean","x-go-name":"RestoreWallet"},"rmanChannels":{"description":"Specify the number of RMAN Channels to use for restore. You cannot provide more than 32 RMAN Channels.","type":"integer","format":"int32","x-go-name":"RmanChannels"},"snapshotName":{"description":"Specify the name of the snapshot. Get the name of the snapshot using the 'List all snapshots' API.","type":"string","x-go-name":"SnapshotName"}},"x-go-package":"phoenix/oraclesbt/cloud/configserver/spec/job"},"OracleDTCRestoreOriginalResponse":{"description":"OracleDTCRestoreOriginalResponse is response to the Restore to original job request.","type":"object","properties":{"jobID":{"description":"The unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"}},"x-go-name":"RestoreOriginalResponse","x-go-package":"phoenix/oraclesbt/cloud/configserver/spec/job"},"OracleDTCSnapshot":{"description":"OracleDTCSnapshot struct holds the response for List all snapshots API","type":"object","properties":{"createdAt":{"description":"The creation date and time of the snapshot.","type":"string","x-go-name":"SnapshotCreationTime"},"isWalletBackedUp":{"description":"The value is set to TRUE if the wallet files are backed up in the snapshot.","type":"boolean","x-go-name":"IsWalletBackedUp"},"name":{"description":"The name of the snapshot.","type":"string","x-go-name":"SnapshotName"},"snapshotType":{"description":"The type of the snapshot. The snapshot type can be \"HOT\", \"WARM\", or \"COLD\".","type":"string","x-go-name":"SnapshotType"}},"x-go-package":"phoenix/oraclesbt/cloud/configserver/spec/backupset"},"SQLBackupNowRequestParams":{"description":"SQLBackupNowRequestParams is the input to the BackupNow job request","type":"object","properties":{"backupType":{"description":"Specify the type of backup. Set this parameter to one of the following values: FULL, DIFF, LOG.","type":"string","enum":["FULL","DIFF","LOG"],"x-go-name":"BackupType"},"backupsetID":{"description":"Specify the ID of your backup set. Get the ID using the 'List backup sets' API.","type":"integer","format":"int32","x-go-name":"BackupsetID"}},"x-go-package":"phoenix/sqlserver/cloud/configserver/spec/job"},"SQLBackupNowResponse":{"description":"SQLBackupNowResponse is the response to the BackupNow job request","type":"object","properties":{"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"}},"x-go-package":"phoenix/sqlserver/cloud/configserver/spec/job"},"SQLCancelJobResponse":{"description":"SQLCancelJobResponse is response to cancel job API","type":"object","properties":{"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"CancelledJobID"}},"x-go-package":"phoenix/sqlserver/cloud/configserver/spec/job"},"SQLCancellationParams":{"description":"SQLCancellationParams is job cancellation request inputs","type":"object","properties":{"jobID":{"description":"Specify the ID of the job that you want to cancel. Get the ID of the job using the 'List all jobs' API.","type":"integer","format":"int32","x-go-name":"JobID"}},"x-go-package":"phoenix/sqlserver/cloud/configserver/spec/job"},"SQLConfiguredDatabases":{"description":"The list of databases configured with the backup set.","type":"object","properties":{"createdAt":{"description":"The creation date and time of the database.","type":"string","x-go-name":"DBCreationTime"},"databaseName":{"description":"The name of the database.","type":"string","x-go-name":"DBName"},"isReadOnlyMode":{"description":"The value is set to TRUE if the database is in Read-Only mode, else it is set to FALSE.","type":"boolean","x-go-name":"IsReadonlyDB"}},"x-go-name":"Databases","x-go-package":"_/root/dcloud/phoenix_cloud/code/sqlserver/cloud/configserver/spec/backupset"},"RestorePath":{"type":"object","title":"RestorePath for the database files","properties":{"filePath":{"description":"Specify the file path for downloading database files on the restore location. The same path is used for ldf, mdf and ndf files. Skip this field if you want to specify separate paths for these files.","type":"string","x-go-name":"FilePath"},"ldfPath":{"description":"Specify the file path for downloading ldf file on the restore location.","type":"string","x-go-name":"LDFPath"},"mdfPath":{"description":"Specify the file path for downloading mdf file on the restore location.","type":"string","x-go-name":"MDFPath"},"ndfPath":{"description":"Specify the file path for downloading ndf file on the restore location.","type":"string","x-go-name":"NDFPath"}},"x-go-package":"phoenix/sqlserver/cloud/configserver/spec/job"},"SQLRestoreToAlternateParams":{"description":"SQLRestoreToAlternateParams is restore to alternate job request inputs","type":"object","required":["backupsetID","databases","targetResourceName","targetResourceType","fileRestorePath","snapshotName"],"properties":{"backupsetID":{"description":"Specify the ID of the backup set that you want to restore. Get the ID using the 'List backup sets' API.","type":"integer","format":"int32","x-go-name":"BackupsetID"},"customDBName":{"description":"Specify the name for the restored database. If you skip this field, the database name created will be rst_.","type":"string","x-go-name":"CustomDBName"},"databases":{"$ref":"#/components/schemas/JSONStringList"},"fileRestorePath":{"$ref":"#/components/schemas/RestorePath"},"pitEpoch":{"description":"Specify the point in time till which restore has to be triggered in the Unix Epoch format, such as 31536000.","type":"integer","format":"int64","x-go-name":"PointInTime"},"sharedNetworkLocation":{"description":"This field is required for restoring databases to an Availability Group. Specify the path of the shared network location where the availability group is located.","type":"string","x-go-name":"SharedNetworkLocation"},"snapshotName":{"description":"Specify the name of the snapshot. Get the name of the snapshot using the 'List all snapshots' API.","type":"string","x-go-name":"RPName"},"targetResourceName":{"description":"Specify the name of the target resource. The target resource is either availability group or an instance.","type":"string","x-go-name":"TargetResourceName"},"targetResourceType":{"description":"Specify the target resource type. Enter 'ag' for an availability group or 'sa' for a standalone instance.","type":"string","x-go-name":"TargetResourceType"}},"x-go-package":"_/root/dcloud/phoenix_cloud/code/sqlserver/cloud/configserver/spec/job"},"SQLRestoreToOriginalParams":{"description":"SQLRestoreToOriginalParams is restore to original job request inputs","type":"object","required":["backupsetID","databases","snapshotName"],"properties":{"backupsetID":{"description":"Specify the ID of your backup set. Get the ID using the 'List backup sets' API.","type":"integer","format":"int32","x-go-name":"BackupsetID"},"databases":{"description":"Specify the list of database names you want to restore. Get the names of databases associated with a backup set from the 'configuredDatabases' section of the 'Get backup set details' API. ","type":"array","items":{"type":"string"},"x-go-name":"DBListForRestore"},"snapshotName":{"description":"Specify the name of the snapshot. Get the name of the snapshot using the 'List all snapshots' API.","type":"string","x-go-name":"RPName"}},"x-go-package":"_/root/dcloud/phoenix_cloud/code/sqlserver/cloud/configserver/spec/job"},"SQLSnapshot":{"description":"Contains the response parameters for the ListSnapshot API.","type":"object","properties":{"createdAt":{"description":"The creation date and time of the snapshot.","type":"string","x-go-name":"RPCreationTime"},"name":{"description":"The name of the snapshot.","type":"string","x-go-name":"RPName"},"snapshotType":{"description":"The type of the snapshot. The possible values for the snapshot type are: \"HOT\", \"WARM\", or \"COLD\".","type":"string","x-go-name":"RPType"}},"x-go-name":"RPDict","x-go-package":"_/root/dcloud/phoenix_cloud/code/sqlserver/cloud/configserver/spec/backupset"},"SQLGetBackupsetDetailsResponse":{"description":"GetBackupsetDetailsResponse is the response schema for GetBackupsetDetails API","type":"object","properties":{"backupsetID":{"description":"The ID of the backup set.","type":"integer","format":"int32","x-go-name":"ID"},"backupsetName":{"description":"The name of the backup set.","type":"string","x-go-name":"Name"},"configuredDatabases":{"type":"array","items":{"$ref":"#/components/schemas/SQLConfiguredDatabases"},"x-go-name":"DBDetails"},"contentRuleID":{"type":"integer","format":"int32","x-go-name":"ContentRuleID"},"disableTimeStamp":{"description":"The date and time when the backup set was disabled.","type":"integer","format":"int32","x-go-name":"DisableTimeStamp"},"policyID":{"description":"The ID of the backup policy associated with the backup set.","type":"integer","format":"int32","x-go-name":"BackupPolicyID"},"storageCsetID":{"description":"The ID of the storage cset associated with the backup set.","type":"integer","format":"int32","x-go-name":"StorageCSetID"},"storageID":{"description":"The ID of the storage associated with the backup set.","type":"integer","format":"int32","x-go-name":"StorageID"}},"x-go-name":"GetBackupsetDetailsResponse","x-go-package":"_/root/dcloud/phoenix_cloud/code/sqlserver/cloud/configserver/spec/backupset"},"SQLListSnapshotResponse":{"description":"ListSnapshotResponse is the response schema for ListSnapshot API","type":"object","properties":{"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"NextPageToken"},"snapshots":{"type":"array","items":{"$ref":"#/components/schemas/SQLSnapshot"},"x-go-name":"RPs"}},"x-go-name":"ListSnapshotResponse","x-go-package":"_/root/dcloud/phoenix_cloud/code/sqlserver/cloud/configserver/spec/backupset"},"SQLRestoreToAlternateInstanceResponse":{"description":"The unique identification number associated with the job.","type":"object","properties":{"jobID":{"description":"TA unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"}},"x-go-name":"RestoreToAlternateInstanceResponse","x-go-package":"_/root/dcloud/phoenix_cloud/code/sqlserver/cloud/configserver/spec/job"},"SQLRestoreToOriginalInstanceResponse":{"description":"The unique identification number associated with the job.","type":"object","properties":{"jobID":{"description":"The unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"}},"x-go-name":"RestoreToOriginalInstanceResponse","x-go-package":"_/root/dcloud/phoenix_cloud/code/sqlserver/cloud/configserver/spec/job"},"VMBackupNowRequestParams":{"description":"VMBackupNowRequestParams is backup job request inputs","type":"object","properties":{"vmID":{"description":"The ID of the virtual machine. Get the ID of the virtual machine using the 'List all backup sets' VMware API","type":"integer","format":"int32","x-go-name":"VMID"}},"x-go-package":"phoenix/vmware/cloud/configserver/spec/job"},"VMBackupNowResponse":{"description":"VMBackupNowResponse is response to backupnow request","type":"object","properties":{"jobID":{"description":"The unique identification number associated with the job. ","type":"integer","format":"int32","x-go-name":"JobID"}},"x-go-package":"phoenix/vmware/cloud/configserver/spec/job"},"VMCancelJobResponse":{"description":"VMCancelJobResponse is response to cancel job API","type":"object","properties":{"jobID":{"description":"A unique identification number associated with the canceled job if the job is successfully canceled. This parameter will be 0 if the job completed, completed with errors, was canceled, or failed before it could be canceled.","type":"integer","format":"int32","x-go-name":"CancelledJobID"}},"x-go-package":"phoenix/vmware/cloud/configserver/spec/job"},"VMCancellationParams":{"description":"VMCancellationParams is job cancellation request inputs","type":"object","properties":{"jobID":{"description":"Specify the ID of the job to be canceled. Get the ID of the job using the 'List all jobs' VMware API.","type":"integer","format":"int32","x-go-name":"JobID"}},"x-go-package":"phoenix/vmware/cloud/configserver/spec/job"},"DRPlan":{"type":"object","title":"DRPlan ...","properties":{"awsAccountID":{"description":"The AWS account ID of the DR Plan","type":"string","x-go-name":"AWSAccountID"},"drPlanID":{"description":"The ID of the DR Plan","type":"integer","format":"int32","x-go-name":"ID"},"healthStatus":{"$ref":"#/components/schemas/HealthStatus"},"name":{"description":"The name of the DR Plan","type":"string","x-go-name":"DRPlanName"},"region":{"description":"The region of the DR Plan","type":"string","x-go-name":"Region"},"vmCount":{"description":"The count of VMs associated with the DR Plan","type":"integer","format":"int32","x-go-name":"VMCount"}},"x-go-package":"phoenix/draas/cloud/configserver/spec/drplan"},"FailoverJobResponse":{"description":"FailoverJobResponse is response to failover request","type":"object","properties":{"jobID":{"description":"Job ID for successfully triggered failover job","type":"integer","format":"int32","x-go-name":"JobID"}},"x-go-package":"phoenix/draas/cloud/configserver/spec/drjob"},"FailoverRequestParams":{"description":"FailoverRequestParams are all the user inputs required for a failover job request","type":"object","required":["drPlanID","failoverType"],"properties":{"drPlanID":{"description":"The DR Plan ID for which a failover needs to be initiated. Get the ID of the DR Plan using the 'List all DR Plans' API.","type":"integer","format":"int32","x-go-name":"DRPlanID"},"failoverType":{"description":"Set 'failoverType' to 1 to run a Test DR Failover job and 2 to run a Production DR failover job.","type":"integer","format":"int32","x-go-name":"FailoverType"}},"x-go-package":"phoenix/draas/cloud/configserver/spec/drjob"},"HealthStatus":{"type":"object","title":"HealthStatus ...","properties":{"failoverCheckStatus":{"description":"The status representing the failover checks.\n1: Success\n2: In-progress\n3: Failure\n4: Warning\n5: Not-initiated","type":"integer","format":"int32","x-go-name":"FailoverCheckStatus"},"latestValidationTimestamp":{"description":"The epoch timestamp of last successful failover check execution","type":"integer","format":"int32","x-go-name":"LatestValidationTimestamp"}},"x-go-package":"phoenix/draas/cloud/configserver/spec/drplan"},"ListResponse":{"description":"ListResponse is the response schema for List DR Plans","type":"object","properties":{"drPlans":{"description":"List of DRPlans","type":"array","items":{"$ref":"#/components/schemas/DRPlan"},"x-go-name":"DRPlanList"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-package":"phoenix/draas/cloud/configserver/spec/drplan"},"ServiceError":{"description":"Service Error","type":"object","title":"ServiceError represents an error with an associated error code.","properties":{"code":{"type":"integer","format":"int64","x-go-name":"Code","description":"Error Code"},"message":{"type":"string","description":"Application specific error message"}},"x-go-package":"vendor/druva.com/godevkit/errortype"},"FSBackupContentStruct":{"type":"object","title":"BackupContentStruct : Details of the content rule.","properties":{"excludeExtension":{"description":"The list of file types that are excluded from the backup. You can select pre-defined file types that you want to exclude from the backup.","type":"array","items":{"type":"string"},"x-go-name":"ExcludeExtension"},"excludeFolders":{"description":"The list of folders that are excluded from the backup. See Folders excluded from File server backup.","type":"array","items":{"type":"string"},"x-go-name":"ExcludeFolders"},"excludePattern":{"description":"The list of file extensions that are excluded in the backup.","type":"array","items":{"type":"string"},"x-go-name":"ExcludePattern"},"excludeType":{"description":"The list of file types that are excluded from the backup. You can select pre-defined file types that you want to exclude from the backup.","type":"array","items":{"type":"string"},"x-go-name":"ExcludeType"},"includeExtension":{"description":"The list of file extensions that are included in the backup.","type":"array","items":{"type":"string"},"x-go-name":"IncludeExtension"},"includeFolders":{"description":"List of folders/directories included in the backup operation.","type":"array","items":{"type":"string"},"x-go-name":"IncludeFolders"},"includePattern":{"description":"The list of file patterns that are included in the backup.","type":"array","items":{"type":"string"},"x-go-name":"IncludePattern"},"includeType":{"description":"The list of file types that are included in the backup. You can select pre-defined file types that you want to include in the backup. See File types supported for backup.","type":"array","items":{"type":"string"},"x-go-name":"IncludeType"},"isCaseInsensitive":{"description":"The status of the case insensitivity flag.","type":"boolean","x-go-name":"IsCaseInsensitive"}},"x-go-name":"BackupContentStruct","x-go-package":"phoenix/fileserver/cloud/report/spec/contentrules"},"FSBackupsetInfo":{"type":"object","title":"BackupsetInfo : Details of the backup set.","properties":{"backupContent":{"$ref":"#/components/schemas/FSRuleStruct1"},"backupEnabled":{"description":"Specifies whether the backup is enabled for the backup set.","type":"boolean","x-go-name":"BackupEnabled"},"backupPolicyID":{"description":"The ID of your backup policy.","format":"int64","type":"integer","x-go-name":"BackupPolicyID"},"backupPolicyName":{"description":"Name of the backup policy attached to the backup set.","type":"string","x-go-name":"BackupPolicyName"},"backupsetID":{"description":"The ID of your backup set.","format":"int32","type":"integer","x-go-name":"BackupsetID"},"backupsetName":{"description":"The name of the backup set.","type":"string","x-go-name":"BackupsetName"},"dataLock":{"description":"The status indicating if Data Lock is enabled for the backup set","type":"boolean","x-go-name":"Immutability"},"lastBackupDetails":{"$ref":"#/components/schemas/FSLastBackupDetailsStruct"},"organizationID":{"description":"The ID of your organization.","format":"int32","type":"integer","x-go-name":"OrgID"},"ltrEnabled":{"description":"The status of the backup set whether enabled for long term retention. For example, True denotes that the backup set is enabled for LTR.","type":"boolean","x-go-name":"LTREnabled"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"serverName":{"description":"The name of the Windows/Linux server.","type":"string","x-go-name":"ServerName"},"storageName":{"description":"The name of the storage.","type":"string","x-go-name":"StorageName"},"warmTierDuration":{"description":"Lists the duration in days for which the snapshot will reside in the warm tier of the AWS storage.","type":"integer","format":"int32","x-go-name":"WarmTierDuration"}},"x-go-name":"BackupsetInfo","x-go-package":"phoenix/fileserver/cloud/report/spec/backupsets"},"FSDataTransferStruct":{"type":"object","title":"DataTransferStruct : Data transfer details of the job.","properties":{"backupDuration":{"description":"Specifies the total time taken to upload data to the Cloud and CloudCache. Backup duration excludes the estimation time, network retry time, and the waiting for retry time.","type":"string","x-go-name":"BackupDuration"},"backupDurationInSeconds":{"description":"Specifies the total time taken in seconds to upload data to the Cloud and CloudCache. Backup duration excludes the estimation time, network retry time, and the waiting for retry time.","type":"integer","format":"int64","x-go-name":"BackupDurationInSeconds"},"backupSpeed":{"description":"Specifies the rate at which the source data is backed up to the Cloud.","type":"string","x-go-name":"BackupSpeed"},"backupSpeedInKBps":{"description":"Specifies the rate in Kilobytes per second at which the source data is backed up to the Cloud.","type":"number","format":"double","x-go-name":"BackupSpeedInKBps"},"bandwidthConsumed":{"description":"Specifies the bit rate to transfer data from the Cloud and CloudCache.","type":"string","x-go-name":"BandwidthConsumed"},"bandwidthConsumedInKBps":{"description":"Specifies the bit rate in Kilobytes per second to transfer data from the Cloud and CloudCache.","type":"number","format":"double","x-go-name":"BandwidthConsumedInKBps"},"dataTransferCache":{"description":"Specifies the incremental data that is uploaded to CloudCache after deduplication and compression.","type":"string","x-go-name":"DataTransferCache"},"dataTransferCacheInBytes":{"description":"Specifies the incremental data in bytes that is uploaded to CloudCache after deduplication and compression.","type":"integer","format":"uint64","x-go-name":"DataTransferCacheInBytes"},"dataTransferCloud":{"description":"Specifies the incremental data that is uploaded to the Cloud after deduplication and compression.","type":"string","x-go-name":"DataTransferCloud"},"dataTransferCloudInBytes":{"description":"Specifies the incremental data in bytes that is uploaded to the Cloud after deduplication and compression.","type":"integer","format":"uint64","x-go-name":"DataTransferCloudInBytes"}},"x-go-name":"DataTransferStruct","x-go-package":"phoenix/fileserver/cloud/report/spec/jobs"},"FSEnvironmentStruct":{"type":"object","title":"EnvironmentStruct : Environment details of the job.","properties":{"diskReadRate":{"description":"Specifies the bit rate for reading I/O by the agent. The Disk Read Rate is an average of the total data read with respect to the total time taken to read data at various intervals for all drives where data is distributed.","type":"string","x-go-name":"DiskReadRate"},"diskReadRateInKBps":{"description":"Specifies the bit rate in Kilobytes per second for reading I/O by the agent. The Disk Read Rate is an average of the total data read with respect to the total time taken to read data at various intervals for all drives where data is distributed.","type":"number","format":"double","x-go-name":"DiskReadRateInKBps"},"networkRetries":{"description":"Number of retries during the job due to network issues.","type":"integer","format":"int32","x-go-name":"NetworkRetries"},"networkRetryDuration":{"description":"Specifies the total time spent in the network retries. It represents the cumulative of all network session duration.","type":"string","x-go-name":"NetworkRetryDuration"},"networkRetryDurationInSeconds":{"description":"Specifies the total time spent in seconds in the network retries. It represents the cumulative of all network session duration.","type":"integer","format":"int64","x-go-name":"NetworkRetryDurationInSeconds"}},"x-go-name":"EnvironmentStruct","x-go-package":"phoenix/fileserver/cloud/report/spec/jobs"},"FSEstimationDetailsStruct":{"type":"object","title":"EstimationDetailsStruct : Estimation phase details of the job.","properties":{"estimationTimeTaken":{"description":"Specifies the approximate time taken to scan the data.","type":"string","x-go-name":"EstimationTimeTaken"},"estimationTimeTakenInSeconds":{"description":"Specifies the approximate time taken in seconds to scan the data.","type":"integer","format":"int64","x-go-name":"EstimationTimeTakenInSeconds"},"fileSizeDistribution":{"description":"File size distribution of the files backed up during the job.","type":"object","additionalProperties":{"type":"string"},"x-go-name":"FileSizeDistribution"},"filesAdded":{"description":"Number of files added at source during the job.","type":"integer","format":"int64","x-go-name":"FilesAdded"},"filesChanged":{"description":"Number of files changed at source during the job.","type":"integer","format":"int64","x-go-name":"FilesChanged"},"filesRemoved":{"description":"Number of files removed at source during the job.","type":"integer","format":"int64","x-go-name":"FilesRemoved"},"filesScanned":{"description":"Number of files scanned at source during the job.","type":"integer","format":"int64","x-go-name":"FilesScanned"},"sourceDataScanned":{"description":"Specifies the data scanned at the source in order to backup.","type":"string","x-go-name":"SourceDataScanned"},"sourceDataScannedInBytes":{"description":"Specifies the data scanned in bytes at the source in order to backup.","type":"integer","format":"uint64","x-go-name":"SourceDataScannedInBytes"}},"x-go-name":"EstimationDetailsStruct","x-go-package":"phoenix/fileserver/cloud/report/spec/jobs"},"FSExecutionDetailsStruct":{"type":"object","title":"ExecutionDetailsStruct : Execution details of the job.","properties":{"endTime":{"description":"The time when the job completes. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"Specifies the error code for the failed jobs. The possible values are:\n\\\"0\\\": If the job is successful\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"Specifies the error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"postScriptStatus":{"description":"Post-script execution status of the job.","type":"string","enum":["Successful"," Failed"," Skipped"," Not enabled"," N/A"],"x-go-name":"PostScriptStatus"},"preScriptStatus":{"description":"Pre-script execution status of the job.","type":"string","enum":["Successful"," Failed"," Skipped"," Not enabled"," N/A"],"x-go-name":"PreScriptStatus"},"scanMode":{"description":"Scanning mode of the job.","type":"string","enum":["Smart"," Full"],"x-go-name":"ScanMode"},"scheduleTime":{"description":"The date and time when the job starts or is scheduled to start. The time is specified in UTC in the format YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"ScheduleTime"},"startTime":{"description":"The time when the job starts. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"Status of the job.","type":"string","enum":["Queued","Running","Successful","Successful with errors","Failed"],"x-go-name":"Status"}},"x-go-name":"ExecutionDetailsStruct","x-go-package":"phoenix/fileserver/cloud/report/spec/jobs"},"FSFullScanSchedule":{"type":"object","title":"FullScanSchedule : Full scan schedule info for the backup.","properties":{"bandwidth":{"description":"Specifies the bandwidth that each resource can consume while backing up data to the Cloud.","type":"string","x-go-name":"Bandwidth"},"bandwidthInKBps":{"description":"Specifies the bandwidth in Kilobytes per second that each resource can consume while backing up data to the Cloud.","type":"number","format":"double","x-go-name":"BandwidthInKBps"},"duration":{"description":"Specifies the duration after which you want backup operations to stop.","type":"string","x-go-name":"Duration"},"durationInSeconds":{"description":"Specifies the duration in seconds after which you want backup operations to stop.","type":"integer","format":"int64","x-go-name":"DurationInSeconds"},"repeatOn":{"$ref":"#/components/schemas/JSONStringList"},"scanSchedule":{"description":"The schedule of the scan.","type":"string","x-go-name":"NoOfWeeks"},"startAt":{"description":"The start hour of the backup operation.","type":"string","x-go-name":"StartAt"}},"x-go-name":"FullScanSchedule","x-go-package":"phoenix/fileserver/cloud/report/spec/policies"},"FSGetAllJobsReport":{"description":"GetAllJobsReport struct holds the response for GetAllJobsReport api","type":"object","properties":{"backupContent":{"$ref":"#/components/schemas/FSRuleStruct1"},"endTime":{"description":"The time when the job completes. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"Specifies the error code for the failed jobs. The possible values are:\n\\\"0\\\": If the job is successful\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"Specifies the error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"The type of the job.","type":"string","enum":["Backup","Restore","Log Request"],"x-go-name":"JobType"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"scheduleTime":{"description":"The date and time when the job starts or is scheduled to start. The time is specified in UTC in the format YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"ScheduleTime"},"serverName":{"description":"The name of Windows/Linux server.","type":"string","x-go-name":"SourceDeviceName"},"startTime":{"description":"The time when the job starts. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"Status of the job.","type":"string","enum":["Queued","Running","Successful","Successful with errors","Failed"],"x-go-name":"Status"}},"x-go-name":"GetAllJobsReport","x-go-package":"phoenix/fileserver/cloud/report/spec/jobs"},"FSGetAllJobsReportResponse":{"description":"GetAllJobsReportResponse is the response schema for GetAllJobsReport","type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/FSGetAllJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetAllJobsReportResponse","x-go-package":"phoenix/fileserver/cloud/report/spec/jobs"},"FSGetBackupJobReportResponse":{"description":"GetBackupJobReportResponse is the response schema for GetBackupJobReport","type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/FSGetBackupJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetBackupJobReportResponse","x-go-package":"phoenix/fileserver/cloud/report/spec/jobs"},"FSGetBackupJobsReport":{"description":"GetBackupJobsReport struct holds the response for GetBackupJobsReport api","type":"object","properties":{"backupContent":{"$ref":"#/components/schemas/FSRuleStruct1"},"backupPolicyID":{"description":"The ID of your backup policy.","format":"int64","type":"integer","x-go-name":"BackupPolicyID"},"backupPolicyName":{"description":"The name of the backup policy.","type":"string","x-go-name":"BackupPolicyName"},"backupsetID":{"description":"The ID of your backup set.","format":"int32","type":"integer","x-go-name":"BackupsetID"},"dataTransfer":{"$ref":"#/components/schemas/FSDataTransferStruct"},"environmentDetails":{"$ref":"#/components/schemas/FSEnvironmentStruct"},"estimationDetails":{"$ref":"#/components/schemas/FSEstimationDetailsStruct"},"executionDetails":{"$ref":"#/components/schemas/FSExecutionDetailsStruct"},"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"The type of the job.","type":"string","enum":["Backup","Restore","Log Request"],"x-go-name":"JobType"},"organizationID":{"description":"The ID of your organization.","format":"int32","type":"integer","x-go-name":"OrgID"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"serverName":{"description":"The name of Windows/Linux server.","type":"string","x-go-name":"SourceDeviceName"}},"x-go-name":"GetBackupJobsReport","x-go-package":"phoenix/fileserver/cloud/report/spec/jobs"},"FSGetBackupsetsResponse":{"description":"GetBackupsetsResponse is response schema for GetBackupsets","type":"object","properties":{"backupsets":{"type":"array","items":{"$ref":"#/components/schemas/FSBackupsetInfo"},"x-go-name":"Backupsets"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetBackupsetsResponse","x-go-package":"phoenix/fileserver/cloud/report/spec/backupsets"},"FSGetContentRulesResponse":{"description":"GetContentRulesResponse is response schema for GetContentRules","type":"object","properties":{"contentRules":{"type":"array","items":{"$ref":"#/components/schemas/FSRuleStruct"},"x-go-name":"ContentRules"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetContentRulesResponse","x-go-package":"phoenix/fileserver/cloud/report/spec/contentrules"},"FSGetPoliciesResponse":{"description":"GetPoliciesResponse is response schema for GetPolicies","type":"object","properties":{"policies":{"type":"array","items":{"$ref":"#/components/schemas/FSGetPolicies"},"x-go-name":"Policies"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetPoliciesResponse","x-go-package":"phoenix/fileserver/cloud/report/spec/policies"},"FSGetPolicies":{"description":"GetPolicies struct holds the response for GetPolicies api","type":"object","properties":{"aclFlag":{"description":"Whether ACL flag scan is enabled. This parameter will be skipped if the value is NULL.","type":"boolean","x-go-name":"ACLFlag"},"age":{"description":"If ScanMode is SmartScan, the number of days upto which files updated are to be backed up. This parameter will be skipped if the value is NULL.","type":"string","x-go-name":"Age"},"automaticRetry":{"description":"Whether automatic retry is enabled.","type":"boolean","x-go-name":"AutomaticRetry"},"dataLock":{"description":"The status indicating if Data Lock is enabled in the backup policy","type":"boolean","x-go-name":"Immutability"},"description":{"description":"Description of the policy.","type":"string","x-go-name":"Description"},"fullScanSchedule":{"$ref":"#/components/schemas/FSFullScanSchedule"},"ignoreFirstBackupDuration":{"description":"Whether backup duration is to be ignored for first backup.","type":"boolean","x-go-name":"IgnoreBackupDuration"},"maxRetryCount":{"description":"Maximum retry count for job operation. This parameter will be skipped if the value is NULL.","type":"integer","format":"int64","x-go-name":"MaxRetryCount"},"maxRetryDuration":{"description":"Specifies the wait interval before the job is retried.","type":"string","x-go-name":"MaxRetryDuration"},"maxRetryDurationInSeconds":{"description":"Specifies the wait interval in seconds before the job is retried.","type":"integer","format":"int64","x-go-name":"MaxRetryDurationInSeconds"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"policyID":{"description":"The ID of your backup policy.","type":"integer","format":"int64","x-go-name":"PolicyID"},"policyName":{"description":"Name of the policy.","type":"string","x-go-name":"PolicyName"},"policyType":{"description":"Type of the policy.","type":"string","enum":["Files"],"x-go-name":"PolicyType"},"prePostScript":{"$ref":"#/components/schemas/FSPrePostScriptDetails"},"retention":{"$ref":"#/components/schemas/FSRetentionPolicy"},"scanMode":{"description":"Scan mode of the policy.","type":"string","enum":["Smart","Full"],"x-go-name":"ScanMode"},"schedules":{"description":"Schedule info for the backup. This parameter will be skipped if the value is NULL.","type":"array","items":{"$ref":"#/components/schemas/FSSchedules"},"x-go-name":"Schedules"}},"x-go-name":"GetPolicies","x-go-package":"phoenix/fileserver/cloud/report/spec/policies"},"FSPrePostScriptDetails":{"type":"object","title":"PrePostScriptDetails : Pre-/post-script details for backup operation.","properties":{"prePostScriptLocationLinux":{"description":"Location of pre-/post-scripts on Linux servers","type":"string","x-go-name":"LocationOnLinux"},"prePostScriptLocationWindows":{"description":"Location for pre/post scripts on Windows servers","type":"string","x-go-name":"LocationOnWindows"},"scriptTimeout":{"description":"Specifies the time limit for the execution of pre scripts and post scripts.","type":"string","x-go-name":"ScriptTimeout"},"scriptTimeoutInSeconds":{"description":"Specifies the time limit in seconds for the execution of pre scripts and post scripts.","type":"integer","format":"int64","x-go-name":"ScriptTimeoutInSeconds"},"skipBackupForPreScriptFails":{"description":"Specifies whether the backup operation is skipped on pre-script execution failure.","type":"boolean","x-go-name":"SkipBackupForPreScriptFails"},"skipBackupForPreScriptMissing":{"description":"Specifies whether the backup operation is skipped in case of pre-script missing.","type":"boolean","x-go-name":"SkipBackupForPreScriptMissing"}},"x-go-name":"PrePostScriptDetails","x-go-package":"phoenix/fileserver/cloud/report/spec/policies"},"FSGetRestoreJobReportResponse":{"description":"GetRestoreJobReportResponse is the response schema for GetRestoreJobReport","type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/FSGetRestoreJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetRestoreJobReportResponse","x-go-package":"phoenix/fileserver/cloud/report/spec/jobs"},"FSGetRestoreJobsReport":{"description":"GetRestoreJobsReport struct holds the response for GetRestoreJobsReport api","type":"object","properties":{"backupContent":{"$ref":"#/components/schemas/FSRuleStruct1"},"backupsetID":{"description":"The ID of your backup set.","format":"int32","type":"integer","x-go-name":"BackupsetID"},"destinationServerName":{"description":"Name of the Windows/Linux server to which the restore was initiated.","type":"string","x-go-name":"DestinationServerName"},"environmentDetails":{"$ref":"#/components/schemas/FSRestoreEnvironmentStruct"},"executionDetails":{"$ref":"#/components/schemas/FSRestoreExecutionDetailsStruct"},"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"Type of the job.","type":"string","enum":["Backup","Restore","Log Request"],"x-go-name":"JobType"},"organizationID":{"description":"The ID of your organization.","format":"int32","type":"integer","x-go-name":"OrgID"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"serverName":{"description":"Name of the Windows/Linux server on which the backup was initiated.","type":"string","x-go-name":"SourceDeviceName"}},"x-go-name":"GetRestoreJobsReport","x-go-package":"phoenix/fileserver/cloud/report/spec/jobs"},"FSGetUploadLogJobReportResponse":{"description":"GetUploadLogJobReportResponse is the response schema for GetUploadLogJobReport","type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/FSGetUploadLogJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetUploadLogJobReportResponse","x-go-package":"phoenix/fileserver/cloud/report/spec/jobs"},"FSGetUploadLogJobsReport":{"description":"GetUploadLogJobsReport struct holds the response for GetUploadLogJobsReport api","type":"object","properties":{"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32"},"executionDetails":{"$ref":"#/components/schemas/FSUploadLogExecDetailsStruct"},"jobType":{"description":"Type of the job.","type":"string","enum":["Backup","Restore","Log Request"],"x-go-name":"JobType"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"serverName":{"description":"Name of the Windows/Linux server on which the backup was initiated.","type":"string","x-go-name":"SourceDeviceName"}},"x-go-name":"GetUploadLogJobsReport","x-go-package":"phoenix/fileserver/cloud/report/spec/jobs"},"FSLastBackupDetailsStruct":{"type":"object","title":"LastBackupDetailsStruct : Details of last backup job.","properties":{"jobID":{"description":"A unique identification number associated with the job. This parameter will be skipped if the value is NULL.","type":"integer","format":"int32","x-go-name":"JobID"},"status":{"description":"Status of the job. This parameter will be skipped if the value is NULL.","type":"string","x-go-name":"Status"}},"x-go-name":"LastBackupDetailsStruct","x-go-package":"phoenix/fileserver/cloud/report/spec/backupsets"},"FSListFileServerResponse":{"description":"ListFileServerResponse is the response schema for ListFileServer","type":"object","properties":{"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"},"servers":{"type":"array","items":{"$ref":"#/components/schemas/FSServerResponse"},"x-go-name":"Servers"}},"x-go-name":"ListFileServerResponse","x-go-package":"phoenix/fileserver/cloud/report/spec/servers"},"FSRestoreEnvironmentStruct":{"type":"object","title":"RestoreEnvironmentStruct : Environment details of the job.","properties":{"diskWriteRate":{"description":"Specifies the bit rate in for writing I/O by the agent. The Disk Write Rate is the average of the total data written with respect to the total time taken to write data at various intervals.","type":"string","x-go-name":"DiskWriteRate"},"diskWriteRateInKBps":{"description":"Specifies the bit rate in Kilobytes per second for writing I/O by the agent. The Disk Write Rate is the average of the total data written with respect to the total time taken to write data at various intervals.","type":"number","format":"double","x-go-name":"DiskWriteRateInKBps"},"networkRetries":{"description":"Number of retries during the job due to network issues.","type":"integer","format":"int32","x-go-name":"NetworkRetries"},"networkRetryDuration":{"description":"Specifies the total time spent in the network retries. It represents the cumulative of all network session duration.","type":"string","x-go-name":"NetworkRetryDuration"},"networkRetryDurationInSeconds":{"description":"Specifies the total time spent in seconds in the network retries. It represents the cumulative of all network session duration.","type":"integer","format":"int64","x-go-name":"NetworkRetryDurationInSeconds"}},"x-go-name":"RestoreEnvironmentStruct","x-go-package":"phoenix/fileserver/cloud/report/spec/jobs"},"FSRestoreExecutionDetailsStruct":{"type":"object","title":"RestoreExecutionDetailsStruct : Execution details of the job.","properties":{"bandwidthConsumed":{"description":"Specifies the bit to transfer data from the Cloud and CloudCache.","type":"string","x-go-name":"BandwidthConsumed"},"bandwidthConsumedInKBps":{"description":"Specifies the bit rate in Kilobytes per second to transfer data from the Cloud and CloudCache.","type":"number","format":"double","x-go-name":"BandwidthConsumedInKBps"},"errorCode":{"description":"Specifies the error code for the failed jobs. The possible values are:\n\\\"0\\\": If the job is successful\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"Specifies the error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"endTime":{"description":"The time when the job completes. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"fileSizeDistribution":{"description":"File size distribution of the files restored during the job.","type":"object","additionalProperties":{"type":"string"},"x-go-name":"FileSizeDistribution"},"restoredData":{"description":"Specifies the total amount of data restored.","type":"string","x-go-name":"RestoredData"},"restoredDataInBytes":{"description":"Specifies the total amount of data restored in bytes.","type":"integer","format":"uint64","x-go-name":"RestoredDataInBytes"},"restoredItems":{"description":"Files/folders restored on the server.","type":"string","x-go-name":"RestoredItems"},"scheduleTime":{"description":"The date and time when the job starts or is scheduled to start. The time is specified in UTC in the format YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"ScheduleTime"},"startTime":{"description":"The time when the job starts. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"Status of the job.","type":"string","enum":["Queued","Running","Successful","Successful with errors","Failed"],"x-go-name":"Status"}},"x-go-name":"RestoreExecutionDetailsStruct","x-go-package":"phoenix/fileserver/cloud/report/spec/jobs"},"FSRetentionPolicy":{"type":"object","title":"RetentionPolicy : Retention details for the backup set.","properties":{"daily":{"description":"The number of days for which daily backup restore points are to be retained.","type":"string","x-go-name":"Daily"},"monthly":{"description":"The number of months for which monthly backup restore points are to be retained.","type":"string","x-go-name":"Monthly"},"weekly":{"description":"The number of weeks for which weekly backup restore points are to be retained.","type":"string","x-go-name":"Weekly"},"yearly":{"description":"The number of years for which yearly backup restore points are to be retained.","type":"string","x-go-name":"Yearly"},"ltrEnabled":{"description":"The status of the backup set whether enabled for long term retention. For example, True denotes that the backup set is enabled for LTR.","type":"boolean","x-go-name":"LTREnabled"},"warmTierDuration":{"description":"Lists the duration in days for which the snapshot will reside in the warm tier of the AWS storage.","type":"integer","format":"int32","x-go-name":"WarmTierDuration"}},"x-go-name":"RetentionPolicy","x-go-package":"phoenix/fileserver/cloud/report/spec/policies"},"FSRuleStruct":{"type":"object","title":"RuleStruct : The data that is backed up on a server.","properties":{"backupContent":{"$ref":"#/components/schemas/FSBackupContentStruct"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName","x-omitempty":true},"ruleName":{"description":"Name of the content rule.","type":"string","x-go-name":"RuleName"}},"x-go-name":"RuleStruct","x-go-package":"phoenix/fileserver/cloud/report/spec/contentrules"},"FSRuleStruct1":{"type":"object","title":"RuleStruct : The data that is backed up on a server.","properties":{"backupContent":{"$ref":"#/components/schemas/FSBackupContentStruct"},"ruleName":{"description":"Name of the content rule.","type":"string","x-go-name":"RuleName"}},"x-go-name":"RuleStruct","x-go-package":"phoenix/fileserver/cloud/report/spec/contentrules"},"FSSchedules":{"type":"object","title":"Schedules : Schedule info for the backup.","properties":{"bandwidth":{"description":"Specifies the bandwidth that each resource can consume while backing up data to the Cloud.","type":"string","x-go-name":"Bandwidth"},"bandwidthInKBps":{"description":"Specifies the bandwidth in Kilobytes per second that each resource can consume while backing up data to the Cloud.","type":"number","format":"double","x-go-name":"BandwidthInKBps"},"duration":{"description":"Specifies the duration after which you want backup operations to stop.","type":"string","x-go-name":"Duration"},"durationInSeconds":{"description":"Specifies the duration in seconds after which you want backup operations to stop.","type":"integer","format":"int64","x-go-name":"DurationInSeconds"},"repeatOn":{"$ref":"#/components/schemas/JSONStringList"},"startAt":{"description":"The start hour of the backup operation.","type":"string","x-go-name":"StartAt"}},"x-go-name":"Schedules","x-go-package":"phoenix/fileserver/cloud/report/spec/policies"},"FSServerResponse":{"description":"ServerResponse is the response part of the schema for ListFileServer","type":"object","properties":{"activationTime":{"description":"The time at which the Windows/Linux server was activated for Enterprise Workloads.","type":"string","x-go-name":"ActivationTime"},"configuredForFile":{"description":"Specifies whether the Windows/Linux server is configured for backup of files.","type":"boolean","x-go-name":"ConfiguredForFile"},"organizationName":{"description":"The name of the organization the Windows/Linux server is part of.","type":"string","x-go-name":"OrganizationName"},"platform":{"description":"The platform the Windows/Linux server.","type":"string","x-go-name":"Platform"},"resourceGroupName":{"description":"The name of the resource group the Windows/Linux server is part of.","type":"string","x-go-name":"GroupName"},"serverConnectionStatus":{"description":"The connection status of the Windows/Linux server.","type":"boolean","x-go-name":"IsServerConnected"},"serverName":{"description":"The name of the Windows/Linux server.","type":"string","x-go-name":"ServerName"},"version":{"description":"The version the Windows/Linux server.","type":"string","x-go-name":"Version"}},"x-go-name":"ServerResponse","x-go-package":"phoenix/fileserver/cloud/report/spec/servers"},"FSUploadLogExecDetailsStruct":{"type":"object","title":"UploadLogExecDetailsStruct : Execution details of the job.","properties":{"endTime":{"description":"The time when the job completes. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"Specifies the error code for the failed jobs. The possible values are:\n\\\"0\\\": If the job is successful\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"Specifies the error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"logsExpiryTime":{"description":"Expiry time of the uploaded logs. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"LogsExpiryTime"},"logsSize":{"description":"Specifies the size of the extracted log files.","type":"string","x-go-name":"LogsSize"},"logsSizeInBytes":{"description":"Specifies the size of the extracted log files in bytes.","type":"integer","format":"uint64","x-go-name":"LogsSizeInBytes"},"scheduleTime":{"description":"The date and time when the job starts or is scheduled to start. The time is specified in UTC in the format YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"ScheduleTime"},"sourceJobID":{"description":"The ID of the job for which logs are being requested.","type":"integer","format":"int32","x-go-name":"SourceJobID"},"sourceJobType":{"description":"The job type for which logs are being requested.","type":"string","x-go-name":"SourceJobLogType"},"startTime":{"description":"The time when the job starts. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"Status of the job.","type":"string","enum":["Queued","Running","Successful","Successful with errors","Failed"],"x-go-name":"Status"}},"x-go-name":"UploadLogExecDetailsStruct","x-go-package":"phoenix/fileserver/cloud/report/spec/jobs"},"FSGetSnapshotsResponse":{"description":"FSGetSnapshotsResponse is the response schema for GetSnapshotsResponse","type":"object","properties":{"snapshots":{"type":"array","items":{"$ref":"#/components/schemas/FSSnapshot"},"x-go-name":"RPs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"NextPageToken"}},"x-go-name":"GetSnapshotsResponse","x-go-package":"fileserver/cloud/configserver/spec/backupset"},"FSSnapshot":{"description":"FSSnapshot struct holds the response for GetSnapshots API","type":"object","properties":{"name":{"description":"The name of the snapshot.","type":"string","x-go-name":"RPName"},"snapshotType":{"description":"The type of snapshot. The possible values for the snapshot type are: \"HOT\", \"WARM\", and \"COLD\".","type":"string","x-go-name":"RPType"},"createdAt":{"description":"The creation date and time of the snapshot.","type":"string","x-go-name":"RPCreationTime"}},"x-go-name":"RPDict","x-go-package":"fileserver/cloud/configserver/spec/backupset"},"FSBackupNowRequestParams":{"description":"FSBackupNowRequestParams request parameters for backup now","type":"object","properties":{"backupsetID":{"description":"Specify the ID of the backup set. Get the ID using the 'List backup sets' API.","type":"integer","format":"int32","x-go-name":"BackupsetID"}},"x-go-package":"phoenix/fileserver/cloud/configserver/spec/job"},"FSBackupNowResponse":{"description":"FSBackupNowResponse response schema for backup now","type":"object","properties":{"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"}},"x-go-package":"phoenix/fileserver/cloud/configserver/spec/job"},"FSOriginalRestoreParams":{"description":"FSOriginalRestoreParams request parameters for original restore","type":"object","properties":{"backupsetID":{"description":"Specify the ID of the backup set. Get the ID using the 'List backup sets' API.","type":"integer","format":"int32","x-go-name":"BackupsetID"},"snapshotName":{"description":"Specify the name of the snapshot. Get the name of the snapshot using the 'List all snapshots' API.","type":"string","x-go-name":"SnapshotName"},"sourcePath":{"description":"Specify the path to the file or folder in the snapshot, which needs to be restored.","type":"string","x-go-name":"SourcePath"},"isOriginalLocationRestore":{"description":"Specify if the restore location is original or custom.","type":"boolean","x-go-name":"IsOriginalLocationRestore"},"destinationPath":{"description":"Path of the folder where files will be restored.","type":"string","x-go-name":"DestinationPath"},"fileHandlingOption":{"description":"Specify the option to restore files. The possible values are \"overwrite\", \"skip\", \"restoreAndMoveOriginal\", or \"overwriteOlder\".","type":"string","x-go-name":"FileHandlingOption"},"preserveOriginalDirectoryStructure":{"description":"Specify whether you want to preserve the original directory structure. The possible values are \"True\" or \"False\".","type":"boolean","x-go-name":"PreserveOriginalDirectoryStructure"}},"x-go-package":"phoenix/fileserver/cloud/configserver/spec/job"},"FSRestoreResponse":{"description":"FSRestoreResponse response schema for restore","type":"object","properties":{"jobIDs":{"description":"The unique identification number associated with the job.","type":"array","items":{"type":"integer","format":"int32"},"x-go-name":"JobIDs"}},"x-go-package":"phoenix/fileserver/cloud/configserver/spec/job"},"FSAlternateRestoreParams":{"description":"FSAlternateRestoreParams request parameters for alternate restore","type":"object","properties":{"backupsetID":{"description":"Specify the ID of the backup set. Get the ID using the 'List backup sets' API.","type":"integer","format":"int32","x-go-name":"BackupsetID"},"snapshotName":{"description":"Specify the name of the snapshot. Get the name of the snapshot using the 'List all snapshots' API.","type":"string","x-go-name":"SnapshotName"},"sourcePath":{"description":"Specify the path to the file or folder in the snapshot, which needs to be restored.","type":"string","x-go-name":"SourcePath"},"destinationDeviceID":{"description":"ID of the device where the restore will happen.","type":"integer","format":"int32","x-go-name":"DestinationDeviceID"},"destinationPath":{"description":"Path of the folder where files will be restored.","type":"string","x-go-name":"DestinationPath"},"fileHandlingOption":{"description":"Specify the option to restore files. The possible values are \"overwrite\", \"skip\", \"restoreAndMoveOriginal\", or \"overwriteOlder\".","type":"string","x-go-name":"FileHandlingOption"},"preserveOriginalDirectoryStructure":{"description":"Specify whether you want to preserve the original directory structure. The possible values are \"True\" or \"False\".","type":"boolean","x-go-name":"PreserveOriginalDirectoryStructure"}},"x-go-package":"phoenix/fileserver/cloud/configserver/spec/job"},"FSCancelJobParams":{"description":"FSCancelJobParams Request parameters for cancel job","type":"object","required":["jobID"],"properties":{"jobID":{"type":"integer","format":"int32","x-go-name":"JobID","description":"Specify the ID of the job that you want to cancel. Get the ID of the job using the 'List all jobs' API."}},"x-go-package":"phoenix/fileserver/cloud/configserver/spec/job"},"FSCancelJobResponse":{"description":"FSCancelJobResponse is response to cancel job request","type":"object","properties":{"jobID":{"type":"integer","format":"int32","x-go-name":"JobID","description":"The unique identification number associated with the job. The job ID is:
0: If the job is not successfully canceled.
: If the job was successfully canceled.
: If the job is already completed, completed with errors, was canceled, or failed before it could be canceled."}},"x-go-package":"phoenix/fileserver/cloud/configserver/spec/job"},"GetAllJobsReportRequest":{"description":"GetAllJobsReportRequest is the request schema for GetAllJobsReport","type":"object","required":["OrgID"],"properties":{"fromTime":{"description":"Specify the date and time to filter jobs that were run after the specified timestamp. Specify the date and time in UTC format and must be greater than the value of (current time - 6 months). The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"string","format":"date-time","x-go-name":"StartTime"},"jobType":{"description":"The type of the job. This parameter can be set to one or more of the following values: Backup, Restore and Log Request. Specify multiple job types by separating them with commas.\nin: query","type":"array","items":{"type":"integer","format":"int32"},"x-go-name":"JobType"},"OrgID":{"description":"Organization ID of your organization. Set it to \"0\" to select all organizations.\nin: path","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"},"serverName":{"description":"The name of the Windows/Linux server for which the job is initiated. Specify multiple server names by separating them with commas.\nin: query","type":"array","items":{"type":"string"},"x-go-name":"ServerName"},"sortOrder":{"description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.\nin: query","type":"string","x-go-name":"SortOrder"},"status":{"description":"Status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.\nin: query","type":"array","items":{"type":"integer","format":"int32"},"x-go-name":"Status"},"toTime":{"description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"string","format":"date-time","x-go-name":"EndTime"}},"x-go-package":"phoenix/fileserver/cloud/report/spec/jobs"},"GetBackupJobReportRequest":{"description":"GetBackupJobReportRequest is the request schema for GetBackupJobReport","type":"object","required":["OrgID"],"properties":{"fromTime":{"description":"Specify the date and time to filter jobs that were run after the specified timestamp. Specify the date and time in UTC format and must be greater than the value of (current time - 6 months). The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"string","format":"date-time","x-go-name":"StartTime"},"OrgID":{"description":"Organization ID of your organization. Set it to \"0\" to select all organizations.\nin: path","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"},"serverName":{"description":"The name of the Windows/Linux server for which the job is initiated. Specify multiple server names by separating them with commas.\nin: query","type":"array","items":{"type":"string"},"x-go-name":"ServerName"},"sortOrder":{"description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.\nin: query","type":"string","x-go-name":"SortOrder"},"status":{"description":"Status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.\nin: query","type":"array","items":{"type":"integer","format":"int32"},"x-go-name":"Status"},"toTime":{"description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"string","format":"date-time","x-go-name":"EndTime"}},"x-go-package":"phoenix/fileserver/cloud/report/spec/jobs"},"GetBackupsetsRequest":{"description":"GetBackupsetsRequest is request schema for GetBackupsets","type":"object","required":["OrgID"],"properties":{"backupEnable":{"type":"boolean"},"OrgID":{"description":"Organization ID of your organization. Set it to \"0\" to select all organizations\nin: path","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"},"serverName":{"description":"The name of the Windows/Linux server. Specify multiple server names by separating them with commas.\nin: query","type":"array","items":{"type":"string"},"x-go-name":"ServerName"}},"x-go-package":"phoenix/fileserver/cloud/report/spec/backupsets"},"GetContentRulesRequest":{"description":"GetContentRulesRequest is request schema for GetContentRules","type":"object","required":["OrgID"],"properties":{"OrgID":{"description":"Organization ID of your organization. Set it to \"0\" to select all organizations.\nin: path","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"}},"x-go-package":"phoenix/fileserver/cloud/report/spec/contentrules"},"GetDefreezeJobReportRequest":{"description":"GetDefreezeJobReportRequest is the request schema for GetDefreezeJobReport","type":"object","required":["OrgID"],"properties":{"fromTime":{"description":"Specify the date and time to filter jobs that were run after the specified timestamp. Specify the date and time in UTC format and must be greater than the value of (current time - 6 months). The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"string","format":"date-time","x-go-name":"StartTime"},"OrgID":{"description":"Organization ID of your organization. Set it to \"0\" to select all organizations.\nin: path","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"},"serverName":{"description":"The name of the Windows/Linux server for which the job is initiated. Specify multiple server names by separating them with commas.\nin: query","type":"array","items":{"type":"string"},"x-go-name":"ServerName"},"sortOrder":{"description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.\nin: query","type":"string","x-go-name":"SortOrder"},"status":{"description":"Status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.\nin: query","type":"array","items":{"type":"integer","format":"int32"},"x-go-name":"Status"},"toTime":{"description":"Specify a time to filter jobs that were run after it. The time should be specified in the UTC format and must be lesser than the current date. The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"integer","format":"int64","x-go-name":"EndTime"}},"x-go-package":"phoenix/fileserver/cloud/report/spec/jobs"},"GetPoliciesRequest":{"description":"GetPoliciesRequest is request schema for GetPolicies","type":"object","required":["OrgID"],"properties":{"OrgID":{"description":"Organization ID of your organization. Set it to \"0\" to select all organizations\nin: path","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request\nin: query","type":"string","x-go-name":"PageToken"}},"x-go-package":"phoenix/fileserver/cloud/report/spec/policies"},"GetRestoreJobReportRequest":{"description":"GetRestoreJobReportRequest is the request schema for GetRestoreJobReport","type":"object","required":["OrgID"],"properties":{"destServerName":{"description":"The name of the Windows/Linux server to which the restore job is initiated. Specify multiple server names by separating them with commas.\nin: query","type":"array","items":{"type":"string"},"x-go-name":"DestServerName"},"fromTime":{"description":"Specify a time to filter jobs that were run before it. The time should be specified in the UTC format and must be greater than the value of (current time - 6 months). The format of this parameter is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"string","format":"date-time","x-go-name":"StartTime"},"OrgID":{"description":"Organization ID of your organization. Set it to \"0\" to select all organizations.\nin: path","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"},"sortOrder":{"description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.\nin: query","type":"string","x-go-name":"SortOrder"},"sourceServerName":{"description":"The name of the Windows/Linux server from which the backup job is initiated. Specify multiple server names by separating them with commas.\nin: query","type":"array","items":{"type":"string"},"x-go-name":"SourceServerName"},"status":{"description":"Status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.\nin: query","type":"array","items":{"type":"integer","format":"int32"},"x-go-name":"Status"},"toTime":{"description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"integer","format":"int64","x-go-name":"EndTime"}},"x-go-package":"phoenix/fileserver/cloud/report/spec/jobs"},"GetUploadLogJobReportRequest":{"description":"GetUploadLogJobReportRequest is the request schema for GetUploadLogJobReport","type":"object","required":["OrgID"],"properties":{"fromTime":{"description":"Specify the date and time to filter jobs that were run after the specified timestamp. Specify the date and time in UTC format and must be greater than the value of (current time - 6 months). The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"string","format":"date-time","x-go-name":"StartTime"},"OrgID":{"description":"Organization ID of your organization. Set it to \"0\" to select all organizations.\nin: path","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"},"serverName":{"description":"The name of the Windows/Linux server for which the job is initiated. Specify multiple server names by separating them with commas.\nin: query","type":"array","items":{"type":"string"},"x-go-name":"ServerName"},"sortOrder":{"description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.\nin: query","type":"string","x-go-name":"SortOrder"},"status":{"description":"Status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.\nin: query","type":"array","items":{"type":"integer","format":"int32"},"x-go-name":"Status"},"toTime":{"description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"integer","format":"int64","x-go-name":"EndTime"}},"x-go-package":"phoenix/fileserver/cloud/report/spec/jobs"},"JSONStringList":{"description":"JSONStringList is data type to be used in model definition for data that is string:interface map in memory but stored as JSON string in DB","type":"array","items":{"type":"string"},"x-go-package":"phoenix/pkg/dlutil"},"ListContentRuleResponse":{"description":"ListContentRuleResponse represents response model","type":"object","properties":{"ContentRuleMap":{}},"x-go-package":"phoenix/fileserver/cloud/report/spec/contentrules"},"ListContentRulesFilter":{"description":"ListContentRulesFilter is filter structure to be passed while listing contentrules","type":"object","properties":{"IDs":{"type":"array","items":{"type":"integer","format":"int64"}}},"x-go-package":"phoenix/fileserver/cloud/report/spec/contentrules"},"ListFileServerRequest":{"description":"ListFileServerRequest is the request schema for ListFileServer","type":"object","required":["OrgID"],"properties":{"OrgID":{"description":"Organization ID of your organization. Set it to \"0\" to select all organizations.\nin: path","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"},"serverName":{"description":"The name of the Windows/Linux server. Multiple server names can be separated with commas.\nin: query","type":"array","items":{"type":"string"},"x-go-name":"ServerName"}},"x-go-package":"phoenix/fileserver/cloud/report/spec/servers"},"ListPoliciesFilter":{"description":"ListPoliciesFilter is filter structure to be passed while listing policies","type":"object","properties":{"IDs":{"type":"array","items":{"type":"integer","format":"int64"}}},"x-go-package":"phoenix/fileserver/cloud/report/spec/policies"},"ListPoliciesResponse":{"description":"ListPoliciesResponse represents response model","type":"object","properties":{"PolicyMap":{}},"x-go-package":"phoenix/fileserver/cloud/report/spec/policies"},"AuditResponse":{"description":"AuditResponse struct holds the response for ListAuditTrail api","type":"object","properties":{"action":{"description":"Action performed by the administrator.","type":"string","x-go-name":"Action"},"actionTime":{"description":"The time of the action.","type":"string","x-go-name":"ActionTime"},"adminEmail":{"description":"Email of the administrator who performed the action.","type":"string","x-go-name":"AdminEmail"},"entityName":{"description":"Entity for which the action is performed.","type":"string","x-go-name":"EntityName"},"entityType":{"description":"Type of the entity.","type":"string","x-go-name":"EntityType"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrganizationName"},"resourceType":{"description":"Type of the resource.","type":"string","x-go-name":"ResourceType"}},"x-go-package":"phoenix/audittrail/report/spec"},"CacheConfigResponse":{"description":"CacheConfigResponse is the response schema for Cache config","type":"object","properties":{"cacheServerInfo":{"$ref":"#/components/schemas/CacheDeviceResponse"},"cloudFallback":{"description":"The status that indicates whether you selected an option to back up to the cloud is unable to back up to the CloudCache.","type":"boolean","x-go-name":"CloudFallback"},"name":{"description":"The name of the cloudcache.","type":"string","x-go-name":"Name"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrganizationName"},"schedules":{"description":"List of cloudcache sync schedule info.","type":"array","items":{"$ref":"#/components/schemas/CacheScheduleResponse"},"x-go-name":"Schedules"},"state":{"description":"The current state of cloudcache.","type":"string","x-go-name":"State"},"volumes":{"description":"List of cloudcache volume info.","type":"array","items":{"$ref":"#/components/schemas/CacheVolumeResponse"},"x-go-name":"Volumes"}},"x-go-package":"phoenix/cloudcache/cloud/report/spec/config"},"CacheDeviceResponse":{"description":"CacheDeviceResponse is the response schema for Device","type":"object","properties":{"activationTime":{"description":"The activation time of the cloudcache.","type":"string","x-go-name":"ActivationTime"},"cacheVersion":{"description":"The version of the cloudcache build currently installed on the cloudcache server.","type":"string","x-go-name":"Version"},"fqdn":{"description":"The FQDN of the cloudcache server.","type":"string","x-go-name":"FQDN"},"isUpgradable":{"description":"The status of the cloudcache build that indicates wheather it is upgradable or not.","type":"boolean","x-go-name":"IsUpgradable"},"lastUpgradeTime":{"description":"The time indicates the last upgrade of the cloudcache server build.","type":"string","x-go-name":"LastUpgradeTime"},"os":{"description":"The OS type of the cloudcache server.","type":"string","x-go-name":"OS"},"osVersion":{"description":"The OS version of the cloudcache server.","type":"string","x-go-name":"OSVersion"},"timezone":{"description":"The timezone of the cloudcache server.","type":"string","x-go-name":"Timezone"}},"x-go-package":"phoenix/cloudcache/cloud/report/spec/config"},"CacheScheduleResponse":{"description":"CacheScheduleResponse is the response schema for CacheSchedule","type":"object","properties":{"bandwidth":{"description":"Specifies the bandwidth that each resource can consume while backing up data to the CloudCache.","type":"integer","format":"int32","x-go-name":"Bandwidth"},"bandwidthInKBps":{"description":"Specifies the bandwidth in Kilobytes per second that each resource can consume while backing up data to the CloudCache.","type":"number","format":"double","x-go-name":"BandwidthInKBps"},"bandwidthUnit":{"description":"The unit of the bandwidth.","type":"string","x-go-name":"Unit"},"daysOfWeek":{"description":"List of days, this sync schedule will run.","type":"array","items":{"type":"string"},"x-go-name":"DaysOfWeek"},"scheduleDuration":{"description":"Sync schedule time duration in Hrs.","type":"integer","format":"int32","x-go-name":"Duration"},"startTime":{"description":"It's start timing of cloudcahe sync schedule.","type":"string","x-go-name":"StartTime"}},"x-go-package":"phoenix/cloudcache/cloud/report/spec/config"},"CacheVolumeResponse":{"description":"CacheVolumeResponse is the response schema for CacheVolume","type":"object","properties":{"allocatedSize":{"description":"Specifies the maximum size of the CloudCache volume.","type":"string","x-go-name":"AllocatedSize"},"allocatedSizeInBytes":{"description":"Specifies the maximum size of the CloudCache volume in bytes.","type":"integer","format":"uint64","x-go-name":"AllocatedSizeInBytes"},"usedSize":{"description":"Specifies the size currently being used of the CloudCache volume.","type":"string","x-go-name":"UsedSize"},"usedSizeInBytes":{"description":"Specifies the size in bytes currently being used of the CloudCache volume.","type":"integer","format":"uint64","x-go-name":"UsedSizeInBytes"},"volumePath":{"description":"The volume path of the cloudcache volume on cloudcache server.","type":"string","x-go-name":"Path"}},"x-go-package":"phoenix/cloudcache/cloud/report/spec/config"},"GetAllCacheConfigResponse":{"description":"GetAllCacheConfigResponse is the response schema for GetAllCacheConfigResponse","type":"object","properties":{"cacheConfig":{"type":"array","items":{"$ref":"#/components/schemas/CacheConfigResponse"},"x-go-name":"CacheConfig"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-package":"phoenix/cloudcache/cloud/report/spec/config"},"GetAllCloudCacheConfigRequest":{"description":"GetAllCloudCacheConfigRequest is the request schema for GetAllCloudCacheConfig","type":"object","required":["OrgID"],"properties":{"cacheName":{"description":"Filter to retrive required cache/caches only. Multiple cache name can be separated by commas.\nin: query","type":"array","items":{"type":"string"},"x-go-name":"CacheName"},"OrgID":{"description":"The ID of the organization. Set it to \"0\" to select all organizations.\nin: path","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"},"state":{"description":"Filter to retrive configured or unconfigured cloudcache details.\nin: query","type":"integer","format":"int32","x-go-name":"State"}},"x-go-package":"phoenix/cloudcache/cloud/report/spec/config"},"GetStorageUsagePerOrganizationRequest":{"description":"GetStorageUsagePerOrganizationRequest is the request schema for GetStorageUsagePerOrganization","type":"object","required":["OrgID"],"properties":{"OrgID":{"description":"The ID of the organization. Set it to \"0\" to select all organizations.\nin: path","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"}},"x-go-package":"phoenix/storageconfig/report/spec"},"GetStorageUsagePerOrganizationResponse":{"description":"GetStorageUsagePerOrganizationResponse is the response schema for GetStorageUsagePerOrganization","type":"object","properties":{"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"},"storageUsage":{"type":"array","items":{"$ref":"#/components/schemas/OrgUsageResponse"},"x-go-name":"StorageUsage"}},"x-go-package":"phoenix/storageconfig/report/spec"},"ListStorageFilter":{"description":"ListStorageFilter is filter structure to be passed while listing storage","type":"object","properties":{"StorageIDs":{"type":"array","items":{"type":"integer","format":"int32"}},"StorageStates":{"type":"array","items":{"type":"integer","format":"int32"}}},"x-go-package":"phoenix/storageconfig/report/spec"},"ListStorageInfoResponse":{"description":"ListStorageInfoResponse represents response model","type":"object","properties":{"StorageMap":{}},"x-go-package":"phoenix/storageconfig/report/spec"},"ListAuditTrailRequest":{"description":"ListAuditTrailRequest is the request schema for ListAuditTrail","type":"object","required":["OrgID"],"properties":{"action":{"description":"Filter audit trails for specific action. Specify multiple action values by separating them with commas.\nin: query","type":"array","items":{"type":"string"},"x-go-name":"Action"},"adminEmail":{"description":"Filter audit trails for specific adminstrator email address. Specify multiple admintrators email addresses by separating them with commas.\nin: query","type":"array","items":{"type":"string"},"x-go-name":"AdminEmail"},"entityName":{"description":"Filter audit trails for specific entity name. Specify multiple entity name values by separating them with commas.\nin: query","type":"array","items":{"type":"string"},"x-go-name":"EntityName"},"entityType":{"description":"Filter audit trails for specific entity type. Specify multiple entity type values by separating them with commas.\nin: query","type":"array","items":{"type":"string"},"x-go-name":"EntityType"},"fromTime":{"description":"The start date and time from when the audit trail data has to be accessed. The time should be specified in the UTC format and must be lesser than the current date. The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"string","format":"date-time","x-go-name":"StartTime"},"OrgID":{"description":"The ID of the organization.\nin: path","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"},"resourceType":{"description":"Filter audit trails for specific resource type. Specify multiple resource type values by separating them with commas.\nin: query","type":"array","items":{"type":"string"},"x-go-name":"ResourceType"},"toTime":{"description":"The end date and time until when the audit trail data has to be accessed. The time should be specified in the UTC format and must be lesser than the current date. The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"integer","format":"int64","x-go-name":"EndTime"}},"x-go-package":"phoenix/audittrail/report/spec"},"ListAuditTrailResponse":{"description":"ListAuditTrailResponse is the response schema for ListAuditTrail","type":"object","properties":{"audits":{"type":"array","items":{"$ref":"#/components/schemas/AuditResponse"},"x-go-name":"Audits"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-package":"phoenix/audittrail/report/spec"},"ListOrgRequest":{"description":"ListOrgRequest is the request schema for ListOrg","type":"object","properties":{"pageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"}},"x-go-package":"phoenix/customerconfig/report/spec/site"},"ListOrgResponse":{"description":"ListOrgResponse is the response schema for ListOrg","type":"object","properties":{"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"},"orgs":{"type":"array","items":{"$ref":"#/components/schemas/OrgResponse"},"x-go-name":"Orgs"}},"x-go-package":"phoenix/customerconfig/report/spec/site"},"OrgResponse":{"description":"OrgResponse is the response schema for ListOrg","type":"object","properties":{"id":{"description":"The ID of the organization.","type":"integer","format":"int32","x-go-name":"ID"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrganizationName"}},"x-go-package":"phoenix/customerconfig/report/spec/site"},"OrgUsageResponse":{"description":"OrgUsageResponse is the response schema for storage usage per organization","type":"object","properties":{"currentSource":{"description":"Specifies the latest backup size of all resources in the organization.","type":"string","x-go-name":"CurrentSource"},"currentSourceInBytes":{"description":"Specifies the latest backup size of all resources in the organization in bytes.","type":"integer","format":"uint64","x-go-name":"CurrentSourceInBytes"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrganizationName"},"phoenixStorage":{"description":"Specifies the actual storage utilization of the organization.","type":"string","x-go-name":"PhoenixStorage"},"phoenixStorageInBytes":{"description":"Specifies the actual storage utilization of the organization in bytes.","type":"integer","format":"uint64","x-go-name":"PhoenixStorageInBytes"},"sourcePlusChanges":{"description":"Specifies the amount of data that was modified, added, or deleted at the source during incremental backups.","type":"string","x-go-name":"SourcePlusChanges"},"sourcePlusChangesInBytes":{"description":"Specifies the amount of data in bytes that was modified, added, or deleted at the source during incremental backups.","type":"integer","format":"uint64","x-go-name":"SourcePlusChangesInBytes"}},"x-go-package":"phoenix/storageconfig/report/spec"},"Snapshot":{"description":"Snapshot is schema for Snapshot entity","type":"object","properties":{"attributes":{"x-go-name":"Attributes"},"creationTime":{"type":"integer","format":"int64","x-go-name":"CreationTime"},"cver":{"type":"integer","format":"int32","x-go-name":"CVersion"},"ectime":{"type":"integer","format":"int32","x-go-name":"ECtime"},"filescurrent":{"type":"integer","format":"int32","x-go-name":"FilesCurrent"},"id":{"type":"string","x-go-name":"ID"},"isAnomalous":{"type":"boolean","x-go-name":"IsAnomalous"},"isLocked":{"type":"boolean","x-go-name":"IsLocked"},"isPinned":{"type":"boolean","x-go-name":"IsPinned"},"isQuarantined":{"type":"boolean","x-go-name":"IsQuarantined"},"isVirtual":{"type":"boolean","x-go-name":"IsVirtual"},"lsRPLckOwns":{"x-go-name":"LsRPLckOwns"},"name":{"type":"string","x-go-name":"Name"},"rpProperties":{"x-go-name":"RPProperties"},"size":{"type":"integer","format":"int64","x-go-name":"Size"},"snapshotTime":{"type":"integer","format":"int64","x-go-name":"SnapshotTime"},"snapshotType":{"type":"string","x-go-name":"Type"}},"x-go-package":"phoenix/storageconfig/configserver/spec/snapshot"},"ListSnapshotsResponse":{"description":"ListSnapshotsResponse is the response schema for List Snapshots API","type":"object","properties":{"nextPageToken":{"type":"string","x-go-name":"NextPageToken"},"snapshots":{"type":"array","items":{"$ref":"#/components/schemas/Snapshot"},"x-go-name":"Snapshots"}},"x-go-package":"phoenix/storageconfig/configserver/spec/snapshot"},"NASBackupContentStruct":{"description":"BackupContentStruct is response schema for GetContentRules","type":"object","properties":{"excludeExtension":{"description":"The list of file types that are excluded from the backup. You can select pre-defined file types that you want to exclude from the backup.","type":"array","items":{"type":"string"},"x-go-name":"ExcludeExtension"},"excludeFolders":{"description":"The list of folders that are excluded from the backup. See Folders excluded from File server backup.","type":"array","items":{"type":"string"},"x-go-name":"ExcludeFolders"},"excludePattern":{"description":"The list of file extensions that are excluded in the backup.","type":"array","items":{"type":"string"},"x-go-name":"ExcludePattern"},"excludeType":{"description":"The list of file types that are excluded from the backup. You can select pre-defined file types that you want to exclude from the backup.","type":"array","items":{"type":"string"},"x-go-name":"ExcludeType"},"includeExtension":{"description":"The list of file extensions that are included in the backup.","type":"array","items":{"type":"string"},"x-go-name":"IncludeExtension"},"includeFolders":{"description":"List of folders/directories included in the backup operation.","type":"array","items":{"type":"string"},"x-go-name":"IncludeFolders"},"includePattern":{"description":"The list of file patterns that are included in the backup.","type":"array","items":{"type":"string"},"x-go-name":"IncludePattern"},"includeType":{"description":"The list of file types that are included in the backup. You can select pre-defined file types that you want to include in the backup. See File types supported for backup.","type":"array","items":{"type":"string"},"x-go-name":"IncludeType"},"isCaseInsensitive":{"description":"The status of the case insensitivity flag.","type":"boolean","x-go-name":"IsCaseInsensitive"}},"x-go-name":"BackupContentStruct","x-go-package":"phoenix/nas/cloud/report/spec/contentrules"},"NASBackupsetInfo":{"description":"BackupsetInfo is response schema for GetBackupsets","type":"object","properties":{"backupContent":{"$ref":"#/components/schemas/NASRuleStruct"},"backupEnabled":{"description":"Specifies whether the backup is enabled for the backup set.","type":"boolean","x-go-name":"BackupEnabled"},"backupPolicyID":{"description":"The ID of your backup policy.","format":"int64","type":"integer","x-go-name":"BackupPolicyID"},"backupPolicyName":{"description":"Name of the backup policy attached to the backup set.","type":"string","x-go-name":"BackupPolicyName"},"backupsetID":{"description":"The ID of your backup set.","format":"int32","type":"integer","x-go-name":"BackupsetID"},"backupsetName":{"description":"The name of the backup set.","type":"string","x-go-name":"BackupsetName"},"dataLock":{"description":"The status indicating if Data Lock is enabled for the backup set","type":"boolean","x-go-name":"Immutability"},"hostName":{"description":"The name of NAS host/device.","type":"string","x-go-name":"HostName"},"lastBackupDetails":{"$ref":"#/components/schemas/NASLastBackupDetailsStruct"},"organizationID":{"description":"The ID of your organization.","format":"int32","type":"integer","x-go-name":"OrgID"},"ltrEnabled":{"description":"The status of the backup set whether enabled for long term retention. For example, True denotes that the backup set is enabled for LTR.","type":"boolean","x-go-name":"LTREnabled"},"organizationName":{"description":"The name of NAS organization.","type":"string","x-go-name":"OrgName"},"proxyName (deprecated)":{"description":"The name of NAS proxy. (This is deprecated)","type":"string","x-go-name":"ProxyName"},"poolName":{"description":"The name of NAS pool.","type":"string","x-go-name":"PoolName"},"shareID":{"description":"The ID of NAS share.","format":"int32","type":"integer","x-go-name":"ShareID"},"shareName":{"description":"The name of NAS share.","type":"string","x-go-name":"ShareName"},"storageName":{"description":"The name of the storage.","type":"string","x-go-name":"StorageName"},"warmTierDuration":{"description":"Lists the duration in days for which the snapshot will reside in the warm tier of the AWS storage.","type":"integer","format":"int32","x-go-name":"WarmTierDuration"}},"x-go-name":"BackupsetInfo","x-go-package":"phoenix/nas/cloud/report/spec/backupsets"},"NASDataTransferStruct":{"description":"DataTransferStruct struct holds the response for GetBackupJobsReport api","type":"object","properties":{"backupDuration":{"description":"Specifies the total time taken to upload data to the Cloud and CloudCache. Backup duration excludes the estimation time, network retry time, and the waiting for retry time.","type":"string","x-go-name":"BackupDuration"},"backupDurationInSeconds":{"description":"Specifies the total time taken in seconds to upload data to the Cloud and CloudCache. Backup duration excludes the estimation time, network retry time, and the waiting for retry time.","type":"integer","format":"int64","x-go-name":"BackupDurationInSeconds"},"backupSpeed":{"description":"Specifies the rate at which the source data is backed up to the Cloud.","type":"string","x-go-name":"BackupSpeed"},"backupSpeedInKBps":{"description":"Specifies the rate in Kilobytes per second at which the source data is backed up to the Cloud.","type":"number","format":"double","x-go-name":"BackupSpeedInKBps"},"bandwidthConsumed":{"description":"Specifies the bit rate to transfer data from the Cloud and CloudCache.","type":"string","x-go-name":"BandwidthConsumed"},"bandwidthConsumedInKBps":{"description":"Specifies the bit rate in Kilobytes per second to transfer data from the Cloud and CloudCache.","type":"number","format":"double","x-go-name":"BandwidthConsumedInKBps"},"dataTransferCache":{"description":"Specifies the incremental data that is uploaded to CloudCache after deduplication and compression.","type":"string","x-go-name":"DataTransferCache"},"dataTransferCacheInBytes":{"description":"Specifies the incremental data in bytes that is uploaded to CloudCache after deduplication and compression.","type":"integer","format":"uint64","x-go-name":"DataTransferCacheInBytes"},"dataTransferCloud":{"description":"Specifies the incremental data that is uploaded to the Cloud after deduplication and compression.","type":"string","x-go-name":"DataTransferCloud"},"dataTransferCloudInBytes":{"description":"Specifies the incremental data in bytes that is uploaded to the Cloud after deduplication and compression.","type":"integer","format":"uint64","x-go-name":"DataTransferCloudInBytes"}},"x-go-name":"DataTransferStruct","x-go-package":"phoenix/nas/cloud/report/spec/jobs"},"NASEnvironmentStruct":{"description":"EnvironmentStruct struct holds the response for GetBackupJobsReport api","type":"object","properties":{"diskReadRate":{"description":"Specifies the bit rate for reading I/O by the agent. The Disk Read Rate is an average of the total data read with respect to the total time taken to read data at various intervals for all drives where data is distributed.","type":"string","x-go-name":"DiskReadRate"},"diskReadRateInKBps":{"description":"Specifies the bit rate in Kilobytes per second for reading I/O by the agent. The Disk Read Rate is an average of the total data read with respect to the total time taken to read data at various intervals for all drives where data is distributed.","type":"number","format":"double","x-go-name":"DiskReadRateInKBps"},"networkRetries":{"description":"Number of retries during the job due to network issues.","type":"integer","format":"int32","x-go-name":"NetworkRetries"},"networkRetryDuration":{"description":"Specifies the total time spent in the network retries. It represents the cumulative of all network session duration.","type":"string","x-go-name":"NetworkRetryDuration"},"networkRetryDurationInSeconds":{"description":"Specifies the total time spent in seconds in the network retries. It represents the cumulative of all network session duration.","type":"integer","format":"int64","x-go-name":"NetworkRetryDurationInSeconds"}},"x-go-name":"EnvironmentStruct","x-go-package":"phoenix/nas/cloud/report/spec/jobs"},"NASEstimationDetailsStruct":{"description":"EstimationDetailsStruct struct holds the response for GetBackupJobsReport api","type":"object","properties":{"estimationTimeTaken":{"description":"Specifies the approximate time taken to scan the data.","type":"string","x-go-name":"EstimationTimeTaken"},"estimationTimeTakenInSeconds":{"description":"Specifies the approximate time taken in seconds to scan the data.","type":"integer","format":"int64","x-go-name":"EstimationTimeTakenInSeconds"},"fileSizeDistribution":{"description":"File size distribution of the files backed up during the job.","type":"object","additionalProperties":{"type":"string"},"x-go-name":"FileSizeDistribution"},"filesAdded":{"description":"Number of files added at source during the job.","type":"integer","format":"int64","x-go-name":"FilesAdded"},"filesChanged":{"description":"Number of files changed at source during the job.","type":"integer","format":"int64","x-go-name":"FilesChanged"},"filesRemoved":{"description":"Number of files removed at source during the job.","type":"integer","format":"int64","x-go-name":"FilesRemoved"},"filesScanned":{"description":"Number of files scanned at source during the job.","type":"integer","format":"int64","x-go-name":"FilesScanned"},"sourceDataScanned":{"description":"Specifies the data scanned in at the source in order to backup.","type":"string","x-go-name":"SourceDataScanned"},"sourceDataScannedInBytes":{"description":"Specifies the data scanned in bytes at the source in order to backup.","type":"integer","format":"uint64","x-go-name":"SourceDataScannedInBytes"}},"x-go-name":"EstimationDetailsStruct","x-go-package":"phoenix/nas/cloud/report/spec/jobs"},"NASExecutionDetailsStruct":{"description":"ExecutionDetailsStruct struct holds the response for GetBackupJobsReport api","type":"object","properties":{"endTime":{"description":"The time when the job operation completes. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"Specifies the error code for the failed jobs. The possible values are:\n \\\"0\\\": If the job is successful\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"Specifies the error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"scanMode":{"description":"Scanning mode of the job.","type":"string","x-go-name":"ScanMode"},"scheduleTime":{"description":"The date and time when the job starts or is scheduled to start. The time is specified in UTC in the format YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"ScheduleTime"},"startTime":{"description":"The time when the job operation starts. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"Status of the job.","type":"string","enum":["Queued","Running","Successful","Successful with errors","Failed"],"x-go-name":"Status"}},"x-go-name":"ExecutionDetailsStruct","x-go-package":"phoenix/nas/cloud/report/spec/jobs"},"NASFullScanSchedule":{"description":"FullScanSchedule struct holds the response for GetPolicies api","type":"object","properties":{"bandwidth":{"description":"Specifies the bandwidth that each resource can consume while backing up data to the Cloud.","type":"string","x-go-name":"Bandwidth"},"bandwidthInKBps":{"description":"Specifies the bandwidth in Kilobytes per second that each resource can consume while backing up data to the Cloud.","type":"number","format":"double","x-go-name":"BandwidthInKBps"},"duration":{"description":"Specifies the duration after which you want backup operations to stop.","type":"string","x-go-name":"Duration"},"durationInSeconds":{"description":"Specifies the duration in seconds after which you want backup operations to stop.","type":"integer","format":"int64","x-go-name":"DurationInSeconds"},"preferredDay":{"$ref":"#/components/schemas/JSONStringList"},"scanSchedule":{"description":"The schedule of the scan.","type":"string","x-go-name":"NoOfWeeks"},"startAt":{"description":"The start hour of the backup operation.","type":"string","x-go-name":"StartAt"}},"x-go-name":"FullScanSchedule","x-go-package":"phoenix/nas/cloud/report/spec/policies"},"NASGetAllJobsReport":{"description":"GetAllJobsReport struct holds the response for GetAllJobsReport api","type":"object","properties":{"backupContent":{"$ref":"#/components/schemas/NASRuleStruct"},"endTime":{"description":"The time when the job operation completes. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"Specifies the error code for the failed jobs. The possible values are:\n\\\"0\\\": If the job is successful\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"Specifies the error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"hostName":{"description":"The name of NAS host/device.","type":"string","x-go-name":"HostName"},"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"The type of the job.","type":"string","enum":["Backup","Restore","Log Request"],"x-go-name":"JobType"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"scheduleTime":{"description":"The date and time when the job starts or is scheduled to start. The time is specified in UTC in the format YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"ScheduleTime"},"proxyName":{"description":"The name of NAS proxy.","type":"string","x-go-name":"ProxyName"},"shareName":{"description":"The name of NAS share.","type":"string","x-go-name":"ShareName"},"startTime":{"description":"The time when the job operation starts. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"Status of the job.","type":"string","enum":["Queued","Running","Successful","Successful with errors","Failed"],"x-go-name":"Status"}},"x-go-name":"GetAllJobsReport","x-go-package":"phoenix/nas/cloud/report/spec/jobs"},"NASGetAllJobsReportResponse":{"description":"GetAllJobsReportResponse is the response schema for GetAllJobsReport","type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/NASGetAllJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetAllJobsReportResponse","x-go-package":"phoenix/nas/cloud/report/spec/jobs"},"NASGetBackupJobReportResponse":{"description":"GetBackupJobReportResponse is the response schema for GetBackupJobReport","type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/NASGetBackupJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetBackupJobReportResponse","x-go-package":"phoenix/nas/cloud/report/spec/jobs"},"NASGetBackupJobsReport":{"description":"GetBackupJobsReport struct holds the response for GetBackupJobsReport api","type":"object","properties":{"backupContent":{"$ref":"#/components/schemas/NASRuleStruct"},"backupPolicyID":{"description":"The ID of your backup policy.","format":"int32","type":"integer","x-go-name":"BackupPolicyID"},"backupPolicyName":{"description":"The name of the backup policy.","type":"string","x-go-name":"BackupPolicyName"},"backupsetID":{"description":"The ID of your backup set.","format":"int32","type":"integer","x-go-name":"BackupsetID"},"dataTransfer":{"$ref":"#/components/schemas/NASDataTransferStruct"},"environmentDetails":{"$ref":"#/components/schemas/NASEnvironmentStruct"},"estimationDetails":{"$ref":"#/components/schemas/NASEstimationDetailsStruct"},"executionDetails":{"$ref":"#/components/schemas/NASExecutionDetailsStruct"},"hostName":{"description":"The name of NAS host/device.","type":"string","x-go-name":"HostName"},"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"The type of the job.","type":"string","enum":["Backup","Restore","Log Request"],"x-go-name":"JobType"},"organizationID":{"description":"The ID of your organization.","format":"int32","type":"integer","x-go-name":"OrgID"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"proxyName":{"description":"The name of NAS proxy.","type":"string","x-go-name":"ProxyName"},"shareID":{"description":"The ID of NAS share.","format":"int32","type":"integer","x-go-name":"ShareID"},"shareName":{"description":"The name of NAS share.","type":"string","x-go-name":"ShareName"}},"x-go-name":"GetBackupJobsReport","x-go-package":"phoenix/nas/cloud/report/spec/jobs"},"NASGetBackupsetsResponse":{"description":"GetBackupsetsResponse is response schema for GetBackupsets","type":"object","properties":{"backupsets":{"type":"array","items":{"$ref":"#/components/schemas/NASBackupsetInfo"},"x-go-name":"Backupsets"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetBackupsetsResponse","x-go-package":"phoenix/nas/cloud/report/spec/backupsets"},"NASGetContentRulesResponse":{"description":"GetContentRulesResponse is response schema for GetContentRules","type":"object","properties":{"contentRules":{"type":"array","items":{"$ref":"#/components/schemas/NASRuleStruct"},"x-go-name":"ContentRules"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetContentRulesResponse","x-go-package":"phoenix/nas/cloud/report/spec/contentrules"},"NASGetPolicies":{"description":"GetPolicies struct holds the response for GetPolicies api","type":"object","properties":{"automaticRetry":{"description":"Whether automatic retry is enabled.","type":"boolean","x-go-name":"AutomaticRetry"},"dataLock":{"description":"The status indicating if Data Lock is enabled in the backup policy","type":"boolean","x-go-name":"Immutability"},"description":{"description":"Type of the policy.","type":"string","x-go-name":"Description"},"fullScanSchedule":{"$ref":"#/components/schemas/NASFullScanSchedule"},"ignoreFirstBackupDuration":{"description":"Whether backup duration is to be ignored for first backup.","type":"boolean","x-go-name":"IgnoreBackupDuration"},"maxRetryCount":{"description":"Maximum retry count for job operation.","type":"integer","format":"int64","x-go-name":"MaxRetryCount"},"maxRetryDuration":{"description":"Specifies the wait interval before the job is retried.","type":"string","x-go-name":"MaxRetryDuration"},"maxRetryDurationInSeconds":{"description":"Specifies the wait interval in seconds before the job is retried.","type":"integer","format":"int64","x-go-name":"MaxRetryDurationInSeconds"},"age":{"description":"If ScanMode is SmartScan, the number of days upto which files updated are to be backed up.","type":"string","x-go-name":"Age"},"organizationName":{"description":"Name of the organization.","type":"string","x-go-name":"OrgName"},"policyID":{"description":"The ID of your backup policy.","type":"integer","format":"int64","x-go-name":"PolicyID"},"policyName":{"description":"Name of the policy.","type":"string","x-go-name":"PolicyName"},"retention":{"$ref":"#/components/schemas/NASRetentionPolicy"},"scanMode":{"description":"Scan mode of the policy.","type":"string","x-go-name":"ScanMode"},"schedules":{"description":"Schedule info for the backup.","type":"array","items":{"$ref":"#/components/schemas/NASSchedules"},"x-go-name":"Schedules"},"aclFlag":{"description":"Whether ACL scan flag in enabled.","type":"boolean","x-go-name":"ACLFlag"}},"x-go-name":"GetPolicies","x-go-package":"phoenix/nas/cloud/report/spec/policies"},"NASGetPoliciesResponse":{"description":"GetPoliciesResponse is response schema for GetPolicies","type":"object","properties":{"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"},"policies":{"type":"array","items":{"$ref":"#/components/schemas/NASGetPolicies"},"x-go-name":"Policies"}},"x-go-name":"GetPoliciesResponse","x-go-package":"phoenix/nas/cloud/report/spec/policies"},"NASGetRestoreJobReportResponse":{"description":"GetRestoreJobReportResponse is the response schema for GetRestoreJobReport","type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/NASGetRestoreJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetRestoreJobReportResponse","x-go-package":"phoenix/nas/cloud/report/spec/jobs"},"NASGetRestoreJobsReport":{"description":"GetRestoreJobsReport struct holds the response for GetRestoreJobsReport api","type":"object","properties":{"backupContent":{"$ref":"#/components/schemas/NASRuleStruct"},"backupsetID":{"description":"The ID of your backup set.","format":"int32","type":"integer","x-go-name":"BackupsetID"},"destinationHostName":{"description":"Name of the NAS host to which the restore was initiated.","type":"string","x-go-name":"DestinationHostName"},"destinationProxyName":{"description":"Name of the NAS proxy which performed the restore.","type":"string","x-go-name":"DestinationProxyName"},"destinationShareName":{"description":"Name of the NAS share to which the restore was initiated.","type":"string","x-go-name":"DestinationShareName"},"environmentDetails":{"$ref":"#/components/schemas/NASRestoreEnvironmentStruct"},"executionDetails":{"$ref":"#/components/schemas/NASRestoreExecutionDetailsStruct"},"hostName":{"description":"The name of NAS host.","type":"string","x-go-name":"HostName"},"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"The type of the job.","type":"string","enum":["Backup","Restore","Log Request"],"x-go-name":"JobType"},"organizationID":{"description":"The ID of your organization.","format":"int32","type":"integer","x-go-name":"OrgID"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"proxyName":{"description":"The name of NAS proxy.","type":"string","x-go-name":"ProxyName"},"shareID":{"description":"The ID of NAS share.","format":"int32","type":"integer","x-go-name":"ShareID"},"shareName":{"description":"The name of NAS share.","type":"string","x-go-name":"ShareName"}},"x-go-name":"GetRestoreJobsReport","x-go-package":"phoenix/nas/cloud/report/spec/jobs"},"NASGetUploadLogJobReportResponse":{"description":"GetUploadLogJobReportResponse is the response schema for GetUploadLogJobReport","type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/NASGetUploadLogJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetUploadLogJobReportResponse","x-go-package":"phoenix/nas/cloud/report/spec/jobs"},"NASGetUploadLogJobsReport":{"description":"GetUploadLogJobsReport struct holds the response for GetUploadLogJobsReport api","type":"object","properties":{"executionDetails":{"$ref":"#/components/schemas/NASUploadLogExecDetailsStruct"},"hostName":{"description":"Name of the NAS host on which the backup was initiated.","type":"string","x-go-name":"SourceDeviceName"},"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"The type of the job.","type":"string","enum":["Backup","Restore","Log Request"],"x-go-name":"JobType"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"}},"x-go-name":"GetUploadLogJobsReport","x-go-package":"phoenix/nas/cloud/report/spec/jobs"},"NASHostResponse":{"description":"HostResponse is the response part of the schema for ListHost","type":"object","properties":{"description":{"description":"The description of NAS host.","type":"string","x-go-name":"Description"},"hostFQDN":{"description":"Fully qualified domain name of the NAS host.","type":"string","x-go-name":"NasDeviceFQDN"},"hostName":{"description":"The name of NAS host.","type":"string","x-go-name":"HostName"},"organizationName":{"description":"The name of organization.","type":"string","x-go-name":"OrganizationName"},"shares":{"type":"array","items":{"$ref":"#/components/schemas/NASShare"},"x-go-name":"Shares"}},"x-go-name":"HostResponse","x-go-package":"phoenix/nas/cloud/report/spec/hosts"},"NASLastBackupDetailsStruct":{"description":"LastBackupDetailsStruct is response schema for GetBackupsets","type":"object","properties":{"jobID":{"description":"A unique identification number associated with the job. This parameter will be skipped if the value is empty.","type":"integer","format":"int32","x-go-name":"JobID"},"status":{"description":"Status of the job. This parameter will be skipped if the value is empty.","type":"string","x-go-name":"Status"}},"x-go-name":"LastBackupDetailsStruct","x-go-package":"phoenix/nas/cloud/report/spec/backupsets"},"NASListHostResponse":{"description":"ListHostResponse is the response schema for ListHost","type":"object","properties":{"hosts":{"type":"array","items":{"$ref":"#/components/schemas/NASHostResponse"},"x-go-name":"Hosts"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"ListHostResponse","x-go-package":"phoenix/nas/cloud/report/spec/hosts"},"NASListProxyResponse":{"description":"ListProxyResponse is the response schema for ListProxy","type":"object","properties":{"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"},"proxies":{"type":"array","items":{"$ref":"#/components/schemas/NASProxyResponse"},"x-go-name":"Proxies"}},"x-go-name":"ListProxyResponse","x-go-package":"phoenix/nas/cloud/report/spec/proxies"},"NASProxyResponse":{"description":"ProxyResponse is the response part of the schema for ListProxy","type":"object","properties":{"activationTime":{"description":"The time at which the NAS proxy was activated for Phoenix.","type":"string","x-go-name":"ActivationTime"},"isProxyConnected":{"description":"The connection status of the NAS proxy.","type":"boolean","x-go-name":"IsProxyConnected"},"organizationName":{"description":"The name of organization.","type":"string","x-go-name":"OrganizationName"},"platform":{"description":"The platform of the NAS proxy.","type":"string","x-go-name":"Platform"},"proxyName":{"description":"The name of NAS proxy.","type":"string","x-go-name":"ProxyName"},"version":{"description":"The version of NAS proxy.","type":"string","x-go-name":"Version"}},"x-go-name":"ProxyResponse","x-go-package":"phoenix/nas/cloud/report/spec/proxies"},"NASRestoreEnvironmentStruct":{"description":"RestoreEnvironmentStruct struct holds the response for GetRestoreJobsReport api","type":"object","properties":{"diskWriteRate":{"description":"Specifies the bit rate for writing I/O by the agent. The Disk Write Rate is the average of the total data written with respect to the total time taken to write data at various intervals.","type":"string","x-go-name":"DiskWriteRate"},"diskWriteRateInKBps":{"description":"Specifies the bit rate in Kilobytes per second for writing I/O by the agent. The Disk Write Rate is the average of the total data written with respect to the total time taken to write data at various intervals.","type":"number","format":"double","x-go-name":"DiskWriteRateInKBps"},"networkRetries":{"description":"Number of retries during the job due to network issues.","type":"integer","format":"int32","x-go-name":"NetworkRetries"},"networkRetryDuration":{"description":"Specifies the total time spent in the network retries. It represents the cumulative of all network session duration.","type":"string","x-go-name":"NetworkRetryDuration"},"networkRetryDurationInSeconds":{"description":"Specifies the total time spent in seconds in the network retries. It represents the cumulative of all network session duration.","type":"integer","format":"int64","x-go-name":"NetworkRetryDurationInSeconds"}},"x-go-name":"RestoreEnvironmentStruct","x-go-package":"phoenix/nas/cloud/report/spec/jobs"},"NASRestoreExecutionDetailsStruct":{"description":"RestoreExecutionDetailsStruct struct holds the response for GetRestoreJobsReport api","type":"object","properties":{"bandwidthConsumed":{"description":"Specifies the bit rate to transfer data from the Cloud and CloudCache.","type":"string","x-go-name":"BandwidthConsumed"},"bandwidthConsumedInKBps":{"description":"Specifies the bit rate in Kilobytes per second to transfer data from the Cloud and CloudCache.","type":"number","format":"double","x-go-name":"BandwidthConsumedInKBps"},"endTime":{"description":"The time when the job operation completes. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"Specifies the error code for the failed jobs. The possible values are:\n \\\"0\\\": If the job is successful\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"Specifies the error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"fileSizeDistribution":{"description":"File size distribution of the files restored during the job.","type":"object","additionalProperties":{"type":"string"},"x-go-name":"FileSizeDistribution"},"restoredData":{"description":"Specifies the total amount of data restored.","type":"string","x-go-name":"RestoredData"},"restoredDataInBytes":{"description":"Specifies the total amount of data restored in bytes.","type":"integer","format":"uint64","x-go-name":"RestoredDataInBytes"},"restoredItems":{"description":"Files/folders restored on NAS host.","type":"string","x-go-name":"RestoredItems"},"scheduleTime":{"description":"The date and time when the job starts or is scheduled to start. The time is specified in UTC in the format YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"ScheduleTime"},"startTime":{"description":"The time when the job operation starts. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"Status of the job.","type":"string","enum":["Queued","Running","Successful","Successful with errors","Failed"],"x-go-name":"Status"}},"x-go-name":"RestoreExecutionDetailsStruct","x-go-package":"phoenix/nas/cloud/report/spec/jobs"},"NASRetentionPolicy":{"description":"RetentionPolicy struct holds the response for GetPolicies api","type":"object","properties":{"allSnapshots":{"description":"The number of days for which daily backup restore points are to be retained.","type":"string","x-go-name":"Daily"},"monthly":{"description":"The number of months for which monthly backup restore points are to be retained.","type":"string","x-go-name":"Monthly"},"weekly":{"description":"The number of weeks for which weekly backup restore points are to be retained.","type":"string","x-go-name":"Weekly"},"yearly":{"description":"The number of years for which yearly backup restore points are to be retained.","type":"string","x-go-name":"Yearly"},"ltrEnabled":{"description":"The status of the backup set whether enabled for long term retention. For example, True denotes that the backup set is enabled for LTR.","type":"boolean","x-go-name":"LTREnabled"},"warmTierDuration":{"description":"Lists the duration in days for which the snapshot will reside in the warm tier of the AWS storage.","type":"integer","format":"int32","x-go-name":"WarmTierDuration"}},"x-go-name":"RetentionPolicy","x-go-package":"phoenix/nas/cloud/report/spec/policies"},"NASRuleStruct":{"description":"RuleStruct is response schema for GetContentRules","type":"object","properties":{"backupContent":{"$ref":"#/components/schemas/NASBackupContentStruct"},"organizationName":{"description":"The name of NAS organization.","type":"string","x-go-name":"OrgName"},"ruleName":{"description":"Name of the content rule.","type":"string","x-go-name":"RuleName"},"ruleType":{"description":"The data that is backed up on a server.","type":"string","x-go-name":"RuleType"}},"x-go-name":"RuleStruct","x-go-package":"phoenix/nas/cloud/report/spec/contentrules"},"NASSchedules":{"description":"Schedules struct holds the response for GetPolicies api","type":"object","properties":{"bandwidth":{"description":"Specifies the bandwidth that each resource can consume while backing up data to the Cloud.","type":"string","x-go-name":"Bandwidth"},"bandwidthInKBps":{"description":"Specifies the bandwidth in Kilobytes per second that each resource can consume while backing up data to the Cloud.","type":"number","format":"double","x-go-name":"BandwidthInKBps"},"duration":{"description":"Specifies the duration after which you want backup operations to stop.","type":"string","x-go-name":"Duration"},"durationInSeconds":{"description":"Specifies the duration in seconds after which you want backup operations to stop.","type":"integer","format":"int64","x-go-name":"DurationInSeconds"},"repeatOn":{"$ref":"#/components/schemas/JSONStringList"},"startAt":{"description":"The start hour of the backup operation.","type":"string","x-go-name":"StartAt"}},"x-go-name":"Schedules","x-go-package":"phoenix/nas/cloud/report/spec/policies"},"NASShare":{"description":"Share is the response part of the schema for HostResponse, it represents a NAS Share","type":"object","properties":{"shareName":{"description":"The name of the NAS share.","type":"string","x-go-name":"ShareName"},"shareType":{"description":"The type of the NAS share.","type":"string","x-go-name":"ShareType"}},"x-go-name":"Share","x-go-package":"phoenix/nas/cloud/report/spec/hosts"},"NASUploadLogExecDetailsStruct":{"description":"UploadLogExecDetailsStruct struct holds the response for GetUploadLogJobsReport api","type":"object","properties":{"endTime":{"description":"The time when the job operation completes. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"Specifies the error code for the failed jobs. The possible values are:\n \\\"0\\\": If the job is successful\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"Specifies the error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"logsExpiryTime":{"description":"Expiry time of the uploaded logs. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"LogsExpiryTime"},"logsSize":{"description":"Specifies the size of the extracted log files.","type":"string","x-go-name":"LogsSize"},"logsSizeInBytes":{"description":"Specifies the size of the extracted log files in bytes.","type":"integer","format":"uint64","x-go-name":"LogsSizeInBytes"},"scheduleTime":{"description":"The date and time when the job starts or is scheduled to start. The time is specified in UTC in the format YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"ScheduleTime"},"sourceJobID":{"description":"The ID of the job for which logs are being requested.","type":"integer","format":"int32","x-go-name":"SourceJobID"},"sourceJobType":{"description":"The job type for which logs are being requested.","type":"string","x-go-name":"SourceJobLogType"},"startTime":{"description":"The time when the job operation starts. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"Status of the job.","type":"string","enum":["Queued","Running","Successful","Successful with errors","Failed"],"x-go-name":"Status"}},"x-go-name":"UploadLogExecDetailsStruct","x-go-package":"phoenix/nas/cloud/report/spec/jobs"},"GetAllBackupJobsInfoRequest":{"description":"GetAllBackupJobsInfoRequest is the request schema for GetAllBackupJobsInfo","type":"object","required":["OrgID"],"properties":{"fromTime":{"description":"Specify the date and time to filter jobs that were run after the specified timestamp. Specify the date and time in UTC format and must be greater than the value of (current time - 6 months). The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"string","x-go-name":"StartTime"},"OrgID":{"description":"Organization ID of the organization under which your VMware hosts are registered. Set it to \"0\" to select all organizations.\nin: path","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Leave this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"},"sortOrder":{"description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.\nin: query","type":"string","x-go-name":"SortOrder"},"status":{"description":"Status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors, Failed. Specify multiple status values by separating them with commas.\nin: query","type":"string","x-go-name":"Status"},"toTime":{"description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"string","x-go-name":"EndTime"},"vmName":{"description":"The name of the VM for which the job is initiated. Specify multiple VM names by separating them with commas.\nin: query","type":"string","x-go-name":"VMNameList"}},"x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"GetAllJobsInfoRequest":{"description":"GetAllJobsInfoRequest is the request schema for GetAllJobsInfo","type":"object","required":["OrgID"],"properties":{"fromTime":{"description":"Specify the date and time to filter jobs that were run after the specified timestamp. Specify the date and time in UTC format and must be greater than the value of (current time - 6 months). The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"string","x-go-name":"StartTime"},"jobType":{"description":"The type of job. This parameter can be set to one or more of the following values: Backup, Restore, Log Request, Defreeze. Specify multiple job types by separating them with commas.\nin: query","type":"string","x-go-name":"JobType"},"OrgID":{"description":"Organization ID of the organization under which your VMware hosts are registered. Set it to \"0\" to select all organizations.\nin: path","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Leave this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"},"sortOrder":{"description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.\nin: query","type":"string","x-go-name":"SortOrder"},"status":{"description":"Status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors, Failed. Specify multiple status values by separating them with commas.\nin: query","type":"string","x-go-name":"Status"},"toTime":{"description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"string","x-go-name":"EndTime"},"vmName":{"description":"The name of the VM for which the job is initiated. Specify multiple VM names by separating them with commas.\nin: query","type":"string","x-go-name":"VMName"}},"x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"GetBackupProxiesRequest":{"description":"GetBackupProxiesRequest is request schema for GetBackupsets","type":"object","required":["OrgID"],"properties":{"OrgID":{"description":"Organization ID of the organization under which your VMware hosts are registered. Set it to \"0\" to select all organizations\nin: path","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Leave this field blank in the first request\nin: query","type":"string","x-go-name":"PageToken"},"vcenterName":{"description":"The name of the VCenter. Multiple VCenter names can be separated with commas\nin: query","type":"string","x-go-name":"VCNames"}},"x-go-package":"phoenix/vmware/cloud/report/spec/proxies"},"ListBackupProxyFilter":{"description":"ListBackupProxyFilter is filter structure to be passed while listing","type":"object","properties":{"VCenterIDs":{"type":"array","items":{"type":"integer","format":"int64"}}},"x-go-package":"phoenix/vmware/cloud/report/spec/proxies"},"ListPoliciesByFilterResponse":{"description":"ListPoliciesByFilterResponse represents response model","type":"object","properties":{"PolicyMap":{}},"x-go-package":"phoenix/vmware/cloud/report/spec/policies"},"ListVCenterFilter":{"description":"ListVCenterFilter is filter structure to be passed while listing","type":"object","properties":{"IDs":{"type":"array","items":{"type":"integer","format":"int64"}},"VCNames":{"type":"array","items":{"type":"string"}}},"x-go-package":"phoenix/vmware/cloud/report/spec/proxies"},"ListVHostFilter":{"description":"ListVHostFilter is filter structure to be passed while listing","type":"object","properties":{"IDs":{"type":"array","items":{"type":"integer","format":"int64"}}},"x-go-package":"phoenix/vmware/cloud/report/spec/proxies"},"ListVMachinesFilter":{"description":"ListVMachinesFilter is filter structure to be passed while listing vms","type":"object","properties":{"IDs":{"type":"array","items":{"type":"integer","format":"int64"}},"VMNames":{"type":"array","items":{"type":"string"}}},"x-go-package":"phoenix/vmware/cloud/report/spec/proxies"},"ListVMachinesResponse":{"description":"ListVMachinesResponse represents response model","type":"object","properties":{"VMachineMap":{}},"x-go-package":"phoenix/vmware/cloud/report/spec/proxies"},"VMachineInfo":{"type":"object","title":"VMachineInfo ...","properties":{"id":{"type":"integer","format":"int64","x-go-name":"ID"},"is_configured":{"type":"string","x-go-name":"IsConfigured"},"vcenter_fqdn":{"type":"string","x-go-name":"VcenterFQDN"},"vcenter_id":{"type":"integer","format":"int64","x-go-name":"VcenterID"},"vhost_fqdn":{"type":"string","x-go-name":"VHostFQDN"},"vhost_id":{"type":"integer","format":"int64","x-go-name":"VHostID"},"vhost_name":{"type":"string","x-go-name":"VHostName"},"vm_data_center":{"type":"string","x-go-name":"DataCenter"},"vm_name":{"type":"string","x-go-name":"VMName"}},"x-go-package":"phoenix/vmware/cloud/report/spec/proxies"},"VMwareBackupProxyInfo":{"description":"BackupProxyInfo is response schema for GetBackupProxies","type":"object","properties":{"backupProxyPool":{"$ref":"#/components/schemas/VMwareBackupProxyPoolStruct"},"dataCenter":{"description":"The name of the Data Center","type":"string","x-go-name":"DataCenterName"},"dataStore":{"description":"The name of the Data Store","type":"string","x-go-name":"DataStoreName"},"maxConcurrentBackups":{"description":"Maximum number of concurrent backup jobs supported by the backup proxy","type":"integer","format":"int32","x-go-name":"MaxConcurrentBackups"},"name":{"description":"The name of the Backup Proxy","type":"string","x-go-name":"Name"},"vCenter":{"description":"The name of the VCenter","type":"string","x-go-name":"VCenterName"},"vhost":{"description":"The name of the VHost","type":"string","x-go-name":"VHost"}},"x-go-name":"BackupProxyInfo","x-go-package":"phoenix/vmware/cloud/report/spec/proxies"},"VMwareBackupsetInfo":{"description":"BackupsetInfo is response schema for GetBackupsets","type":"object","properties":{"appsPresentInBackup":{"description":"Specifies the list of the applications, which are backed up as part of the application-aware backup.","type":"array","items":{"type":"string"},"x-go-name":"AppsPresentInBackup"},"backupEnabled":{"description":"Specifies whether the backup is enabled for the virtual machine.","type":"boolean","x-go-name":"BackupEnabled"},"backupPolicyID":{"description":"The ID of your backup policy.","format":"int64","type":"integer","x-go-name":"BackupPolicyID"},"backupPolicyName":{"description":"Name of the backup policy attached to the backup set","type":"string","x-go-name":"BackupPolicyName"},"backupsetID":{"description":"The ID of your backup set.","format":"int32","type":"integer","x-go-name":"BackupsetID"},"dataCenter":{"description":"The name of the Data Center","type":"string","x-go-name":"DataCenterName"},"diskExcludeList":{"description":"Exclude Filter","type":"array","items":{"type":"string"},"x-go-name":"DiskExcludeList"},"dataLock":{"description":"The status indicating if Data Lock is enabled for the backup set.","type":"boolean","x-go-name":"ImmutabilityEnabled"},"lastBackupDetails":{"$ref":"#/components/schemas/VMwareLastBackupDetailsStruct"},"ltrEnabled":{"description":"The status of the backup set whether enabled for long term retention. For example, True denotes that the backup set is enabled for LTR.","type":"boolean","x-go-name":"LTREnabled"},"name":{"description":"The name of the virtual machine (VM)","type":"string","x-go-name":"VMName"},"organizationID":{"description":"The ID of your organization.","format":"int32","type":"integer","x-go-name":"OrgID"},"organizationName":{"description":"The name of the Organization","type":"string","x-go-name":"OrgName"},"vCenter":{"description":"The name of the VCenter","type":"string","x-go-name":"VCenterName"},"vCenterID":{"description":"The ID of your vCenter.","format":"int64","type":"integer","x-go-name":"VCenterID"},"vhost":{"description":"The name of the Vhost","type":"string","x-go-name":"VHost"},"vmID":{"description":"The ID of your virtual machine.","format":"int64","type":"integer","x-go-name":"VMID"},"warmTierDuration":{"description":"Lists the duration in days for which the snapshot will reside in the warm tier of the AWS storage.","type":"integer","format":"int32","x-go-name":"WarmTierDuration"}},"x-go-name":"BackupsetInfo","x-go-package":"phoenix/vmware/cloud/report/spec/backupsets"},"VMwareDataTransferStruct":{"description":"DataTransferStruct struct holds the response for GetBackupJobsReport api","type":"object","properties":{"backupDuration":{"description":"Specifies the total time taken to upload data to the Cloud and CloudCache. Backup duration excludes the estimation time, network retry time, and the waiting for retry time.","type":"string","x-go-name":"BackupDuration"},"backupDurationInSeconds":{"description":"Specifies the total time taken in seconds to upload data to the Cloud and CloudCache. Backup duration excludes the estimation time, network retry time, and the waiting for retry time.","type":"integer","format":"int64","x-go-name":"BackupDurationInSeconds"},"backupSpeed":{"description":"Specifies the rate at which the source data is backed up to the Cloud.","type":"string","x-go-name":"BackupSpeed"},"backupSpeedInKBps":{"description":"Specifies the rate in Kilobytes per second at which the source data is backed up to the Cloud.","type":"number","format":"double","x-go-name":"BackupSpeedInKBps"},"bandwidthConsumed":{"description":"Specifies the bit rate to transfer data from the Cloud and CloudCache.","type":"string","x-go-name":"BandwidthConsumed"},"bandwidthConsumedInKBps":{"description":"Specifies the bit rate in Kilobytes per second to transfer data from the Cloud and CloudCache.","type":"number","format":"double","x-go-name":"BandwidthConsumedInKBps"},"dataTransferCache":{"description":"Specifies the incremental data that is uploaded to CloudCache after deduplication and compression.","type":"string","x-go-name":"DataTransferCache"},"dataTransferCacheInBytes":{"description":"Specifies the incremental data in bytes that is uploaded to CloudCache after deduplication and compression.","type":"integer","format":"uint64","x-go-name":"DataTransferCacheInBytes"},"dataTransferCloud":{"description":"Specifies the incremental data that is uploaded to the Cloud after deduplication and compression.","type":"string","x-go-name":"DataTransferCloud"},"dataTransferCloudInBytes":{"description":"Specifies the incremental data in bytes that is uploaded to the Cloud after deduplication and compression.","type":"integer","format":"uint64","x-go-name":"DataTransferCloudInBytes"}},"x-go-name":"DataTransferStruct","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareDefreezeEnvironmentStruct":{"description":"DefreezeEnvironmentStruct struct holds the response for GetDefreezeJobsReport api","type":"object","properties":{"diskWriteRate":{"description":"Disk write rate during the job.","type":"string","x-go-name":"DiskWriteRate"},"networkRetries":{"description":"Number of network retries during the job.","type":"integer","format":"int32","x-go-name":"NetworkRetries"},"networkRetryDuration":{"description":"Duration of network retries during the job.","type":"string","x-go-name":"NetworkRetryDuration"}},"x-go-name":"DefreezeEnvironmentStruct","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareDefreezeExecutionDetailsStruct":{"description":"DefreezeExecutionDetailsStruct struct holds the response for GetDefreezeJobsReport api","type":"object","properties":{"endTime":{"description":"The time when the job operation ends.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"Specifies the error code for the failed jobs. The possible values are:\n \\\"0\\\": If the job is successful\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"Specifies the error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"startTime":{"description":"The time when the job operation starts.","type":"string","x-go-name":"StartTime"},"status":{"description":"Status of the job.","type":"string","x-go-name":"Status"}},"x-go-name":"DefreezeExecutionDetailsStruct","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareEnvironmentStruct":{"description":"EnvironmentStruct struct holds the response for GetBackupJobsReport api","type":"object","properties":{"diskReadRate":{"description":"Specifies the bit rate for reading I/O by the agent. The Disk Read Rate is an average of the total data read with respect to the total time taken to read data at various intervals for all drives where data is distributed.","type":"string","x-go-name":"DiskReadRate"},"diskReadRateInKBps":{"description":"Specifies the bit rate in Kilobytes per second for reading I/O by the agent. The Disk Read Rate is an average of the total data read with respect to the total time taken to read data at various intervals for all drives where data is distributed.","type":"number","format":"double","x-go-name":"DiskReadRateInKBps"},"networkRetries":{"description":"Number of network retries during the job.","type":"integer","format":"int32","x-go-name":"NetworkRetries"},"networkRetryDuration":{"description":"Specifies the total time spent in the network retries. It represents the cumulative of all network session duration.","type":"string","x-go-name":"NetworkRetryDuration"},"networkRetryDurationInSeconds":{"description":"Specifies the total time spent in seconds in the network retries. It represents the cumulative of all network session duration.","type":"integer","format":"int64","x-go-name":"NetworkRetryDurationInSeconds"}},"x-go-name":"EnvironmentStruct","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareEstimationDetailsStruct":{"description":"EstimationDetailsStruct struct holds the response for GetBackupJobsReport api","type":"object","properties":{"dataScanned":{"description":"Data scanned during the job.","type":"integer","format":"int64","x-go-name":"DataScanned"},"disksAdded":{"description":"Number of VM Disks added at source during the job.","type":"integer","format":"int64","x-go-name":"DisksAdded"},"disksModified":{"description":"Number of VM Disks changed at source during the job.","type":"integer","format":"int64","x-go-name":"DisksModified"},"disksRemoved":{"description":"Number of VM Disks removed at source during the job.","type":"integer","format":"int64","x-go-name":"DisksRemoved"},"sourceDataScanned":{"description":"Specifies the data scanned in at the source in order to backup.","type":"string","x-go-name":"SourceDataScanned"},"sourceDataScannedInBytes":{"description":"Specifies the data scanned in bytes at the source in order to backup.","type":"integer","format":"uint64","x-go-name":"SourceDataScannedInBytes"}},"x-go-name":"EstimationDetailsStruct","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareExecutionDetailsStruct":{"description":"ExecutionDetailsStruct struct holds the response for GetBackupJobsReport api","type":"object","properties":{"endTime":{"description":"The time when the job operation ends.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"Specifies the error code for the failed jobs. The possible values are:\n \\\"0\\\": If the job is successful\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"Specifies the error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"startTime":{"description":"The time when the job operation starts.","type":"string","x-go-name":"StartTime"},"status":{"description":"Status of the job.","type":"string","x-go-name":"Status"}},"x-go-name":"ExecutionDetailsStruct","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareGetAllBackupJobsInfoResponse":{"description":"GetAllBackupJobsInfoResponse is the response schema for GetAllBackupJobsInfo","type":"object","properties":{"jobs":{"description":"List of all backup jobs for VMware.","type":"array","items":{"$ref":"#/components/schemas/VMwareGetBackupJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetAllBackupJobsInfoResponse","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareGetAllDefrezeJobsInfoResponse":{"description":"GetAllDefrezeJobsInfoResponse is the response schema for GetAllDefrezeJobsInfoResponse","type":"object","properties":{"jobs":{"description":"List of all defreeze jobs run for VMware.”","type":"array","items":{"$ref":"#/components/schemas/VMwareGetDefreezeJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetAllDefrezeJobsInfoResponse","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareGetAllJobsInfoResponse":{"description":"GetAllJobsInfoResponse is the response schema for GetAllJobsInfo","type":"object","properties":{"jobs":{"description":"List of all jobs run for VMware.","type":"array","items":{"$ref":"#/components/schemas/VMwareJobResponse"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetAllJobsInfoResponse","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareGetAllRestoreJobsInfoResponse":{"description":"GetAllRestoreJobsInfoResponse is the response schema for GetRestoreJobReport","type":"object","properties":{"jobs":{"description":"List of all restore jobs run for VMware.","type":"array","items":{"$ref":"#/components/schemas/VMwareGetRestoreJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetAllRestoreJobsInfoResponse","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareGetAllUploadLogsJobsInfoResponse":{"description":"GetAllUploadLogsJobsInfoResponse is the response schema for GetAllUploadLogsJobsInfoResponse","type":"object","properties":{"jobs":{"description":"List of all jobs in which logs were uploaded to Phoenix.","type":"array","items":{"$ref":"#/components/schemas/VMwareGetUploadLogsJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetAllUploadLogsJobsInfoResponse","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareGetBackupJobsReport":{"description":"GetBackupJobsReport struct holds the response for GetBackupJobsReport api","type":"object","properties":{"backupPolicyID":{"description":"The ID of your backup policy.","format":"int32","type":"integer","x-go-name":"BackupPolicyID"},"backupPolicyName":{"description":"The name of the backup policy","type":"string","x-go-name":"BackupPolicyName"},"backupProxyName":{"description":"The name of Backup Proxy.","type":"string","x-go-name":"BackupProxyName"},"backupsetID":{"description":"The ID of your backup set.","format":"int32","type":"integer","x-go-name":"BackupsetID"},"cbtStatus":{"description":"Status of VMware CBT","type":"string","x-go-name":"CBTStatus"},"dataTransfer":{"$ref":"#/components/schemas/VMwareDataTransferStruct"},"environmentDetails":{"$ref":"#/components/schemas/VMwareEnvironmentStruct"},"estimationDetails":{"$ref":"#/components/schemas/VMwareEstimationDetailsStruct"},"executionDetails":{"$ref":"#/components/schemas/VMwareExecutionDetailsStruct"},"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"The type of job.","type":"string","x-go-name":"JobType"},"msSqlBackupDetails":{"$ref":"#/components/schemas/VMwareMSSqlBackupDetails"},"organizationID":{"description":"The ID of your organization.","format":"int32","type":"integer","x-go-name":"OrgID"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"vmName":{"description":"The name of VM.","type":"string","x-go-name":"VMName"}},"x-go-name":"GetBackupJobsReport","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareBackupProxyPoolStruct":{"description":"BackupProxyPoolStruct struct holds the information of the backup proxy pool.","type":"object","properties":{"name":{"description":"The name of the backup proxy pool.","type":"string","x-go-name":"Name"},"timezone":{"description":"The time zone for the backup proxy pool. Phoenix triggers backup of the virtual machines mapped to the proxy pool in this time zone.","type":"string","x-go-name":"TimeZone"}},"x-go-name":"BackupProxyPoolStruct","x-go-package":"phoenix/vmware/cloud/report/spec/proxies"},"VMwareGetBackupProxiesResponse":{"description":"GetBackupProxiesResponse is response schema for GetBackupsets","type":"object","properties":{"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"},"proxies":{"description":"List of the backup proxies deployed and the information of each backup proxy.","type":"array","items":{"$ref":"#/components/schemas/VMwareBackupProxyInfo"},"x-go-name":"BackupProxies"}},"x-go-name":"GetBackupProxiesResponse","x-go-package":"phoenix/vmware/cloud/report/spec/proxies"},"VMwareGetBackupsetsResponse":{"description":"GetBackupsetsResponse is response schema for GetBackupsets","type":"object","properties":{"backupsets":{"description":"List of backup sets based on the query. In this case, returns the backup sets created for VMware.","type":"array","items":{"$ref":"#/components/schemas/VMwareBackupsetInfo"},"x-go-name":"Backupsets"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetBackupsetsResponse","x-go-package":"phoenix/vmware/cloud/report/spec/backupsets"},"VMwareGetDefreezeJobsReport":{"description":"GetDefreezeJobsReport struct holds the response for GetDefreezeJobsReport api","type":"object","properties":{"executionDetails":{"$ref":"#/components/schemas/VMwareDefreezeExecutionDetailsStruct"},"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"Type of the operation.","type":"string","x-go-name":"JobType"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"rpName":{"description":"Name of the Snapshot for which the Defreeze operation was initiated.","type":"string","x-go-name":"RPName"},"vmName":{"description":"Name of the VM for which the Defreeze operation was initiated.","type":"string","x-go-name":"VMName"}},"x-go-name":"GetDefreezeJobsReport","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareGetPolicies":{"description":"GetPolicies struct holds the response for GetPolicies api","type":"object","properties":{"autoEnableCBT":{"description":"Enable CBT - yes/no","type":"boolean","x-go-name":"AutoEnableCBT"},"automaticRetry":{"description":"Automatic retry enabled/disabled","type":"boolean","x-go-name":"AutomaticRetry"},"description":{"description":"Description of the policy","type":"string","x-go-name":"Description"},"enableAppAwareProcessing":{"description":"Specifies the option to enable SQL Server database backups on the virtual machine.","type":"boolean","x-go-name":"EnableAppAwareProcessing"},"enableVMToolsQuiescing":{"description":"Enable vmtools quiescing -yes/no","type":"boolean","x-go-name":"EnableVMToolsQuiescing"},"ignoreFirstBackupDuration":{"description":"Ignore first backup duration - yes/no","type":"boolean","x-go-name":"IgnoreBackupDuration"},"dataLock":{"description":"The status indicating if Data Lock is enabled in the backup policy.","type":"boolean","x-go-name":"ImmutabilityEnabled"},"maxRetryCount":{"description":"Maximum retry count","type":"integer","format":"int64","x-go-name":"MaxRetryCount"},"maxRetryDuration":{"description":"Specifies the wait interval before the job is retried.","type":"string","x-go-name":"MaxRetryDuration"},"maxRetryDurationInSeconds":{"description":"Specifies the wait interval in seconds before the job is retried.","type":"integer","format":"int64","x-go-name":"MaxRetryDurationInSeconds"},"msSqlConfigDetails":{"$ref":"#/components/schemas/VMwareMSSqlConfigDetails"},"policyID":{"description":"The ID of your backup policy.","type":"integer","format":"int64","x-go-name":"PolicyID"},"policyName":{"description":"Name of the policy","type":"string","x-go-name":"PolicyName"},"policyType":{"description":"Type of the policy","type":"string","x-go-name":"PolicyType"},"retention":{"$ref":"#/components/schemas/VMwareRetentionPolicy"},"schedules":{"description":"Schedules for the backup","type":"array","items":{"$ref":"#/components/schemas/VMwareSchedules"},"x-go-name":"Schedules"}},"x-go-name":"GetPolicies","x-go-package":"phoenix/vmware/cloud/report/spec/policies"},"VMwareGetPoliciesResponse":{"description":"GetPoliciesResponse is response schema for GetPolicies","type":"object","properties":{"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"},"policies":{"description":"List of all backup policies for VMware.","type":"array","items":{"$ref":"#/components/schemas/VMwareGetPolicies"},"x-go-name":"Policies"}},"x-go-name":"GetPoliciesResponse","x-go-package":"phoenix/vmware/cloud/report/spec/policies"},"VMwareGetRestoreJobsReport":{"description":"GetRestoreJobsReport struct holds the response for GetRestoreJobsReport api","type":"object","properties":{"backupProxyName":{"description":"Name of the backup proxy on which the job is processed.","type":"string","x-go-name":"BackupProxyName"},"backupsetID":{"description":"The ID of your backup set.","format":"int32","type":"integer","x-go-name":"BackupsetID"},"destinationVMName":{"description":"Name of the VM on which the restore was initiated","type":"string","x-go-name":"DestinationVMName"},"environmentDetails":{"$ref":"#/components/schemas/VMwareRestoreEnvironmentStruct"},"executionDetails":{"$ref":"#/components/schemas/VMwareRestoreExecutionDetailsStruct"},"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"Type of the operation.","type":"string","x-go-name":"JobType"},"msSqlRestoreDetails":{"$ref":"#/components/schemas/VMwareMSSqlRestoreDetails"},"organizationID":{"description":"The ID of your organization.","format":"int32","type":"integer","x-go-name":"OrgID"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"restoreType":{"type":"string","x-go-name":"RestoreType"},"sourceVMName":{"description":"Name of the VM for which the restore was initiated.","type":"string","x-go-name":"SourceVMName"}},"x-go-name":"GetRestoreJobsReport","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareGetUploadLogsJobsReport":{"description":"GetUploadLogsJobsReport struct holds the response for GetDefreezeJobsReport api","type":"object","properties":{"environmentDetails":{"$ref":"#/components/schemas/VMwareUploadLogsEnvironmentStruct"},"executionDetails":{"$ref":"#/components/schemas/VMwareUploadLogsExecutionDetailsStruct"},"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"Type of the operation.","type":"string","x-go-name":"JobType"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"vmName":{"description":"Name of the VM for which the operation was initiated.","type":"string","x-go-name":"VMName"}},"x-go-name":"GetUploadLogsJobsReport","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareJobResponse":{"description":"JobResponse struct holds the response for JobResponse api","type":"object","properties":{"endTime":{"description":"The time when the job operation completes.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"Specifies the error code for the failed jobs. The possible values are:\n \\\"0\\\": If the job is successful\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"Specifies the error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"The type of job.","type":"string","x-go-name":"JobType"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"startTime":{"description":"The time when the job operation starts.","type":"string","x-go-name":"StartTime"},"status":{"description":"Status of the job.","type":"string","x-go-name":"Status"},"vmName":{"description":"The name of VM","type":"string","x-go-name":"VMName"}},"x-go-name":"JobResponse","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareLastBackupDetailsStruct":{"description":"LastBackupDetailsStruct is response schema for GetBackupsets","type":"object","properties":{"jobID":{"description":"A unique identification number associated with the job","type":"integer","format":"int32","x-go-name":"JobID"},"status":{"description":"Status of the job","type":"string","x-go-name":"Status"}},"x-go-name":"LastBackupDetailsStruct","x-go-package":"phoenix/vmware/cloud/report/spec/backupsets"},"VMwareMSSqlBackupDetails":{"description":"MSSqlBackupDetails struct holds the response for GetBackupJobsReport api","type":"object","properties":{"appAwareBackupType":{"description":"Specifies the type of the SQL backup. The possible values are Full Backup and Transaction Log Backup.","type":"string","x-go-name":"AppAwareBackupType"},"dbInstanceNames":{"description":"Specifies the names of the SQL instances, which are present in the virtual machine and backed up during the full backup.","type":"array","items":{"type":"string"},"x-go-name":"DbInstanceNames"}},"x-go-name":"MSSqlBackupDetails","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareMSSqlFileLocation":{"type":"object","title":"MSSqlFileLocation struct specifies the locations where the MDF, LDF, and NDF files are restored.","properties":{"ldfFileLocation":{"description":"Specifies the location where the LDF files are restored.","type":"string","x-go-name":"LdfFileLocation"},"mdfFileLocation":{"description":"Specifies the location where the MDF files are restored.","type":"string","x-go-name":"MdfFileLocation"},"ndfFileLocation":{"description":"Specifies the location where the NDF files are restored.","type":"string","x-go-name":"NdfFileLocation"}},"x-go-name":"MSSqlFileLocation","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareMSSqlRestoreDetails":{"description":"MSSqlRestoreDetails struct holds the response for GetRestoreJobsReport api","type":"object","properties":{"appAwareRestoreType":{"description":"Specifies the type of the SQL restore. The possible value of the restore type are Database Restore, Transaction Mark Restore, and Point In Time Restore","type":"string","x-go-name":"AppAwareRestoreType"},"destinationInstanceName":{"description":"Specifies the name of the SQL instance on the target virtual machine on which you want to restore the databases.","type":"string","x-go-name":"DestinationInstanceName"},"fileLocation":{"$ref":"#/components/schemas/VMwareMSSqlFileLocation"},"recoveryMode":{"description":"Specifies the recovery mode in which the restored database should be left once the restore is completed. The possible values are Recovery Mode and Non Recovery Mode.","type":"string","x-go-name":"RecoveryMode"},"sourceInstanceName":{"description":"Specifies the name of the SQL instance on the source virtual machine from which the databases are restored.","type":"string","x-go-name":"SourceInstanceName"},"stagingVMName":{"description":"Specifies the name of the staging virtual machine to mount the selected SQL data for restoring to the target virtual machine.","type":"string","x-go-name":"StagingVMName"}},"x-go-name":"MSSqlRestoreDetails","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareRestoreEnvironmentStruct":{"description":"RestoreEnvironmentStruct struct holds the response for GetRestoreJobsReport api","type":"object","properties":{"diskWriteRate":{"description":"Specifies the bit rate for writing I/O by the agent. The Disk Write Rate is the average of the total data written with respect to the total time taken to write data at various intervals.","type":"string","x-go-name":"DiskWriteRate"},"diskWriteRateInKBps":{"description":"Specifies the bit rate in Kilobytes per second for writing I/O by the agent. The Disk Write Rate is the average of the total data written with respect to the total time taken to write data at various intervals.","type":"number","format":"double","x-go-name":"DiskWriteRateInKBps"},"networkRetries":{"description":"Number of network retries during the job.","type":"integer","format":"int32","x-go-name":"NetworkRetries"},"networkRetryDuration":{"description":"Specifies the total time spent in the network retries. It represents the cumulative of all network session duration.","type":"string","x-go-name":"NetworkRetryDuration"},"networkRetryDurationInSeconds":{"description":"Specifies the total time spent in seconds in the network retries. It represents the cumulative of all network session duration.","type":"integer","format":"int64","x-go-name":"NetworkRetryDurationInSeconds"}},"x-go-name":"RestoreEnvironmentStruct","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareRestoreExecutionDetailsStruct":{"description":"RestoreExecutionDetailsStruct struct holds the response for GetRestoreJobsReport api","type":"object","properties":{"bandwidthConsumed":{"description":"Specifies the bit rate to transfer data from the Cloud and CloudCache.","type":"string","x-go-name":"BandwidthConsumed"},"bandwidthConsumedInKBps":{"description":"Specifies the bit rate in Kilobytes per second to transfer data from the Cloud and CloudCache.","type":"number","format":"double","x-go-name":"BandwidthConsumedInKBps"},"errorCode":{"description":"Specifies the error code for the failed jobs. The possible values are:\n \\\"0\\\": If the job is successful\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"Specifies the error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"endTime":{"description":"The time when the job operation ends.","type":"string","x-go-name":"EndTime"},"restoredData":{"description":"Specifies the total amount of data restored.","type":"string","x-go-name":"RestoredData"},"restoredDataInBytes":{"description":"Specifies the total amount of data restored in bytes.","type":"integer","format":"uint64","x-go-name":"RestoredDataInBytes"},"restoredItems":{"description":"Data items restored.","type":"string","x-go-name":"RestoredItems"},"startTime":{"description":"The time when the job operation starts.","type":"string","x-go-name":"StartTime"},"status":{"description":"Status of the job.","type":"string","x-go-name":"Status"}},"x-go-name":"RestoreExecutionDetailsStruct","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareRetentionPolicy":{"description":"RetentionPolicy struct holds the response for GetPolicies api","type":"object","properties":{"allSnapshots":{"description":"Daily copies of the backup to retain","type":"string","x-go-name":"Daily"},"ltrEnabled":{"description":"The status of the backup set whether enabled for long term retention. For example, True denotes that the backup set is enabled for LTR.","type":"boolean","x-go-name":"LTREnabled"},"monthly":{"description":"Monthly copies of the backup to retain","type":"string","x-go-name":"Monthly"},"warmTierDuration":{"description":"Lists the duration in days for which the snapshot will reside in the warm tier of the AWS storage.","type":"integer","format":"int32","x-go-name":"WarmTierDuration"},"weekly":{"description":"Weekly copies of the backup to retain","type":"string","x-go-name":"Weekly"},"yearly":{"description":"Yearly copies of the backup to retain","type":"string","x-go-name":"Yearly"}},"x-go-name":"RetentionPolicy","x-go-package":"phoenix/vmware/cloud/report/spec/policies"},"VMwareSchedules":{"description":"Schedules struct holds the response for GetPolicies api","type":"object","properties":{"bandwidth":{"description":"Specifies the bandwidth that each resource can consume while backing up data to the Cloud.","type":"string","x-go-name":"Bandwidth"},"bandwidthInKBps":{"description":"Specifies the bandwidth in Kilobytes per second that each resource can consume while backing up data to the Cloud.","type":"number","format":"double","x-go-name":"BandwidthInKBps"},"duration":{"description":"Specifies the duration after which you want backup operations to stop.","type":"string","x-go-name":"Duration"},"durationInSeconds":{"description":"Specifies the duration in seconds after which you want backup operations to stop.","type":"integer","format":"int64","x-go-name":"DurationInSeconds"},"repeatOn":{"$ref":"#/components/schemas/JSONStringList"},"startAt":{"description":"Schedule start time","type":"string","x-go-name":"StartAt"}},"x-go-name":"Schedules","x-go-package":"phoenix/vmware/cloud/report/spec/policies"},"VMwareUploadLogsEnvironmentStruct":{"description":"UploadLogsEnvironmentStruct struct holds the response for GetUploadLogsJobsReport api","type":"object","properties":{"diskWriteRate":{"description":"Disk write rate during the job.","type":"string","x-go-name":"DiskWriteRate"},"networkRetries":{"description":"Number of network retries during the job.","type":"integer","format":"int32","x-go-name":"NetworkRetries"},"networkRetryDuration":{"description":"Duration of network retries during the job.","type":"string","x-go-name":"NetworkRetryDuration"}},"x-go-name":"UploadLogsEnvironmentStruct","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareUploadLogsExecutionDetailsStruct":{"description":"UploadLogsExecutionDetailsStruct struct holds the response for GetUploadLogsJobsReport api","type":"object","properties":{"endTime":{"description":"The time when the job operation ends.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"Specifies the error code for the failed jobs. The possible values are:\n \\\"0\\\": If the job is successful\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"Specifies the error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"logsExpiryTime":{"description":"Expiry time of the uploaded logs.","type":"string","x-go-name":"LogsExpiryTime"},"logsSize":{"description":"Specifies the size of the extracted log files.","type":"string","x-go-name":"LogsSize"},"logsSizeInBytes":{"description":"Specifies the size of the extracted log files in bytes.","type":"integer","format":"uint64","x-go-name":"LogsSizeInBytes"},"sourceJobID":{"description":"The operation for which logs are being requested.","type":"integer","format":"int32","x-go-name":"SourceJobID"},"sourceJobLogType":{"description":"The operation type for which logs are being requested.","type":"string","x-go-name":"SourceJobLogType"},"startTime":{"description":"The time when the job operation starts.","type":"string","x-go-name":"StartTime"},"status":{"description":"Status of the job.","type":"string","x-go-name":"Status"}},"x-go-name":"UploadLogsExecutionDetailsStruct","x-go-package":"phoenix/vmware/cloud/report/spec/jobs"},"VMwareMSSqlConfigDetails":{"description":"MSSqlConfigDetails struct holds the response for GetPolicies api","type":"object","properties":{"backupTransactionLog":{"description":"Specifies the option to enable transaction log backups for applications.","type":"boolean","x-go-name":"BackupTransactionLog"},"tlBackupFrequencyInMinutes":{"description":"Specifies the interval in minutes to run the transaction log backups.","type":"integer","format":"int32","x-go-name":"TLBackupFrequencyInMinutes"},"tlBackupMaxBandwidthInMbps":{"description":"Specifies the maximum bandwidth for a transaction log backup.","type":"integer","format":"int32","x-go-name":"TLBackupMaxBandwidthInMbps"}},"x-go-name":"MSSqlConfigDetails","x-go-package":"phoenix/vmware/cloud/report/spec/policies"},"HVGetBackupSetReportResponse":{"description":"GetBackupSetReportResponse is the response schema for HyperVBackupSets","type":"object","properties":{"backupsets":{"description":"Returns a list of all Hyper-V backup sets.","type":"array","items":{"$ref":"#/components/schemas/HVHyperVBackupSets"},"x-go-name":"BackupSets"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetBackupSetReportResponse","x-go-package":"phoenix/hyperv/cloud/report/spec/backupset"},"HVHyperVBackupSets":{"description":"HyperVBackupSets is the response schema for HyperVBackupSets","type":"object","properties":{"backupEnabled":{"description":"Specifies whether backup is enabled for the backup set.","type":"boolean","x-go-name":"BackupEnabled"},"backupPolicyID":{"description":"The ID of your backup policy.","format":"int32","type":"integer","x-go-name":"BackupPolicyID"},"backupPolicyName":{"description":"The name of the backup policy attached to the backup set.","type":"string","x-go-name":"BackupPolicyName"},"backupsetID":{"description":"The ID of your backup set.","format":"int32","type":"integer","x-go-name":"BackupsetID"},"diskExcludeList":{"description":"Specifies the list of disks that are excluded from the backup set.","items":{"type":"string"},"type":"array","x-go-name":"ExcludeDisk"},"dataLock":{"description":"The status indicating if Data Lock is enabled for the backup set.","type":"boolean","x-go-name":"ImmutabilityEnabled"},"lastBackupDetails":{"$ref":"#/components/schemas/HVLastBackupDetailsStruct"},"ltrEnabled":{"description":"The status of the backup set whether enabled for long term retention. For example, True denotes that the backup set is enabled for LTR.","type":"boolean","x-go-name":"LTREnabled"},"name":{"description":"The name of the VM for which the job is initiated. Specify multiple VM names by separating them with commas.","type":"string","x-go-name":"VMName"},"organizationID":{"description":"The ID of your organization.","format":"int32","type":"integer","x-go-name":"OrgID"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"storageName":{"description":"The name of the storage.","type":"string","x-go-name":"StorageName"},"vmID":{"description":"The ID of your virtual machine.","format":"int32","type":"integer","x-go-name":"VMID"},"warmTierDuration":{"description":"Lists the duration in days for which the snapshot will reside in the warm tier of the AWS storage.","type":"integer","format":"int32","x-go-name":"WarmTierDuration"}},"x-go-name":"HyperVBackupSets","x-go-package":"phoenix/hyperv/cloud/report/spec/backupset"},"HVLastBackupDetailsStruct":{"description":"LastBackupDetailsStruct is response schema for LastBackupDetailsStruct","type":"object","properties":{"jobID":{"description":"Specifies a unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"status":{"description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","type":"string","x-go-name":"Status"}},"x-go-name":"LastBackupDetailsStruct","x-go-package":"phoenix/hyperv/cloud/report/spec/backupset"},"HVGetFRLProxyReportResponse":{"description":"GetFRLProxyReportResponse is the response schema for GetFRLProxyReport","type":"object","properties":{"flrProxies":{"description":"Specifies the list of FLR proxies for Hyper-V.","type":"array","items":{"$ref":"#/components/schemas/HVHyperVFLRProxies"},"x-go-name":"Result"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetFRLProxyReportResponse","x-go-package":"phoenix/hyperv/cloud/report/spec/flrproxies"},"HVHyperVFLRProxies":{"description":"HyperVFLRProxies is the response schema for HyperV FLR Proxies","type":"object","properties":{"connectionStatus":{"description":"The connection status of the FLR proxies.","type":"string","x-go-name":"ConnectionStatus"},"maxConcurrentBackups":{"description":"The maximum number of concurrent backup jobs supported by the backup proxy.","type":"integer","format":"int32","x-go-name":"MaxConcurrentBackups"},"name":{"description":"The name of the FLR Proxy.","type":"string","x-go-name":"Name"},"vHost":{"description":"The name of the Hyper-V host.","type":"string","x-go-name":"Host"}},"x-go-name":"HyperVFLRProxies","x-go-package":"phoenix/hyperv/cloud/report/spec/flrproxies"},"HVGetHostReportResponse":{"description":"GetHostReportResponse is the response schema for GetFRLProxyReport","type":"object","properties":{"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"},"result":{"description":"List of Hyper-V host.","type":"array","items":{"$ref":"#/components/schemas/HVHyperVHost"},"x-go-name":"Result"}},"x-go-name":"GetHostReportResponse","x-go-package":"phoenix/hyperv/cloud/report/spec/host"},"HVHyperVHost":{"description":"HyperVHost is the response schema for HyperV FLR Proxies","type":"object","properties":{"connectionStatus":{"description":"The connection status of the host.","type":"string","x-go-name":"ConnectionStatus"},"name":{"description":"The name of the host.","type":"string","x-go-name":"Name"},"os":{"description":"The operating system of the host.","type":"string","x-go-name":"OS"},"osVersion":{"description":"The version of the operating system of the hosts.","type":"string","x-go-name":"OSVersion"}},"x-go-name":"HyperVHost","x-go-package":"phoenix/hyperv/cloud/report/spec/host"},"HVDefreezeExecutionDetailsStruct":{"description":"DefreezeExecutionDetailsStruct struct holds the response for GetDefreezeJobsReport api","type":"object","properties":{"endTime":{"description":"The time when the job operation ends. The time is specified in the UTC time zone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"Specifies the error code when the backup operation fails. The possible values are:\\n \\\"0\\\": If the job is successful\\n : If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"Specifies the message for rhe failed job. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"startTime":{"description":"The time when the job operation starts. The time is specified in the UTC time zone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","type":"string","x-go-name":"Status"}},"x-go-name":"DefreezeExecutionDetailsStruct","x-go-package":"phoenix/hyperv/cloud/report/spec/job"},"HVGetAllJobsReportResponse":{"type":"object","title":"GetAllJobsReportResponse returns a list of all jobs run for Hyper-V.","properties":{"jobs":{"description":"List of all jobs run for Hyper-V.","type":"array","items":{"$ref":"#/components/schemas/HVHyperVAllJob"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetAllJobsReportResponse","x-go-package":"phoenix/hyperv/cloud/report/spec/job"},"HVGetBackupJobsReportResponse":{"type":"object","title":"GetBackupJobsReportResponse returns a list of all backup jobs run for Hyper-V.","properties":{"jobs":{"description":"List of all backup jobs run for Hyper-V.","type":"array","items":{"$ref":"#/components/schemas/HVHyperVBackupJob"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetBackupJobsReportResponse","x-go-package":"phoenix/hyperv/cloud/report/spec/job"},"HVGetDefreezeJobReportResponse":{"type":"object","title":"GetDefreezeJobReportResponse returns a list of all defreeze jobs run for Hyper-V.","properties":{"jobs":{"description":"List of all defreeze jobs run for Hyper-V.","type":"array","items":{"$ref":"#/components/schemas/HVHyperVDefreezeJob"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetDefreezeJobReportResponse","x-go-package":"phoenix/hyperv/cloud/report/spec/job"},"HVGetRestoreJobsReportResponse":{"type":"object","title":"GetRestoreJobsReportResponse returns a list of all restore jobs run for Hyper-V.","properties":{"jobs":{"description":"List of all restore jobs run for Hyper-V.","type":"array","items":{"$ref":"#/components/schemas/HVHyperVRestoreJob"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetRestoreJobsReportResponse","x-go-package":"phoenix/hyperv/cloud/report/spec/job"},"HVGetUploadLogJobReportResponse":{"type":"object","title":"GetUploadLogJobReportResponse returns a list of all upload logs jobs run for Hyper-V.","properties":{"jobs":{"description":"List of all upload logs jobs run for Hyper-V.","type":"array","items":{"$ref":"#/components/schemas/HVHyperVUploadJob"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetUploadLogJobReportResponse","x-go-package":"phoenix/hyperv/cloud/report/spec/job"},"HVHyperVAllJob":{"type":"object","title":"HyperVAllJob is the response schema for Hyper-V utils.","properties":{"clusterName":{"description":"The name of Cluster","type":"string","x-go-name":"ClusterName"},"endTime":{"description":"The time when the job operation ends. The time is specified in the UTC time zone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"Specifies the error code when the backup operation fails. The possible values are:\\n \\\"0\\\": If the job is successful\\n : If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"Specifies the message for rhe failed job. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"host":{"description":"The name of the Hyper-V host. Multiple host names can be separated by commas. Get the list of the Hyper-V host names using the 'ListHost' API.","type":"string","x-go-name":"Host"},"jobID":{"description":"Specifies a unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"Specifies the type of the job. This parameter can be set to one or more of the following values: Backup, Restore, Log Request and Defreeze. Specify multiple job types by separating them with commas. See Job Types.","type":"string","x-go-name":"JobType"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrganizationName"},"scvmmName":{"description":"The name of System Center Virtual Machine Manager(SCVMM).","type":"string","x-go-name":"SCVMMName"},"startTime":{"description":"The time when the job operation starts. The time is specified in the UTC time zone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","type":"string","x-go-name":"Status"},"vmName":{"description":"The name of the VM for which the job is initiated. Specify multiple VM names by separating them with commas.","type":"string","x-go-name":"VMName"}},"x-go-name":"HyperVAllJob","x-go-package":"phoenix/hyperv/cloud/report/spec/job"},"HVHyperVBackupDataTransfer":{"description":"HyperVBackupDataTransfer is the response schema for Hyper-V BackupData Transfer","type":"object","properties":{"backupDuration":{"description":"Specifies the total time taken to upload data to the Cloud and CloudCache. Backup duration excludes the estimation time, network retry time, and the waiting for retry time.","type":"string","x-go-name":"BackupDuration"},"backupDurationInSeconds":{"description":"Specifies the total time taken in seconds to upload data to the Cloud and CloudCache. Backup duration excludes the estimation time, network retry time, and the waiting for retry time.","type":"integer","format":"int64","x-go-name":"BackupDurationInSeconds"},"backupSpeed":{"description":"Specifies the rate at which the source data is backed up to the Cloud.","type":"string","x-go-name":"BackupSpeed"},"backupSpeedInKBps":{"description":"Specifies the rate at which the source data is backed up to the Cloud in KBps.","type":"number","format":"double","x-go-name":"BackupSpeedInKBps"},"bandwidthConsumed":{"description":"Specifies the bit rate to transfer data from the Cloud and CloudCache.","type":"string","x-go-name":"BandwidthConsumed"},"bandwidthConsumedInKBps":{"description":"Specifies the bit rate in Kilobytes per second to transfer data from the Cloud and CloudCache.","type":"number","format":"double","x-go-name":"BandwidthConsumedInKBps"},"dataTransferCache":{"description":"Specifies the incremental data that is uploaded to CloudCache after deduplication and compression.","type":"string","x-go-name":"DataTransferCache"},"dataTransferCacheInBytes":{"description":"Specifies the incremental data that is uploaded in bytes to CloudCache after deduplication and compression.","type":"integer","format":"uint64","x-go-name":"DataTransferCacheInBytes"},"dataTransferCloud":{"description":"Specifies the incremental data that is uploaded to the Cloud after deduplication and compression.","type":"string","x-go-name":"DataTransferCloud"},"dataTransferCloudInBytes":{"description":"Specifies the incremental data that is uploaded in bytes to the Cloud after deduplication and compression.","type":"integer","format":"uint64","x-go-name":"DataTransferCloudInBytes"}},"x-go-name":"HyperVBackupDataTransfer","x-go-package":"phoenix/hyperv/cloud/report/spec/job"},"HVHyperVBackupExecutionDetails":{"description":"HyperVBackupExecutionDetails is the response schema for Hyper-V Backup Execution Details","type":"object","properties":{"endTime":{"description":"The time when the job operation ends. The time is specified in the UTC time zone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"Specifies the error code when the backup operation fails. The possible values are:\\n \\\"0\\\": If the job is successful\\n : If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"Specifies the message for rhe failed job. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"startTime":{"description":"The time when the job operation starts. The time is specified in the UTC time zone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","type":"string","x-go-name":"Status"}},"x-go-name":"HyperVBackupExecutionDetails","x-go-package":"phoenix/hyperv/cloud/report/spec/job"},"HVHyperVBackupJob":{"type":"object","title":"HyperVBackupJob is the response schema for Hyper-V backup job.","properties":{"backupPolicyID":{"description":"The ID of your backup policy.","format":"int32","type":"integer","x-go-name":"BackupPolicyID"},"backupPolicyName":{"description":"The name of the backup policy attached to the backup set.","type":"string","x-go-name":"BackupPolicyName"},"backupsetID":{"description":"The ID of your backup set.","format":"int32","type":"integer","x-go-name":"BackupsetID"},"clusterName":{"description":"The name of Cluster.","type":"string","x-go-name":"ClusterName"},"dataTransfer":{"$ref":"#/components/schemas/HVHyperVBackupDataTransfer"},"environmentDetails":{"$ref":"#/components/schemas/HVHyperVEnvironmentDetails"},"estimationDetails":{"$ref":"#/components/schemas/HVHyperVEstimationDetails"},"executionDetails":{"$ref":"#/components/schemas/HVHyperVBackupExecutionDetails"},"host":{"description":"The name of the Hyper-V host. Multiple host names can be separated by commas. Get the list of the Hyper-V host names using the 'ListHost' API.","type":"string","x-go-name":"Host"},"jobID":{"description":"Specifies a unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"Specifies the type of the job. This parameter can be set to one or more of the following values: Backup, Restore, Log Request and Defreeze. Specify multiple job types by separating them with commas. See Job Types.","type":"string","x-go-name":"JobType"},"organizationID":{"description":"The ID of your organization.","format":"int32","type":"integer","x-go-name":"OrgID"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrganizationName"},"scvmmName":{"description":"The name of System Center Virtual Machine Manager(SCVMM).","type":"string","x-go-name":"SCVMMName"},"vmName":{"description":"The name of the VM for which the job is initiated. Specify multiple VM names by separating them with commas.","type":"string","x-go-name":"VMName"}},"x-go-name":"HyperVBackupJob","x-go-package":"phoenix/hyperv/cloud/report/spec/job"},"HVHyperVDefreezeJob":{"type":"object","title":"HyperVDefreezeJob is the response schema for Hyper-V Defreeze Job.","properties":{"executionDetails":{"$ref":"#/components/schemas/HVDefreezeExecutionDetailsStruct"},"jobID":{"description":"Specifies a unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"Specifies the type of the job. This parameter can be set to one or more of the following values: Backup, Restore, Log Request and Defreeze. Specify multiple job types by separating them with commas. See Job Types.","type":"string","x-go-name":"JobType"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrganizationName"},"snapshotDefreezed":{"description":"The name of the snapshot for which the defreeze job was initiated.","type":"string","x-go-name":"SnapshotDefreezed"},"vmName":{"description":"The name of the VM for which the job is initiated. Specify multiple VM names by separating them with commas.","type":"string","x-go-name":"VMName"}},"x-go-name":"HyperVDefreezeJob","x-go-package":"phoenix/hyperv/cloud/report/spec/job"},"HVHyperVEnvironmentDetails":{"description":"HyperVEnvironmentDetails is the response schema for Hyper-V EnvironmentDetails","type":"object","properties":{"diskReadRate":{"description":"Specifies the bit rate for reading I/O by the agent. The Disk Read Rate is an average of the total data read with respect to the total time taken to read data at various intervals for all drives where data is distributed.","type":"string","x-go-name":"DiskReadRate"},"diskReadRateInKBps":{"description":"Specifies the bit rate in Kilobytes per second for reading I/O by the agent. The Disk Read Rate is an average of the total data read with respect to the total time taken to read data at various intervals for all drives where data is distributed.","type":"number","format":"double","x-go-name":"DiskReadRateInKBps"},"networkRetries":{"description":"Specifies the number of network retries during the job.","type":"integer","format":"int32","x-go-name":"NetworkRetries"},"networkRetryDuration":{"description":"Specifies the total time spent in the network retries. It represents the cumulative of all network session duration.","type":"string","x-go-name":"NetworkRetryDuration"},"networkRetryDurationInSeconds":{"description":"Specifies the total time spent in seconds in the network retries. It represents the cumulative of all network session duration.","type":"integer","format":"int64","x-go-name":"NetworkRetryDurationInSeconds"}},"x-go-name":"HyperVEnvironmentDetails","x-go-package":"phoenix/hyperv/cloud/report/spec/job"},"HVHyperVEstimationDetails":{"description":"HyperVEstimationDetails struct holds the response for GetBackupJobsReport api","type":"object","properties":{"dataScanned":{"description":"Specifies the total data scanned during the job.","type":"integer","format":"uint64","x-go-name":"DataScanned"},"disksAdded":{"description":"The number of VM disks added at the source during the job.","type":"integer","format":"int64","x-go-name":"DisksAdded"},"disksModified":{"description":"The number of VM disks changed at the source during the job.","type":"integer","format":"int64","x-go-name":"DisksModified"},"disksRemoved":{"description":"The number of VM disks removed at the source during the job.","type":"integer","format":"int64","x-go-name":"DisksRemoved"},"sourceDataScanned":{"description":"Specifies the data scanned at the source in order to backup.","type":"string","x-go-name":"SourceDataScanned"},"sourceDataScannedInBytes":{"description":"Specifies the data scanned in bytes at the source in order to backup.","type":"integer","format":"uint64","x-go-name":"SourceDataScannedInBytes"}},"x-go-name":"HyperVEstimationDetails","x-go-package":"phoenix/hyperv/cloud/report/spec/job"},"HVHyperVRestoreEnvironmentDetails":{"description":"HyperVRestoreEnvironmentDetails struct holds the response for GetRestoreJobsReport api","type":"object","properties":{"diskWriteRate":{"description":"Specifies the bit rate for writing I/O by the agent. The Disk Write Rate is the average of the total data written with respect to the total time taken to write data at various intervals.","type":"string","x-go-name":"DiskWriteRate"},"diskWriteRateInKBps":{"description":"Specifies the bit rate in Kilobytes per second for writing I/O by the agent. The Disk Write Rate is the average of the total data written with respect to the total time taken to write data at various intervals.","type":"number","format":"double","x-go-name":"DiskWriteRateInKBps"},"networkRetries":{"description":"Specifies the number of network retries during the job.","type":"integer","format":"int32","x-go-name":"NetworkRetries"},"networkRetryDuration":{"description":"Specifies the total time spent in the network retries. It represents the cumulative of all network session duration.","type":"string","x-go-name":"NetworkRetryDuration"},"networkRetryDurationInSeconds":{"description":"Specifies the total time spent in seconds in the network retries. It represents the cumulative of all network session duration.","type":"integer","format":"int64","x-go-name":"NetworkRetryDurationInSeconds"}},"x-go-name":"HyperVRestoreEnvironmentDetails","x-go-package":"phoenix/hyperv/cloud/report/spec/job"},"HVHyperVRestoreExecutionDetails":{"description":"HyperVRestoreExecutionDetails is the response schema for Hyper-V Restore Execution Details","type":"object","properties":{"bandwidthConsumed":{"description":"Specifies the bit rate to transfer data from the Cloud and CloudCache.","type":"string","x-go-name":"BandwidthConsumed"},"bandwidthConsumedInKBps":{"description":"Specifies the bit rate in Kilobytes per second to transfer data from the Cloud and CloudCache.","type":"number","format":"double","x-go-name":"BandwidthConsumedInKBps"},"endTime":{"description":"The time when the job operation ends. The time is specified in the UTC time zone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"Specifies the error code when the backup operation fails. The possible values are:\\n \\\"0\\\": If the job is successful\\n : If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"Specifies the message for rhe failed job. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"restoredData":{"description":"Specifies the total amount of data restored.","type":"string","x-go-name":"RestoredData"},"restoredDataInBytes":{"description":"Specifies the total amount of data restored in bytes.","type":"integer","format":"uint64","x-go-name":"RestoredDataInBytes"},"restoredItems":{"description":"Specifies the data items restored.","type":"string","x-go-name":"RestoredItems"},"startTime":{"description":"The time when the job operation starts. The time is specified in the UTC time zone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","type":"string","x-go-name":"Status"}},"x-go-name":"HyperVRestoreExecutionDetails","x-go-package":"phoenix/hyperv/cloud/report/spec/job"},"HVHyperVRestoreJob":{"description":"HyperVRestoreJob is the response schema for Hyper-V Restore Job","type":"object","properties":{"backupsetID":{"description":"The ID of your backup set.","format":"int32","type":"integer","x-go-name":"BackupsetID"},"clusterName":{"description":"The name of Cluster.","type":"string","x-go-name":"ClusterName"},"destinationVMName":{"description":"Specifies the name of the Hyper-V host to which restore was initiated. Specify multiple host names by separating them with commas.","type":"string","x-go-name":"DestinationVMName"},"environmentDetails":{"$ref":"#/components/schemas/HVHyperVRestoreEnvironmentDetails"},"executionDetails":{"$ref":"#/components/schemas/HVHyperVRestoreExecutionDetails"},"host":{"description":"The name of the Hyper-V host. Multiple host names can be separated by commas. Get the list of the Hyper-V host names using the 'ListHost' API.","type":"string","x-go-name":"Host"},"jobID":{"description":"Specifies a unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"Specifies the type of the job. This parameter can be set to one or more of the following values: Backup, Restore, Log Request and Defreeze. Specify multiple job types by separating them with commas. See Job Types.","type":"string","x-go-name":"JobType"},"organizationID":{"description":"The ID of your organization.","format":"int32","type":"integer","x-go-name":"OrgID"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrganizationName"},"restoreType":{"description":"Specifies the name of the restore operation initiated.","type":"string","x-go-name":"RestoreType"},"scvmmName":{"description":"The name of System Center Virtual Machine Manager(SCVMM).","type":"string","x-go-name":"SCVMMName"}},"x-go-name":"HyperVRestoreJob","x-go-package":"phoenix/hyperv/cloud/report/spec/job"},"HVHyperVUploadJob":{"type":"object","title":"HyperVUploadJob is the response schema for Hyper-V Upload Job.","properties":{"environmentDetails":{"$ref":"#/components/schemas/HVUploadLogsEnvironmentStruct"},"executionDetails":{"$ref":"#/components/schemas/HVUploadLogsExecutionDetailsStruct"},"jobID":{"description":"Specifies a unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"Specifies the type of the job. This parameter can be set to one or more of the following values: Backup, Restore, Log Request and Defreeze. Specify multiple job types by separating them with commas. See Job Types.","type":"string","x-go-name":"JobType"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrganizationName"},"vmName":{"description":"The name of the VM for which the job is initiated. Specify multiple VM names by separating them with commas.","type":"string","x-go-name":"VMName"}},"x-go-name":"HyperVUploadJob","x-go-package":"phoenix/hyperv/cloud/report/spec/job"},"HVUploadLogsEnvironmentStruct":{"description":"UploadLogsEnvironmentStruct struct holds the response for GetUploadLogsJobsReport api","type":"object","properties":{"diskWriteRate":{"description":"Specifies the bit rate for writing I/O by the agent. The Disk Write Rate is the average of the total data written with respect to the total time taken to write data at various intervals.","type":"string","x-go-name":"DiskWriteRate"},"networkRetries":{"description":"Specifies the number of network retries during the job.","type":"integer","format":"int32","x-go-name":"NetworkRetries"},"networkRetryDuration":{"description":"Specifies the total time spent in the network retries. It represents the cumulative of all network session duration.","type":"string","x-go-name":"NetworkRetryDuration"}},"x-go-name":"UploadLogsEnvironmentStruct","x-go-package":"phoenix/hyperv/cloud/report/spec/job"},"HVUploadLogsExecutionDetailsStruct":{"description":"UploadLogsExecutionDetailsStruct struct holds the response for GetUploadLogsJobsReport api","type":"object","properties":{"endTime":{"description":"The time when the job operation ends. The time is specified in the UTC time zone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"Specifies the error code when the backup operation fails. The possible values are:\\n \\\"0\\\": If the job is successful\\n : If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"Specifies the message for rhe failed job. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"logsExpiryTime":{"description":"Specifies the expiry time of the uploaded logs.","type":"string","x-go-name":"LogsExpiryTime"},"logsSize":{"description":"Specifies the size of the logs.","type":"string","x-go-name":"LogsSize"},"logsSizeInBytes":{"description":"Specifies the size of the logs in bytes.","type":"integer","format":"uint64","x-go-name":"LogsSizeInBytes"},"sourceJobID":{"description":"Specifies the unique udentification number of the job for which logs are requested.","type":"integer","format":"int32","x-go-name":"SourceJobID"},"sourceJobLogType":{"description":"Specifies the tyoe of the job for which logs are requested.","type":"string","x-go-name":"SourceJobLogType"},"startTime":{"description":"The time when the job operation starts. The time is specified in the UTC time zone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"Specify the status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors and Failed. Specify multiple status values by separating them with commas.","type":"string","x-go-name":"Status"}},"x-go-name":"UploadLogsExecutionDetailsStruct","x-go-package":"phoenix/hyperv/cloud/report/spec/job"},"HVGetBackupPoliciesReportResponse":{"type":"object","title":"GetBackupPoliciesReportResponse returns a list of all backup sets for Hyper-V.","properties":{"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"},"policies":{"description":"List of Hyper-V policies","type":"array","items":{"$ref":"#/components/schemas/HVHyperVPolicies"},"x-go-name":"Policies"}},"x-go-name":"GetBackupPoliciesReportResponse","x-go-package":"phoenix/hyperv/cloud/report/spec/policy"},"HVHyperVPolicies":{"type":"object","title":"HyperVPolicies specifies the description of the backup policy.","properties":{"appliedToVMs":{"description":"Specifies the list of virtual machines to which the backup policy is applied.","type":"array","items":{"type":"string"},"x-go-name":"AppliedToVMs"},"automaticRetry":{"description":"Specifies whether the automatic retry option is enabled or disabled.","type":"boolean","x-go-name":"AutomaticRetry"},"description":{"description":"Description of the policy.","type":"string","x-go-name":"Description"},"ignoreFirstBackupDuration":{"description":"Specifies whether to ignore the specified backup duration for the first backup job.","type":"boolean","x-go-name":"IgnoreBackupDuration"},"dataLock":{"description":"The status indicating if Data Lock is enabled in the backup policy.","type":"boolean","x-go-name":"ImmutabilityEnabled"},"maxRetryCount":{"description":"Specifies the maximum number of retries for a failed backup.","type":"integer","format":"int64","x-go-name":"MaxRetryCount"},"maxRetryDuration":{"description":"Specifies the maximum duration between each retry attempt for a failed backup.","type":"string","x-go-name":"MaxRetryDuration"},"maxRetryDurationInSeconds":{"description":"Specifies the maximum duration in seconds between each retry attempt for a failed backup.","type":"integer","format":"int64","x-go-name":"MaxRetryDurationInSeconds"},"policyID":{"description":"The ID of your backup policy.","type":"integer","format":"int64","x-go-name":"PolicyID"},"policyName":{"description":"Specifies the name of the backup policy.","type":"string","x-go-name":"Name"},"policyType":{"description":"Specifies the type of the backup policy.","type":"string","x-go-name":"PolicyType"},"quiescingEnabled":{"description":"Specifies whether to enable the VMware tools quiescing.","type":"boolean","x-go-name":"QuiescingEnabled"},"retention":{"$ref":"#/components/schemas/HVHyperVPolicyRetentionData"},"schedules":{"description":"Specifies the list of backup schedules.","type":"array","items":{"$ref":"#/components/schemas/HVHyperVPolicySchedule"},"x-go-name":"Schedule"}},"x-go-name":"HyperVPolicies","x-go-package":"phoenix/hyperv/cloud/report/spec/policy"},"HVHyperVPolicyRetentionData":{"description":"HyperVPolicyRetentionData is the response schema for HyperV Policy Retention Data","type":"object","properties":{"allSnapshots":{"description":"Specifies the duration in days to retain all the daily snapshots.","type":"integer","format":"int32","x-go-name":"Daily"},"ltrEnabled":{"description":"The status of the backup set whether enabled for long term retention. For example, True denotes that the backup set is enabled for LTR.","type":"boolean","x-go-name":"LTREnabled"},"monthly":{"description":"Specifies the number of months for which you want to retain the latest monthly snapshot.","type":"integer","format":"int32","x-go-name":"Monthly"},"warmTierDuration":{"description":"Lists the duration in days for which the snapshot will reside in the warm tier of the AWS storage.","type":"integer","format":"int32","x-go-name":"WarmTierDuration"},"weekly":{"description":"Specifies the number of weeks for which you want to retain the latest weekly snapshot.","type":"integer","format":"int32","x-go-name":"Weekly"},"yearly":{"description":"Specifies the number of years for which you want to retain the latest yearly snapshot.","type":"integer","format":"int32","x-go-name":"Yearly"}},"x-go-name":"HyperVPolicyRetentionData","x-go-package":"phoenix/hyperv/cloud/report/spec/policy"},"HVHyperVPolicySchedule":{"description":"HyperVPolicySchedule is the response schema for HyperV Policy Backup Schedule","type":"object","properties":{"bandwidth":{"description":"Specifies the bandwidth that each resource can consume while backing up data to the Cloud.","type":"string","x-go-name":"Bandwidth"},"bandwidthInKBps":{"description":"Specifies the bandwidth in Kilobytes per second that each resource can consume while backing up data to the Cloud.","type":"number","format":"double","x-go-name":"BandwidthInKBps"},"duration":{"description":"Specifies the duration for which the backup job should run.","type":"string","x-go-name":"Duration"},"durationInSeconds":{"description":"Specifies the duration in seconds after which the backup should stop.","type":"integer","format":"int64","x-go-name":"DurationInSeconds"},"repeatOn":{"$ref":"#/components/schemas/JSONStringList"},"startAt":{"description":"Specifies the time when the backup starts.","type":"string","x-go-name":"StartAt"}},"x-go-name":"HyperVPolicySchedule","x-go-package":"phoenix/hyperv/cloud/report/spec/policy"},"ListAlertsResponse":{"description":"Includes an array of alerts","type":"object","properties":{"alerts":{"type":"array","items":{"$ref":"#/components/schemas/Alert"}},"nextPageToken":{"type":"string"}}},"APIError":{"description":"APIError defines an application error result format","type":"object","properties":{"code":{"type":"string","x-go-name":"Code"},"data":{"type":"object","additionalProperties":{"type":"object"},"x-go-name":"Data"},"message":{"type":"string","x-go-name":"Message"},"retryable":{"type":"boolean","x-go-name":"Retry"}},"x-go-package":"phoenix/vendor/druva.com/godevkit/errortype"},"Alert":{"description":"Includes generic alert details","type":"object","properties":{"id":{"description":"Alert ID","type":"integer","format":"int32","example":1},"type":{"description":"Alert type, for example, jobs, storage, and cloudcache.","type":"string","example":"jobs"},"subtype":{"description":"Alert subtype, for example, backupFailures, and restoreFailures.","type":"string","example":"backupFailures"},"generatedOn":{"description":"Alert generation timestamp. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","example":"2019-07-09T05:08:16Z"},"OrgID":{"description":"Organization ID","type":"integer","format":"int32","example":1},"workloadType":{"description":"Type of the workload. The value can be fs, sql, nas, vmware, hyperv, or oracle.","type":"string","example":"vmware"},"targetType":{"description":"Target type of the alert","type":"string","example":"jobs"},"targetID":{"description":"Target ID of the alert. In the case of job alerts, targetID is same as the jobID of the job.","type":"integer","format":"int32","example":1},"resourceType":{"description":"Type of resource. The value can be physicalServer, vmwareVM, hyperVM, nasShare, sqlAvailabilityGroup, sqlStandaloneInstance, or oracle.","type":"string","example":"device"},"resourceName":{"description":"Name of the resource.","type":"string","example":"hostname"},"status":{"description":"The status of the alert. The value can be resolved or active.","type":"string","example":"active"},"resolutionTime":{"description":"Alert resolution timestamp. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","example":"NA"},"severity":{"description":"Severity of the alert. The value can be critical, warning, or info.","type":"string","example":"critical"}}},"ListBackupAlertsResponse":{"description":"Includes an array of alerts","type":"object","properties":{"alerts":{"type":"array","items":{"$ref":"#/components/schemas/BackupJobAlert"}},"nextPageToken":{"type":"string"}}},"BackupJobAlert":{"description":"Includes generic, alert type specific and resource specific details","type":"object","properties":{"id":{"description":"Alert ID","type":"integer","format":"int32","example":1},"type":{"description":"Alert type, for example, jobs, storage, and cloudcache.","type":"string","example":"jobs"},"subtype":{"description":"Alert subtype, for example, backupFailures, and restoreFailures.","type":"string","example":"backupFailures"},"generatedOn":{"description":"Alert generation timestamp. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","example":"2019-07-09T05:08:16Z"},"OrgID":{"description":"Organization ID","type":"integer","format":"int32","example":1},"workloadType":{"description":"Type of the workload. The value can be fs, sql, nas, vmware, hyperv, or oracle.","type":"string","example":"vmware"},"targetType":{"description":"Target type of the alert","type":"string","example":"jobs"},"targetID":{"description":"Target ID of the alert. In the case of job alerts, targetID is same as the jobID of the job.","type":"integer","format":"int32","example":1},"resourceType":{"description":"Type of resource. The value can be physicalServer, vmwareVM, hyperVM, nasShare, sqlAvailabilityGroup, sqlStandaloneInstance, or oracle.","type":"string","example":"device"},"resourceName":{"description":"Name of the resource.","type":"string","example":"hostname"},"status":{"description":"The status of the alert. The value can be resolved or active.","type":"string","example":"active"},"resolutionTime":{"description":"Alert resolution timestamp. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","example":"NA"},"severity":{"description":"Severity of the alert. The value can be critical, warning, or info.","type":"string","example":"critical"},"alertDetails":{"$ref":"#/components/schemas/AlertDetails"},"resourceInfo":{"$ref":"#/components/schemas/ResourceInfo"}}},"AlertDetails":{"description":"Contains backup job specific details. Only failedJobIDs and lastSucceeded will be present if failureNumberSinceLastSuccess field is specified. jobID, jobErrorMsg, jobStartTime and jobEndTime will be present for all other cases","type":"object","properties":{"jobID":{"description":"ID of the job","type":"integer","format":"int32","example":1},"jobStartTime":{"description":"Timestamp at which the job started","type":"string","example":"2019-07-08T03:38:22.000Z"},"jobEndTime":{"description":"Timestamp at which the job ended","type":"string","example":"2019-07-08T05:52:36.000Z"},"jobErrorMsg":{"description":"Error message stating the reason for job failure","type":"string","example":"error message"},"failedJobIDs":{"description":"List of failed job IDs since the last successful job","type":"array","items":{"type":"integer","format":"int32","example":1}},"lastSucceeded":{"description":"The last backup job completion timestamp. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","example":"2019-07-05T03:38:22.000Z"}}},"ResourceInfo":{"description":"Contains product-specific information of the resource","type":"object","properties":{"fsServerName":{"type":"string","description":"Server name of the FS backup set","example":"serverName"},"fsContentRule":{"type":"string","description":"Content rule of the FS backup set","example":"contentRule"},"nasShare":{"type":"string","description":"Path to the directory of the NAS share","example":"sharename"},"sqlResourceType":{"type":"string","description":"Type of the SQL resource. The value can be sqlAvailabilityGroup or sqlStandaloneInstance.","example":"instance"},"sqlResourceName":{"type":"string","description":"Name of the SQL resource","example":"instanceName"},"sqlContentRule":{"type":"string","description":"Content rule of the SQL resource","example":"contentRule"},"oracleMountPoint":{"type":"string","description":"Mount point of the Oracle resource","example":"mountPoint"},"oraclePBS":{"type":"string","description":"Device name of the Oracle resource","example":"deviceName"},"vmName":{"type":"string","description":"Name of the virtual machine","example":"vmName"}}},"SQLGetAllJobsReport":{"description":"GetAllJobsReport struct holds the response for GetAllJobsReport api","type":"object","properties":{"backupContent":{"$ref":"#/components/schemas/JSONMap"},"endTime":{"description":"The time when the job completes. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"The error code for the failed jobs. The possible values are:\n\\\"0\\\": If the job is successful\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"The error message for failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"jobID":{"description":"The unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"The type of the job. The job type can be \"Backup\", \"Restore\", \"Log Request\", and \"Defreeze\".","type":"string","x-go-name":"JobType"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"resourceID":{"description":"The unique identification number associated with the resource.","type":"integer","format":"int32","x-go-name":"ResourceID"},"resourceName":{"description":"The name of the SQL resource.","type":"string","x-go-name":"ReSourceName"},"resourceType":{"description":"The type of SQL resource. The resource type can be \"SA\" or \"AG\".","type":"string","x-go-name":"ResourceType"},"scheduleTime":{"description":"The date and time when the job starts or is scheduled to start. The time is specified in UTC in the format YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"ScheduleTime"},"startTime":{"description":"The time when the job starts. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"The status of the job.","type":"string","enum":["Queued","Running","Successful","Successful with errors","Failed"],"x-go-name":"Status"}},"x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"SQLGetAllJobsReportRequest":{"description":"GetAllJobsReportRequest is the request schema for GetAllJobsReport","type":"object","required":["OrgID"],"properties":{"fromTime":{"description":"Specify the date and time to filter jobs that were run after the specified timestamp. Specify the date and time in UTC format and must be greater than the value of (current time - 6 months). The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"integer","format":"int64","x-go-name":"StartTime"},"jobType":{"description":"The type of the job. This parameter can be set to one or more of the following values: Backup, Restore, Log Request, and Defreeze. Specify multiple job types by separating them with commas.\nin: query","type":"string","x-go-name":"JobType"},"OrgID":{"description":"The unique identification number of your organization. Set it to \"0\" to select all organizations.","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"},"resourceName":{"description":"The name of the SQL Server for which the job is initiated. Specify multiple resource names by separating them with commas.\nin: query","type":"string","x-go-name":"SQLResourceName"},"resourceType":{"description":"The type of the resource whether it is a standalone instance (SA) or an availability group (AG).\nin: query","type":"string","x-go-name":"SQLResourceType"},"sortOrder":{"description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.\nin: query","type":"string","x-go-name":"SortOrder"},"status":{"description":"The status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors, and Failed. Specify multiple status values by separating them with commas.\nin: query","type":"string","x-go-name":"Status"},"toTime":{"description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"integer","format":"int64","x-go-name":"EndTime"}},"x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"SQLGetBackupJobReportRequest":{"description":"GetBackupJobReportRequest is the request schema for GetBackupJobReport","type":"object","required":["OrgID"],"properties":{"fromTime":{"description":"Specify the date and time to filter jobs that were run after the specified timestamp. Specify the date and time in UTC format and must be greater than the value of (current time - 6 months). The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"integer","format":"int64","x-go-name":"StartTime"},"OrgID":{"description":"The unique identification number of your organization. Set it to \"0\" to select all organizations.","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"},"resourceName":{"description":"The name of the SQL Server for which the job is initiated. Specify multiple resource names by separating them with commas.\nin: query","type":"string","x-go-name":"SQLResourceName"},"resourceType":{"description":"The type of the resource whether it is a standalone instance (SA) or an availability group (AG).\nin: query","type":"string","x-go-name":"SQLResourceType"},"sortOrder":{"description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.\nin: query","type":"string","x-go-name":"SortOrder"},"status":{"description":"The status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors, and Failed. Specify multiple status values by separating them with commas.\nin: query","type":"string","x-go-name":"Status"},"toTime":{"description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"integer","format":"int64","x-go-name":"EndTime"}},"x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"SQLGetBackupsetsRequest":{"description":"GetBackupsetsRequest is the request schema for GetBackupsets","type":"object","required":["OrgID"],"properties":{"backupEnable":{"description":"Specifies whether the backupset is enabled for backup operation.","type":"boolean","x-go-name":"BackupEnable"},"OrgID":{"description":"The unique identification number of your organization. Set it to \"0\" to select all organizations.","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"},"resourceName":{"description":"The name of the SQL resource. Multiple resource names can be separated with commas.\nin: query","type":"string","x-go-name":"ResourceName"},"resourceType":{"description":"The resource type of the SQL server, such as standalone instance (SA) or an availability group (AG).\nin: query","type":"string","x-go-name":"SQLResourceType"}},"x-go-package":"phoenix/sqlserver/cloud/report/spec/backupsets"},"SQLGetDefreezeJobReportRequest":{"description":"GetDefreezeJobReportRequest is the request schema for GetDefreezeJobReport","type":"object","required":["OrgID"],"properties":{"fromTime":{"description":"Specify the date and time to filter jobs that were run after the specified timestamp. Specify the date and time in UTC format and must be greater than the value of (current time - 6 months). The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"integer","format":"int64","x-go-name":"StartTime"},"OrgID":{"description":"The unique identification number of your organization. Set it to \"0\" to select all organizations.","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"},"resourceName":{"description":"The name of the SQL Server for which the job is initiated. Specify multiple resource names by separating them with commas.\nin: query","type":"string","x-go-name":"SQLResourceName"},"resourceType":{"description":"The type of the resource whether it is a standalone instance (SA) or an availability group (AG).","type":"string","x-go-name":"SQLResourceType"},"sortOrder":{"description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.\nin: query","type":"string","x-go-name":"SortOrder"},"status":{"description":"The status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors, and Failed. Specify multiple status values by separating them with commas.\nin: query","type":"string","x-go-name":"Status"},"toTime":{"description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"integer","format":"int64","x-go-name":"EndTime"}},"x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"SQLGetPoliciesRequest":{"description":"GetPoliciesRequest is the request schema for GetPolicies","type":"object","required":["OrgID"],"properties":{"OrgID":{"description":"The unique identification number of your organization. Set it to \"0\" to select all organizations.","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"}},"x-go-package":"phoenix/sqlserver/cloud/report/spec/policies"},"SQLGetRestoreJobReportRequest":{"description":"GetRestoreJobReportRequest is the request schema for GetRestoreJobReport","type":"object","required":["OrgID"],"properties":{"destServerName":{"description":"The name of the SQL server to which the restore job is initiated. Specify multiple server names by separating them with commas.\nin: query","type":"string","x-go-name":"DestServerName"},"fromTime":{"description":"Specify the date and time to filter jobs that were run after the specified timestamp. Specify the date and time in UTC format and must be greater than the value of (current time - 6 months). The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"integer","format":"int64","x-go-name":"StartTime"},"OrgID":{"description":"The unique identification number of your organization. Set it to \"0\" to select all organizations.","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"},"resourceName":{"description":"The name of the SQL Server for which the backup job is initiated. Specify multiple resource names by separating them with commas.\nin: query","type":"string","x-go-name":"SourceDeviceName"},"resourceType":{"description":"The type of the resource whether it is a standalone instance (SA) or an availability group (AG).\nin: query","type":"string","x-go-name":"SQLResourceType"},"sortOrder":{"description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.\nin: query","type":"string","x-go-name":"SortOrder"},"status":{"description":"The status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors, and Failed. Specify multiple status values by separating them with commas.\nin: query","type":"string","x-go-name":"Status"},"toTime":{"description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"integer","format":"int64","x-go-name":"EndTime"}},"x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"SQLGetUploadLogJobReportRequest":{"description":"GetUploadLogJobReportRequest is the request schema for GetUploadLogJobReport","type":"object","required":["OrgID"],"properties":{"fromTime":{"description":"Specify the date and time to filter jobs that were run after the specified timestamp. Specify the date and time in UTC format and must be greater than the value of (current time - 6 months). The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"integer","format":"int64","x-go-name":"StartTime"},"OrgID":{"description":"The unique identification number of your organization. Set it to \"0\" to select all organizations.","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"},"resourceName":{"description":"The name of the SQL Server for which the job is initiated. Specify multiple resource names by separating them with commas.\nin: query","type":"string","x-go-name":"SQLResourceName"},"resourceType":{"description":"The type of the resource whether it is a standalone instance (SA) or an availability group (AG).\nin: query","type":"string","x-go-name":"SQLResourceType"},"sortOrder":{"description":"Sort the API results by the scheduled time of the job, either in ascending or descending order. Set the sortOrder value to ASC or DESC. The default value is ASC.\nin: query","type":"string","x-go-name":"SortOrder"},"status":{"description":"The status of the job. This parameter can be set to one or more of the following values: Queued, Running, Successful, Successful with errors, and Failed. Specify multiple status values by separating them with commas.\nin: query","type":"array","items":{"type":"integer","format":"int32"},"x-go-name":"Status"},"toTime":{"description":"Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.\nin: query","type":"integer","format":"int64","x-go-name":"EndTime"}},"x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"JSONMap":{"description":"Returns the data for the current job.","type":"object","additionalProperties":{"type":"object"},"x-go-package":"phoenix/pkg/dlutil"},"SQLListPoliciesFilter":{"description":"ListPoliciesFilter is filter structure to be passed while listing policies","type":"object","properties":{"IDs":{"type":"array","items":{"type":"integer","format":"int64"}}},"x-go-package":"phoenix/sqlserver/cloud/report/spec/policies"},"SQLListSQLAvailabilityGroupRequest":{"description":"ListSQLAvailabilityGroupRequest is the request schema for ListSQLAvailabilityGroup","type":"object","required":["OrgID"],"properties":{"OrgID":{"description":"The unique identification number of your organization. Set it to \"0\" to select all organizations.","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"},"resourceName":{"description":"The name of the SQL availability groups.\nin: query","type":"string","x-go-name":"SQLResourceName"},"resourceType":{"description":"The SQL resource type such as an availability group (AG).\nin: query","type":"string","x-go-name":"SQLResourceType"}},"x-go-package":"phoenix/sqlserver/cloud/report/spec/availabilitygroup"},"SQLListSQLInstancesRequest":{"description":"ListSQLInstancesRequest is the request schema for ListSQLInstances","type":"object","required":["OrgID"],"properties":{"OrgID":{"description":"The unique identification number of your organization. Set it to \"0\" to select all organizations.","type":"integer","format":"int32"},"pageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request.\nin: query","type":"string","x-go-name":"PageToken"},"resourceName":{"description":"The resource name of the SQL instance.\nin: query","type":"string","x-go-name":"SQLResourceName"},"resourceType":{"description":"The SQL rsource type, such as a standalone instance (SA) or an availability group (AG).\nin: query","type":"string","x-go-name":"SQLResourceType"}},"x-go-package":"phoenix/sqlserver/cloud/report/spec/instances"},"SQLBackupContentStruct":{"type":"object","title":"BackupContentStruct : Details of the content rule.","properties":{"configuredDatabases":{"description":"The list of the configured databases. This parameter will be skipped if the value is NULL.","type":"array","items":{"type":"string"},"x-go-name":"ConfiguredDBNames"},"excludeDBPattern":{"description":"The list of DB Pattern according to which databases are excluded from the backup. This parameter will be skipped if the value is NULL.","type":"array","items":{"type":"string"},"x-go-name":"ExcludeDBPattern"},"includeAllDBs":{"description":"Whether to include all databases or not.","type":"boolean","x-go-name":"IncludeAllDBs"},"includeAllInstances":{"description":"Whether to include all instances or not.","type":"boolean","x-go-name":"IncludeAllInstances"},"includeDBList":{"description":"The list of databases included in the backup. This parameter will be skipped if the value is NULL.","type":"array","items":{"type":"string"},"x-go-name":"IncludeDBList"},"includeDBPattern":{"description":"The list of DB Patterns according to which the databases are included for backup. This parameter will be skipped if the value is NULL.","type":"array","items":{"type":"string"},"x-go-name":"IncludeDBpattern"},"includeInstanceList":{"description":"The list of instances included from the backup operation.","type":"array","items":{"type":"string"},"x-go-name":"IncludeInstanceList"}},"x-go-name":"BackupContentStruct","x-go-package":"phoenix/sqlserver/cloud/report/spec/backupsets"},"SQLBackupsetInfo":{"description":"BackupsetInfo is response schema for GetBackupsets","type":"object","properties":{"backupContent":{"$ref":"#/components/schemas/SQLBackupContentStruct"},"backupEnabled":{"description":"Backupset enabled/disabled","type":"boolean","x-go-name":"BackupEnabled"},"backupPolicyID":{"description":"The ID of your backup policy.","format":"int64","type":"integer","x-go-name":"BackupPolicyID"},"backupPolicyName":{"description":"The name of the backup policy attached to the backup set.","type":"string","x-go-name":"BackupPolicyName"},"backupsetID":{"description":"The ID of your backup set.","format":"int32","type":"integer","x-go-name":"BackupsetID"},"backupsetName":{"description":"The name of the backup set.","type":"string","x-go-name":"BackupsetName"},"dataLock":{"description":"The status indicating if Data Lock is enabled for the backup set.","type":"boolean","x-go-name":"Immutability"},"lastBackupDetails":{"$ref":"#/components/schemas/SQLLastBackupDetailsStruct"},"organizationID":{"description":"The ID of your organization.","format":"int32","type":"integer","x-go-name":"OrgID"},"ltrEnabled":{"description":"The status of the backup set whether enabled for long term retention. For example, True denotes that the backup set is enabled for LTR.","type":"boolean","x-go-name":"LTREnabled"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"resourceName":{"description":"The name of the SQL Server.","type":"string","x-go-name":"ServerName"},"resourceType":{"description":"The type of the SQL Server, such as a standalone instance (SA) or an availability group (AG).","type":"string","x-go-name":"ResourceType"},"storageName":{"description":"The name of the storage.","type":"string","x-go-name":"StorageName"},"warmTierDuration":{"description":"Lists the duration in days for which the snapshot will reside in the warm tier of the AWS storage.","type":"integer","format":"int32","x-go-name":"WarmTierDuration"}},"x-go-name":"BackupsetInfo","x-go-package":"phoenix/sqlserver/cloud/report/spec/backupsets"},"SQLDataTransferStruct":{"description":"DataTransferStruct struct holds the response for GetBackupJobsReport api","type":"object","properties":{"backupDuration":{"description":"Specifies the total time taken to upload data to the Cloud and CloudCache. Backup duration excludes the estimation time, network retry time, and the waiting for retry time.","type":"string","x-go-name":"BackupDuration"},"backupDurationInSeconds":{"description":"Specifies the total time taken in seconds to upload data to the Cloud and CloudCache. Backup duration excludes the estimation time, network retry time, and the waiting for retry time.","type":"integer","format":"int64","x-go-name":"BackupDurationInSeconds"},"backupSpeed":{"description":"Specifies the rate at which the source data is backed up to the Cloud.","type":"string","x-go-name":"BackupSpeed"},"backupSpeedInKBps":{"description":"Specifies the rate in Kilobytes per second at which the source data is backed up to the Cloud.","type":"number","format":"double","x-go-name":"BackupSpeedInKBps"},"bandwidthConsumed":{"description":"Specifies the bit rate to transfer data from the Cloud and CloudCache.","type":"string","x-go-name":"BandwidthConsumed"},"bandwidthConsumedInKBps":{"description":"Specifies the bit rate in Kilobytes per second to transfer data from the Cloud and CloudCache.","type":"number","format":"double","x-go-name":"BandwidthConsumedInKBps"},"dataTransferCache":{"description":"Specifies the incremental data that is uploaded to CloudCache after deduplication and compression.","type":"string","x-go-name":"DataTransferCache"},"dataTransferCacheInBytes":{"description":"Specifies the incremental data in bytes that is uploaded to CloudCache after deduplication and compression.","type":"integer","format":"uint64","x-go-name":"DataTransferCacheInBytes"},"dataTransferCloud":{"description":"Specifies the incremental data that is uploaded to the Cloud after deduplication and compression.","type":"string","x-go-name":"DataTransferCloud"},"dataTransferCloudInBytes":{"description":"Specifies the incremental data in bytes that is uploaded to the Cloud after deduplication and compression.","type":"integer","format":"uint64","x-go-name":"DataTransferCloudInBytes"}},"x-go-name":"DataTransferStruct","x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"SQLDefreezeExecDetailsStruct":{"description":"DefreezeExecDetailsStruct struct holds the response for GetDefreezeJobsReport api","type":"object","properties":{"endTime":{"description":"The time when the job completes. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"Specifies the error code for the failed jobs. The possible values are:\n \\\"0\\\": If the job is successful\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"Specifies the error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"startTime":{"description":"The time when the job starts. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"Status of the job.","type":"string","enum":["Queued","Running","Successful","Successful with errors","Failed"],"x-go-name":"Status"}},"x-go-name":"DefreezeExecDetailsStruct","x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"SQLEnvironmentStruct":{"description":"EnvironmentStruct struct holds the response for GetBackupJobsReport api","type":"object","properties":{"diskReadRate":{"description":"Specifies the bit rate for reading I/O by the agent. The Disk Read Rate is an average of the total data read with respect to the total time taken to read data at various intervals for all drives where data is distributed.","type":"string","x-go-name":"DiskReadRate"},"diskReadRateInKBps":{"description":"Specifies the bit rate in Kilobytes per second for reading I/O by the agent. The Disk Read Rate is an average of the total data read with respect to the total time taken to read data at various intervals for all drives where data is distributed.","type":"number","format":"double","x-go-name":"DiskReadRateInKBps"},"networkRetries":{"description":"The number of retries during the job due to network issues.","type":"integer","format":"int32","x-go-name":"NetworkRetries"},"networkRetryDuration":{"description":"Specifies the total time spent in the network retries. It represents the cumulative of all network session duration.","type":"string","x-go-name":"NetworkRetryDuration"},"networkRetryDurationInSeconds":{"description":"Specifies the total time spent in seconds in the network retries. It represents the cumulative of all network session duration.","type":"integer","format":"int64","x-go-name":"NetworkRetryDurationInSeconds"}},"x-go-name":"EnvironmentStruct","x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"SQLEstimationDetailsStruct":{"description":"EstimationDetailsStruct struct holds the response for GetBackupJobsReport api","type":"object","properties":{"backupType":{"description":"The type of backup, such as Full, Differential, or Transaction Log.","type":"string","x-go-name":"BackupType"},"dbsAdded":{"description":"The number of databases added at the source during the job.","type":"integer","format":"int64","x-go-name":"DBsAdded"},"dbsChanged":{"description":"The number of databases changed at the source during the job.","type":"integer","format":"int64","x-go-name":"DBsChanged"},"dbsRemoved":{"description":"The number of databases removed at the source during the job.","type":"integer","format":"int64","x-go-name":"DBsRemoved"},"estimationTimeTaken":{"description":"Specifies the approximate time taken to scan the data.","type":"string","x-go-name":"EstimationTimeTaken"},"estimationTimeTakenInSeconds":{"description":"Specifies the approximate time taken in seconds to scan the data.","type":"integer","format":"int64","x-go-name":"EstimationTimeTakenInSeconds"},"sourceDataScanned":{"description":"Specifies the data scanned in at the source in order to backup.","type":"string","x-go-name":"SourceDataScanned"},"sourceDataScannedInBytes":{"description":"Specifies the data scanned in bytes at the source in order to backup.","type":"integer","format":"uint64","x-go-name":"SourceDataScannedInBytes"}},"x-go-name":"EstimationDetailsStruct","x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"SQLExecutionDetailsStruct":{"description":"ExecutionDetailsStruct struct holds the response for GetBackupJobsReport api","type":"object","properties":{"endTime":{"description":"The time when the job completes. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"Specifies the error code for the failed jobs. The possible values are:\n \\\"0\\\": If the job is successful\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"Specifies the error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"startTime":{"description":"The time when the job starts. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"The status of the job.","type":"string","enum":["Queued","Running","Successful","Successful with errors","Failed."],"x-go-name":"Status"}},"x-go-name":"ExecutionDetailsStruct","x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"SQLGetAllJobsReportResponse":{"description":"GetAllJobsReportResponse is the response schema for GetAllJobsReport","type":"object","properties":{"Jobs":{"type":"array","items":{"$ref":"#/components/schemas/SQLGetAllJobsReport"}},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetAllJobsReportResponse","x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"SQLGetBackupJobReportResponse":{"description":"GetBackupJobReportResponse is the response schema for GetBackupJobReport","type":"object","properties":{"Jobs":{"type":"array","items":{"$ref":"#/components/schemas/SQLGetBackupJobsReport"}},"nextPageToken":{"description":"The page token value for the next set of API results. The value of this parameter is NULL for the last set of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetBackupJobReportResponse","x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"SQLGetBackupJobsReport":{"description":"GetBackupJobsReport struct holds the response for GetBackupJobsReport api","type":"object","properties":{"backupContent":{"$ref":"#/components/schemas/JSONMap"},"backupPolicyID":{"description":"The ID of your backup policy.","format":"int64","type":"integer","x-go-name":"BackupPolicyID"},"backupPolicyName":{"description":"The name of the backup policy.","type":"string","x-go-name":"BackupPolicyName"},"backupsetID":{"description":"The ID of your backup set.","format":"int32","type":"integer","x-go-name":"BackupsetID"},"dataTransfer":{"$ref":"#/components/schemas/SQLDataTransferStruct"},"environmentDetails":{"$ref":"#/components/schemas/SQLEnvironmentStruct"},"estimationDetails":{"$ref":"#/components/schemas/SQLEstimationDetailsStruct"},"executionDetails":{"$ref":"#/components/schemas/SQLExecutionDetailsStruct"},"jobID":{"description":"The unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"The type of the job.","type":"string","enum":["Backup","Restore","Log Request","Defreeze."],"x-go-name":"JobType"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"organizationID":{"description":"The ID of your organization.","format":"int32","type":"integer","x-go-name":"OrgID"},"resourceID":{"description":"The unique identification number associated with the resource.","type":"integer","format":"int32","x-go-name":"ResourceID"},"resourceName":{"description":"The name of the SQL resource.","type":"string","x-go-name":"SQLResourceName"},"resourceType":{"description":"The type of SQL Resource,such as an availability group (AG) or a standalone instance (SA).","type":"string","x-go-name":"SQLResourceType"},"scheduleTime":{"description":"The date and time when the job starts or is scheduled to start. The time is specified in UTC in the format YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"ScheduleTime"}},"x-go-name":"GetBackupJobsReport","x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"SQLGetBackupsetsResponse":{"description":"GetBackupsetsResponse is response schema for GetBackupsets","type":"object","properties":{"backupsets":{"type":"array","items":{"$ref":"#/components/schemas/SQLBackupsetInfo"},"x-go-name":"Backupsets"},"nextPageToken":{"description":"The page token value for the next set of API results. The value of this parameter is NULL for the last set of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetBackupsetsResponse","x-go-package":"phoenix/sqlserver/cloud/report/spec/backupsets"},"SQLGetDefreezeJobReportResponse":{"description":"GetDefreezeJobReportResponse is the response schema for GetDefreezeJobReport","type":"object","properties":{"Jobs":{"type":"array","items":{"$ref":"#/components/schemas/SQLGetDefreezeJobsReport"}},"nextPageToken":{"description":"The page token value for the next set of API results. The value of this parameter is NULL for the last set of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetDefreezeJobReportResponse","x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"SQLGetDefreezeJobsReport":{"description":"GetDefreezeJobsReport struct holds the response for GetDefreezeJobsReport api","type":"object","properties":{"backupContent":{"$ref":"#/components/schemas/JSONMap"},"executionDetails":{"$ref":"#/components/schemas/SQLDefreezeExecDetailsStruct"},"jobID":{"description":"The unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"The type of the job.","type":"string","enum":["Backup","Restore","Log Request","Defreeze"],"x-go-name":"JobType"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"resourceName":{"description":"The name of the SQL resource.","type":"string","x-go-name":"SQLResourceName"},"resourceType":{"description":"The type of SQL resource, such as an availability group (AG) or a standalone instance (SA).","type":"string","x-go-name":"SQLResourceType"},"scheduleTime":{"description":"The date and time when the job starts or is scheduled to start. The time is specified in UTC in the format YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"ScheduleTime"},"snapshotDefreezed":{"description":"The name of the restore point for which the defreeze job is initiated.","type":"string","x-go-name":"RPName"}},"x-go-name":"GetDefreezeJobsReport","x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"SQLGetPolicies":{"description":"GetPolicies struct holds the response for GetPolicies api","type":"object","properties":{"automaticRetry":{"description":"Whether the automatic retry option is enabled.","type":"boolean","x-go-name":"AutomaticRetry"},"dataLock":{"description":"The status indicating if Data Lock is enabled in the backup policy.","type":"boolean","x-go-name":"Immutability"},"description":{"description":"The description of the policy.","type":"string","x-go-name":"Description"},"ignoreFirstBackupDuration":{"description":"Whether the backup duration is to be ignored for the first backup.","type":"boolean","x-go-name":"IgnoreBackupDuration"},"maxRetryCount":{"description":"The maximum retry count for the job operation. This parameter will be skipped if the value is NULL.","type":"integer","format":"int64","x-go-name":"MaxRetryCount"},"maxRetryDuration":{"description":"Specifies the wait interval before the job is retried.","type":"string","x-go-name":"MaxRetryDuration"},"maxRetryDurationInSeconds":{"description":"Specifies the wait interval in seconds before the job is retried.","type":"integer","format":"int64","x-go-name":"MaxRetryDurationInSeconds"},"policyID":{"description":"The ID of your backup policy.","type":"integer","format":"int64","x-go-name":"PolicyID"},"policyName":{"description":"The name of the policy.","type":"string","x-go-name":"PolicyName"},"policyType":{"description":"The type of the policy.","type":"string","x-go-name":"PolicyType"},"retention":{"$ref":"#/components/schemas/SQLRetentionPolicy"},"schedules":{"description":"The schedule information for backup. This parameter will be skipped if the value is NULL.","type":"array","items":{"$ref":"#/components/schemas/SQLSchedules"},"x-go-name":"Schedules"},"transactionLogsBackup":{"description":"The Transaction log schedule information for backup. This parameter will be skipped if the value is NULL.","type":"array","items":{"$ref":"#/components/schemas/SQLTransactionlogSchedule"},"x-go-name":"TransactionlogSchedule"}},"x-go-name":"GetPolicies","x-go-package":"phoenix/sqlserver/cloud/report/spec/policies"},"SQLGetPoliciesResponse":{"description":"GetPoliciesResponse is response schema for GetPolicies","type":"object","properties":{"nextPageToken":{"description":"The page token value for the next set of API results. The value of this parameter is NULL for the last set of results.","type":"string","x-go-name":"OutToken"},"policies":{"type":"array","items":{"$ref":"#/components/schemas/SQLGetPolicies"},"x-go-name":"Policies"}},"x-go-name":"GetPoliciesResponse","x-go-package":"phoenix/sqlserver/cloud/report/spec/policies"},"SQLGetRestoreJobReportResponse":{"description":"GetRestoreJobReportResponse is the response schema for GetRestoreJobReport","type":"object","properties":{"Jobs":{"type":"array","items":{"$ref":"#/components/schemas/SQLGetRestoreJobsReport"}},"nextPageToken":{"description":"The page token value for the next set of API results. The value of this parameter is NULL for the last set of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetRestoreJobReportResponse","x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"SQLGetRestoreJobsReport":{"description":"GetRestoreJobsReport struct holds the response for GetRestoreJobsReport api","type":"object","properties":{"backupContent":{"$ref":"#/components/schemas/JSONMap"},"backupsetID":{"description":"The ID of your backup set.","format":"int32","type":"integer","x-go-name":"BackupsetID"},"destinationLocation":{"description":"The destination location for restore.","type":"string","x-go-name":"DestinationLocation"},"destinationServerName":{"description":"The name of the SQL server to which the restore was initiated.","type":"string","x-go-name":"DestinationServerName"},"environmentDetails":{"$ref":"#/components/schemas/SQLRestoreEnvironmentStruct"},"executionDetails":{"$ref":"#/components/schemas/SQLRestoreExecutionDetailsStruct"},"jobID":{"description":"The unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"The type of the job.","type":"string","enum":["Backup","Restore","Log Request","Defreeze"],"x-go-name":"JobType"},"organizationID":{"description":"The ID of your organization.","format":"int32","type":"integer","x-go-name":"OrgID"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"resourceID":{"description":"The unique identification number associated with the resource.","type":"integer","format":"int32","x-go-name":"ResourceID"},"resourceName":{"description":"The name of the SQL Server resource for which the backup was initiated.","type":"string","x-go-name":"SourceResourceName"},"resourceType":{"description":"The type of SQL resource, such as an availability group (AG) or a standalone instance (SA).","type":"string","x-go-name":"SQLResourceType"},"scheduleTime":{"description":"The date and time when the job starts or is scheduled to start. The time is specified in UTC in the format YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"ScheduleTime"},"sourceServerName":{"description":"The name (FQDN) of the SQL server host on which the backup was initiated.","type":"string","x-go-name":"SourceServerName"}},"x-go-name":"GetRestoreJobsReport","x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"SQLGetUploadLogJobReportResponse":{"description":"GetUploadLogJobReportResponse is the response schema for GetUploadLogJobReport","type":"object","properties":{"Jobs":{"type":"array","items":{"$ref":"#/components/schemas/SQLGetUploadLogJobsReport"}},"nextPageToken":{"description":"The page token value for the next set of API results. The value of this parameter is NULL for the last set of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetUploadLogJobReportResponse","x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"SQLGetUploadLogJobsReport":{"description":"GetUploadLogJobsReport struct holds the response for GetUploadLogJobsReport api","type":"object","properties":{"executionDetails":{"$ref":"#/components/schemas/SQLUploadLogExecDetailsStruct"},"jobID":{"description":"The unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"The type of the job.","type":"string","enum":["Backup","Restore","Log Request","Defreeze"],"x-go-name":"JobType"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"resourceName":{"description":"The name of the SQL resource.","type":"string","x-go-name":"SQLResourceName"},"resourceType":{"description":"The type of SQL resource, such as an availability group (AG) or a standalone instance (SA).","type":"string","x-go-name":"SQLResourceType"},"scheduleTime":{"description":"The date and time when the job starts or is scheduled to start. The time is specified in UTC in the format YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"ScheduleTime"}},"x-go-name":"GetUploadLogJobsReport","x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"SQLLastBackupDetailsStruct":{"description":"LastBackupDetailsStruct is response schema for GetBackupsets","type":"object","properties":{"jobID":{"description":"The unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"status":{"description":"The status of the job","type":"string","x-go-name":"Status"}},"x-go-name":"LastBackupDetailsStruct","x-go-package":"phoenix/sqlserver/cloud/report/spec/backupsets"},"SQLListSQLAvailabilityGroupResponse":{"description":"ListSQLResourceResponse is the response schema for ListSQLAvailabilityGroup","type":"object","properties":{"availabilityGroups":{"type":"array","items":{"$ref":"#/components/schemas/SQLResourceResponse"},"x-go-name":"Servers"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"ListSQLResourceResponse","x-go-package":"phoenix/sqlserver/cloud/report/spec/availabilitygroup"},"SQLListSQLInstancesResponse":{"description":"ListSQLResourceResponse is the response schema for ListSQLInstance","type":"object","properties":{"instances":{"type":"array","items":{"$ref":"#/components/schemas/SQLResourceResponse"},"x-go-name":"Servers"},"nextPageToken":{"description":"The page token value for the next set of API results. The value of this parameter is NULL for the last set of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"ListSQLResourceResponse","x-go-package":"phoenix/sqlserver/cloud/report/spec/instances"},"SQLResourceResponse":{"description":"ResourceResponse is the response part of the schema for ListSQLInstances","type":"object","properties":{"administrativeGroupName":{"description":"The name of the resource group the SQL instance is a part of.","type":"string","x-go-name":"GroupName"},"agID":{"description":"The ID of the availability group.","type":"integer","format":"int32","x-go-name":"AgID"},"configurationStatus":{"description":"The status indicating whether the SQL resource is configured for backup.","type":"boolean","x-go-name":"ConfiguredForFile"},"organizationName":{"description":"The name of the organization the SQL instance is a part of.","type":"string","x-go-name":"OrganizationName"},"resourceName":{"description":"The name of the SQL resource.","type":"string","x-go-name":"SQLResourceName"},"resourceType":{"description":"The type of the SQL resource.","type":"string","x-go-name":"SQLResourceType"},"serverName":{"description":"The name of the Windows or Linux server the SQL instance is a part of.","type":"array","items":{"type":"string"},"x-go-name":"ServerName"},"sqlServerVersion":{"description":"The version of the SQL resource.","type":"string","x-go-name":"Version"}},"x-go-name":"ResourceResponse","x-go-package":"phoenix/sqlserver/cloud/report/spec/instances"},"SQLRestoreEnvironmentStruct":{"description":"RestoreEnvironmentStruct struct holds the response for GetRestoreJobsReport api","type":"object","properties":{"diskWriteRate":{"description":"Specifies the bit rate for writing I/O by the agent. The Disk Write Rate is the average of the total data written with respect to the total time taken to write data at various intervals.","type":"string","x-go-name":"DiskWriteRate"},"diskWriteRateInKBps":{"description":"Specifies the bit rate in Kilobytes per second for writing I/O by the agent. The Disk Write Rate is the average of the total data written with respect to the total time taken to write data at various intervals.","type":"number","format":"double","x-go-name":"DiskWriteRateInKBps"},"networkRetries":{"description":"The number of retries during the job due to network issues.","type":"integer","format":"int32","x-go-name":"NetworkRetries"},"networkRetryDuration":{"description":"Specifies the total time spent in the network retries. It represents the cumulative of all network session duration.","type":"string","x-go-name":"NetworkRetryDuration"},"networkRetryDurationInSeconds":{"description":"Specifies the total time spent in seconds in the network retries. It represents the cumulative of all network session duration.","type":"integer","format":"int64","x-go-name":"NetworkRetryDurationInSeconds"}},"x-go-name":"RestoreEnvironmentStruct","x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"SQLRestoreExecutionDetailsStruct":{"description":"RestoreExecutionDetailsStruct struct holds the response for GetRestoreJobsReport api","type":"object","properties":{"bandwidthConsumed":{"description":"Specifies the bit rate to transfer data from the Cloud and CloudCache.","type":"string","x-go-name":"BandwidthConsumed"},"bandwidthConsumedInKBps":{"description":"Specifies the bit rate in Kilobytes per second to transfer data from the Cloud and CloudCache.","type":"number","format":"double","x-go-name":"BandwidthConsumedInKBps"},"endTime":{"description":"The time when the job completes. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"Specifies the error code for the failed jobs. The possible values are:\n \\\"0\\\": If the job is successful\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"Specifies the error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"restoredData":{"description":"Specifies the total amount of data restored.","type":"string","x-go-name":"RestoredData"},"restoredDataInBytes":{"description":"Specifies the total amount of data restored in bytes.","type":"integer","format":"uint64","x-go-name":"RestoredDataInBytes"},"restoredItems":{"description":"The files and folders restored on the server.","type":"string","x-go-name":"RestoredItems"},"startTime":{"description":"The time when the job starts. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"The status of the job.","type":"string","enum":["Queued","Running","Successful","Successful with errors","Failed."],"x-go-name":"Status"}},"x-go-name":"RestoreExecutionDetailsStruct","x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"SQLRetentionPolicy":{"description":"RetentionPolicy struct holds the response for GetPolicies api","type":"object","properties":{"allSnapshots":{"description":"The number of days for which the daily backup restore points are to be retained.","type":"string","x-go-name":"Daily"},"ltrEnabled":{"description":"The status of the backup set whether enabled for long term retention. For example, True denotes that the backup set is enabled for LTR.","type":"boolean","x-go-name":"LTREnabled"},"monthly":{"description":"The number of months for which the monthly backup restore points are to be retained.","type":"string","x-go-name":"Monthly"},"warmTierDuration":{"description":"Lists the duration in days for which the snapshot will reside in the warm tier of the AWS storage.","type":"integer","format":"int32","x-go-name":"WarmTierDuration"},"weekly":{"description":"The number of weeks for which the weekly backup restore points are to be retained.","type":"string","x-go-name":"Weekly"},"yearly":{"description":"The number of years for which the yearly backup restore points are to be retained.","type":"string","x-go-name":"Yearly"}},"x-go-name":"RetentionPolicy","x-go-package":"phoenix/sqlserver/cloud/report/spec/policies"},"SQLSchedules":{"description":"Schedules struct holds the response for GetPolicies api","type":"object","properties":{"backup Type":{"description":"The type of the backup.","type":"string","x-go-name":"BackupType"},"bandwidth":{"description":"Specifies the bandwidth that each resource can consume while backing up data to the Cloud.","type":"string","x-go-name":"Bandwidth"},"bandwidthInKBps":{"description":"Specifies the bandwidth in Kilobytes per second that each resource can consume while backing up data to the Cloud.","type":"number","format":"double","x-go-name":"BandwidthInKBps"},"duration":{"description":"Specifies the duration after which you want backup operations to stop.","type":"string","x-go-name":"Duration"},"durationInSeconds":{"description":"Specifies the duration in seconds after which you want backup operations to stop.","type":"integer","format":"int64","x-go-name":"DurationInSeconds"},"repeatOn":{"$ref":"#/components/schemas/JSONStringList"},"startAt":{"description":"The start hour of the backup operation.","type":"string","x-go-name":"StartAt"}},"x-go-name":"Schedules","x-go-package":"phoenix/sqlserver/cloud/report/spec/policies"},"SQLTransactionlogSchedule":{"description":"TransactionlogSchedule struct holds the response for GetPolicies api","type":"object","properties":{"bandwidth":{"description":"Specifies the bandwidth that each resource can consume while backing up data to the Cloud.","type":"string","x-go-name":"Bandwidth"},"bandwidthInKBps":{"description":"Specifies the bandwidth in Kilobytes per second that each resource can consume while backing up data to the Cloud.","type":"number","format":"double","x-go-name":"BandwidthInKBps"},"duration":{"description":"Specifies the duration after which you want transactionlog backup operations to stop.","type":"string","x-go-name":"Duration"},"durationInSeconds":{"description":"Specifies the duration in seconds after which you want transactionlog backup operations to stop.","type":"integer","format":"int64","x-go-name":"DurationInSeconds"},"repeatOn":{"description":"The days of week on which the transactional log schedule is to be run.","type":"string","x-go-name":"RepeatOn"},"startAt":{"description":"The start hour of the transactional log backup operation.","type":"string","x-go-name":"StartAt"}},"x-go-name":"TransactionlogSchedule","x-go-package":"phoenix/sqlserver/cloud/report/spec/policies"},"SQLUploadLogExecDetailsStruct":{"description":"UploadLogExecDetailsStruct struct holds the response for GetUploadLogJobsReport api","type":"object","properties":{"endTime":{"description":"The time when the job completes. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"Specifies the error code for the failed jobs. The possible values are:\n \\\"0\\\": If the job is successful\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"Specifies the error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"logsExpiryTime":{"description":"The expiry time of the uploaded logs. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"LogsExpiryTime"},"logsSize":{"description":"Specifies the size of the extracted log files.","type":"string","x-go-name":"LogsSize"},"logsSizeInBytes":{"description":"Specifies the size of the extracted log files in bytes.","type":"integer","format":"uint64","x-go-name":"LogsSizeInBytes"},"sourceJobID":{"description":"The unique identification number of the job for which logs are being requested.","type":"integer","format":"int32","x-go-name":"SourceJobID"},"sourceJobType":{"description":"The job type for which logs are being requested.","type":"string","x-go-name":"SourceJobLogType"},"startTime":{"description":"The time when the job starts. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"The status of the job.","type":"string","enum":["Queued","Running","Successful","Successful with errors","Failed"],"x-go-name":"Status"}},"x-go-name":"UploadLogExecDetailsStruct","x-go-package":"phoenix/sqlserver/cloud/report/spec/jobs"},"JobDetails":{"description":"Contains backup job specific details. Only failedJobIDs and lastSucceeded will be present if failureNumberSinceLastSuccess field is specified. jobID, jobErrorMsg, jobStartTime and jobEndTime will be present for all other cases","type":"object","properties":{"jobID":{"description":"ID of the job","type":"integer","format":"int32","example":1},"jobStartTime":{"description":"Timestamp at which the job started","type":"string","example":"2019-07-08T03:38:22.000Z"},"jobEndTime":{"description":"Timestamp at which the job ended","type":"string","example":"2019-07-08T05:52:36.000Z"},"jobErrorMsg":{"description":"Error message stating the reason for job failure","type":"string","example":"error message"},"failedJobIDs":{"description":"List of failed job IDs since the last successful job","type":"array","items":{"type":"integer","format":"int32","example":1}},"lastSucceeded":{"description":"The last backup job completion timestamp. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","example":"2019-07-05T03:38:22.000Z"}}},"DatabaseResponse":{"description":"DatabaseResponse is the response part of the schema for ListDatabaseReport","type":"object","properties":{"authType":{"type":"string","x-go-name":"AuthType"},"backupsetCount":{"type":"integer","format":"int32","x-go-name":"BackupSetCount"},"cdb":{"type":"boolean","x-go-name":"CDB"},"connectionStatus":{"type":"boolean","x-go-name":"ConnStatus"},"dbName":{"type":"string","x-go-name":"Name"},"manual":{"type":"boolean","x-go-name":"Manual"},"oracleHome":{"type":"string","x-go-name":"OracleHome"},"organizationName":{"type":"string","x-go-name":"OrganizationName"},"rac":{"type":"boolean","x-go-name":"RAC"},"server":{"$ref":"#/components/schemas/ServerResponse"},"size":{"type":"integer","format":"int64","x-go-name":"Size"},"version":{"type":"string","x-go-name":"Version"}},"x-go-package":"phoenix/oraclesbt/cloud/report/spec/topology"},"ListDatabaseReportResponse":{"description":"ListDatabaseReportResponse is the response schema for ListDatabaseReport","type":"object","properties":{"databases":{"type":"array","items":{"$ref":"#/components/schemas/DatabaseResponse"},"x-go-name":"Databases"},"nextPageToken":{"description":"The page token value for the next set of API results. The value of this parameter is NULL for the last set of results.","type":"string","x-go-name":"OutToken"}},"x-go-package":"phoenix/oraclesbt/cloud/report/spec/topology"},"ListServerReportResponse":{"description":"ListServerReportResponse is the response schema for ListServerReport","type":"object","properties":{"nextPageToken":{"description":"The page token value for the next set of API results. The value of this parameter is NULL for the last set of results.","type":"string","x-go-name":"OutToken"},"servers":{"type":"array","items":{"$ref":"#/components/schemas/ServerResponse"},"x-go-name":"Servers"}},"x-go-package":"phoenix/oraclesbt/cloud/report/spec/topology"},"ServerResponse":{"description":"ServerResponse is the response part of the schema for ListServerReport","type":"object","properties":{"activationTime":{"description":"The time at which the oracle server was activated for Enterprise Workloads.","type":"string","x-go-name":"ActivationTime"},"agentVersion":{"description":"The version of the agent installed on the oracle server.","type":"string","x-go-name":"AgentVersion"},"oracleVersion":{"description":"The version of the oracle server.","type":"array","items":{"type":"string"},"x-go-name":"OracleVersion"},"organizationName":{"description":"The name of the organization the oracle server is part of.","type":"string","x-go-name":"OrganizationName"},"platform":{"description":"The platform of the oracle server.","type":"string","x-go-name":"Platform"},"serverConnectionStatus":{"description":"The connection status of the oracle server.","type":"boolean","x-go-name":"IsServerConnected"},"serverName":{"description":"The name of the oracle server.","type":"string","x-go-name":"ServerName"}},"x-go-package":"phoenix/oraclesbt/cloud/report/spec/topology"},"BackupPolicy":{"description":"BackupPolicy represents data model for BackupPolicy entry","type":"object","properties":{"dataLock":{"description":"The status indicating if Data Lock is enabled in the backup policy.","type":"boolean","x-go-name":"Immutability"},"description":{"type":"string","x-go-name":"Description"},"ignoreFirstBackupWindow":{"type":"boolean","x-go-name":"IgnoreFirstBackupWindow"},"maxRetryCount":{"type":"integer","format":"int32","x-go-name":"MaxRetryCount"},"maxRetryDuration":{"type":"string","x-go-name":"MaxRetryDuration"},"maxRetryDurationInSeconds":{"type":"integer","format":"int32","x-go-name":"MaxRetryDurationInSeconds"},"organizationName":{"type":"string","x-go-name":"OrganizationName"},"policyID":{"description":"The ID of your backup policy.","type":"integer","format":"int64","x-go-name":"PolicyID"},"policyName":{"type":"string","x-go-name":"Name"},"retention":{"$ref":"#/components/schemas/Retention"},"retryEnabled":{"type":"boolean","x-go-name":"RetryEnabled"},"rmanParams":{"type":"string","x-go-name":"RmanParams"},"schedules":{"type":"array","items":{"$ref":"#/components/schemas/BackupSchedule"},"x-go-name":"Schedules"},"transactionLog":{"$ref":"#/components/schemas/TransactionLog"}},"x-go-package":"phoenix/oraclesbt/cloud/report/spec/policy"},"BackupSchedule":{"description":"BackupSchedule represents data model for BackupSchedule entry","type":"object","properties":{"backupType":{"type":"string","x-go-name":"BackupType"},"bandwidth":{"type":"string","x-go-name":"Bandwidth"},"bandwidthInKBps":{"type":"number","format":"double","x-go-name":"BandwidthInKBps"},"duration":{"type":"string","x-go-name":"WindowDuration"},"durationInSeconds":{"type":"integer","format":"int64","x-go-name":"DurationInSeconds"},"repeatOn":{"$ref":"#/components/schemas/JSONStringList"},"startAt":{"type":"string","x-go-name":"WindowStartTime"}},"x-go-package":"phoenix/oraclesbt/cloud/report/spec/policy"},"ListPolicyReportResponse":{"description":"ListPolicyReportResponse is the response schema for ListPolicyReport","type":"object","properties":{"nextPageToken":{"description":"The page token value for the next set of API results. The value of this parameter is NULL for the last set of results.","type":"string","x-go-name":"OutToken"},"policies":{"type":"array","items":{"$ref":"#/components/schemas/BackupPolicy"},"x-go-name":"Policies"}},"x-go-package":"phoenix/oraclesbt/cloud/report/spec/policy"},"Retention":{"description":"Retention represents data model for Retention Policy","type":"object","properties":{"daily":{"type":"string","x-go-name":"Daily"},"monthly":{"type":"string","x-go-name":"Monthly"},"weekly":{"type":"string","x-go-name":"Weekly"},"yearly":{"type":"string","x-go-name":"Yearly"},"ltrEnabled":{"description":"The status of the backup set whether enabled for long term retention. For example, True denotes that the backup set is enabled for LTR.","type":"boolean","x-go-name":"LTREnabled"},"warmTierDuration":{"description":"Lists the duration in days for which the snapshot will reside in the warm tier of the AWS storage.","type":"integer","format":"int32","x-go-name":"WarmTierDuration"}},"x-go-package":"phoenix/oraclesbt/cloud/report/spec/policy"},"TransactionLog":{"description":"TransactionLog represents data model for Transaction Logs schedule table","type":"object","properties":{"bandwidth":{"type":"string","x-go-name":"Bandwidth"},"bandwidthInKBps":{"type":"number","format":"double","x-go-name":"BandwidthInKBps"},"deleteLogs":{"type":"boolean","x-go-name":"DeleteLogs"},"logbkpFreq":{"type":"integer","format":"int32","x-go-name":"Logbkpfreq"}},"x-go-package":"phoenix/oraclesbt/cloud/report/spec/policy"},"Backupset":{"description":"Backupset info","type":"object","properties":{"backupEnabled":{"description":"Specifies whether the backupset is enabled for backup operation.","type":"boolean","x-go-name":"BackupEnabled"},"backupPolicyID":{"description":"The ID of your backup policy.","format":"int32","type":"integer","x-go-name":"BackupPolicyID"},"backupPolicyName":{"description":"Name of the backup policy attached to the backupset.","type":"string","x-go-name":"BackupPolicyName"},"backupsetID":{"description":"The ID of your backupset.","format":"int32","type":"integer","x-go-name":"ID"},"backupsetName":{"description":"The name of the backupset","type":"string","x-go-name":"BackupsetName"},"dataLock":{"description":"The status indicating if Data Lock is enabled for the backup set","type":"boolean","x-go-name":"Immutability"},"dbName":{"description":"The name of the oracle database.","type":"string","x-go-name":"DBName"},"lastBackupDetails":{"$ref":"#/components/schemas/OracleSBTLastBackupDetailsStruct"},"organizationID":{"description":"The ID of your organization.","format":"int32","type":"integer","x-go-name":"OrgID"},"ltrEnabled":{"description":"The status of the backup set whether enabled for long term retention. For example, True denotes that the backup set is enabled for LTR.","type":"boolean","x-go-name":"LTREnabled"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"resourceGroupName":{"description":"The name of the resource group the oracle server is part of.","type":"string","x-go-name":"GroupName"},"clusterName":{"description":"The name of the oracle rac cluster.","type":"string","x-go-name":"ClusterName"},"configuredNodes":{"description":"The SID and name of an instance of a RAC database backup set","type":"object","additionalProperties":{"type":"string"},"x-go-name":"ConfiguredNodes"},"isRAC":{"description":"Specifies if the backupset belongs to a RAC database","type":"boolean","x-go-name":"IsRAC"},"primaryNode":{"description":"The name of the primary node in a RAC database backup set","type":"string","x-go-name":"PrimaryNode"},"serverName":{"description":"The name of the oracle server.","type":"string","x-go-name":"ServerName"},"storageName":{"description":"The name of the storage.","type":"string","x-go-name":"StorageName"},"isDeactivated":{"description":"The state indicating whether the backup set is deactivated.","type":"boolean","x-go-name":"IsDeactivated"},"warmTierDuration":{"description":"Lists the duration in days for which the snapshot will reside in the warm tier of the AWS storage.","type":"integer","format":"int32","x-go-name":"WarmTierDuration"}},"x-go-package":"phoenix/oraclesbt/cloud/report/spec/backupset"},"ListBackupsetReportResponse":{"description":"ListBackupsetReportResponse is the response schema for ListBackupsetReport","type":"object","properties":{"backupsets":{"type":"array","items":{"$ref":"#/components/schemas/Backupset"},"x-go-name":"Backupsets"},"nextPageToken":{"description":"The page token value for the next set of API results. The value of this parameter is NULL for the last set of results.","type":"string","x-go-name":"OutToken"}},"x-go-package":"phoenix/oraclesbt/cloud/report/spec/backupset"},"OracleSBTLastBackupDetailsStruct":{"type":"object","title":"LastBackupDetailsStruct : Details of last backup job.","properties":{"jobID":{"description":"A unique identification number associated with the job. This parameter will be skipped if the value is NULL.","type":"integer","format":"int32","x-go-name":"JobID"},"status":{"description":"Status of the job. This parameter will be skipped if the value is NULL.","type":"string","x-go-name":"Status"}},"x-go-name":"LastBackupDetailsStruct","x-go-package":"phoenix/oraclesbt/cloud/report/spec/backupset"},"OracleSBTDataTransferStruct":{"type":"object","title":"DataTransferStruct : Data transfer details of the job.","properties":{"backupDuration":{"description":"Duration of the backup job.","type":"string","x-go-name":"BackupDuration"},"backupDurationInSeconds":{"description":"Duration of the backup job in seconds.","type":"integer","format":"int64","x-go-name":"BackupDurationInSeconds"},"backupSpeed":{"description":"Speed of the backup job.","type":"string","x-go-name":"BackupSpeed"},"backupSpeedInKBps":{"description":"Speed of the backup job in KBps.","type":"number","format":"double","x-go-name":"BackupSpeedInKBps"},"bandwidthConsumed":{"description":"Bandwidth consumed during the backup job.","type":"string","x-go-name":"BandwidthConsumed"},"bandwidthConsumedInKBps":{"description":"Bandwidth consumed during the backup job.","type":"number","format":"double","x-go-name":"BandwidthConsumedInKBps"},"dataTransferCache":{"description":"Data transferred to the Cache server.","type":"string","x-go-name":"DataTransferCache"},"dataTransferCacheInBytes":{"description":"Data transferred to the Cache server in bytes.","type":"integer","format":"uint64","x-go-name":"DataTransferCacheInBytes"},"dataTransferCloud":{"description":"Data transferred to the Cloud.","type":"string","x-go-name":"DataTransferCloud"},"dataTransferCloudInBytes":{"description":"Data transferred to the Cloud in bytes.","type":"integer","format":"uint64","x-go-name":"DataTransferCloudInBytes"}},"x-go-name":"DataTransferStruct","x-go-package":"phoenix/oraclesbt/cloud/report/spec/jobs"},"OracleSBTEnvironmentStruct":{"type":"object","title":"EnvironmentStruct : Environment details of the job.","properties":{"diskReadRate":{"description":"Disk read rate during the job.","type":"string","x-go-name":"DiskReadRate"},"diskReadRateInKBps":{"description":"Disk read rate during the job in KBps.","type":"number","format":"double","x-go-name":"DiskReadRateInKBps"},"networkRetries":{"description":"Number of retries during the job due to network issues.","type":"integer","format":"int32","x-go-name":"NetworkRetries"},"networkRetryDuration":{"description":"Total duration of retries during the job due to network issues.","type":"string","x-go-name":"NetworkRetryDuration"},"networkRetryDurationInSeconds":{"description":"Total duration of retries during the job due to network issues in seconds.","type":"integer","format":"int64","x-go-name":"NetworkRetryDurationInSeconds"}},"x-go-name":"EnvironmentStruct","x-go-package":"phoenix/oraclesbt/cloud/report/spec/jobs"},"OracleSBTExecutionDetailsStruct":{"type":"object","title":"ExecutionDetailsStruct : Execution details of the job.","properties":{"endTime":{"description":"The time when the job completes. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"The error code for the failed jobs. The possible values are:\\n\\\"0\\\": If the job is successful\\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"The error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"scheduleTime":{"description":"The date and time when the job starts or is scheduled to start. The time is specified in UTC in the format YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"ScheduleTime"},"startTime":{"description":"The time when the job starts. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"Status of the job.","type":"string","enum":["Queued","Running","Successful","Successful with errors","Failed"],"x-go-name":"Status"}},"x-go-name":"ExecutionDetailsStruct","x-go-package":"phoenix/oraclesbt/cloud/report/spec/jobs"},"OracleSBTGetAllJobsReport":{"description":"GetAllJobsReport struct holds the response for GetAllJobsReport api","type":"object","properties":{"dbName":{"description":"The name of database","type":"string","x-go-name":"DatabaseName"},"endTime":{"description":"The time when the job completes. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"The error code for the failed jobs. The possible values are:\\n\\\"0\\\": If the job is successful\\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"The error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobSubType":{"description":"Subtype of job","type":"string","x-go-name":"JobSubType"},"jobType":{"description":"The type of the job.","type":"string","enum":["Backup","Restore","Log Request"],"x-go-name":"JobType"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"scheduleTime":{"description":"The date and time when the job starts or is scheduled to start. The time is specified in UTC in the format YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"ScheduleTime"},"serverName":{"description":"The name of oracle database server","type":"string","x-go-name":"ServerName"},"startTime":{"description":"The time when the job starts. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"Status of the job.","type":"string","enum":["Queued","Running","Successful","Successful with errors","Failed"],"x-go-name":"Status"}},"x-go-name":"GetAllJobsReport","x-go-package":"phoenix/oraclesbt/cloud/report/spec/jobs"},"OracleSBTGetAllJobsReportResponse":{"description":"GetAllJobsReportResponse is the response schema for GetAllJobsReport","type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/OracleSBTGetAllJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The page token value for the next set of API results. The value of this parameter is NULL for the last set of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetAllJobsReportResponse","x-go-package":"phoenix/oraclesbt/cloud/report/spec/jobs"},"OracleSBTGetBackupJobReportResponse":{"description":"GetBackupJobReportResponse is the response schema for GetBackupJobReport","type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/OracleSBTGetBackupJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The page token value for the next set of API results. The value of this parameter is NULL for the last set of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetBackupJobReportResponse","x-go-package":"phoenix/oraclesbt/cloud/report/spec/jobs"},"OracleSBTGetBackupJobsReport":{"description":"GetBackupJobsReport struct holds the response for GetBackupJobsReport api","type":"object","properties":{"backupsetID":{"description":"The ID of your backup set.","format":"int32","type":"integer","x-go-name":"BackupsetID"},"backupPolicyID":{"description":"The ID of your backup policy.","format":"int32","type":"integer","x-go-name":"BackupPolicyID"},"backupPolicyName":{"description":"The name of the backup policy.","type":"string","x-go-name":"BackupPolicyName"},"dataTransfer":{"$ref":"#/components/schemas/OracleSBTDataTransferStruct"},"dbName":{"description":"The name of database","type":"string","x-go-name":"DatabaseName"},"environmentDetails":{"$ref":"#/components/schemas/OracleSBTEnvironmentStruct"},"executionDetails":{"$ref":"#/components/schemas/OracleSBTExecutionDetailsStruct"},"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobSubType":{"description":"Subtype of job","type":"string","x-go-name":"JobSubType"},"jobType":{"description":"The type of the job.","type":"string","enum":["Backup","Restore","Log Request","Defreeze"],"x-go-name":"JobType"},"organizationID":{"description":"The ID of your organization.","format":"int32","type":"integer","x-go-name":"OrgID"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"serverName":{"description":"The name of oracle server.","type":"string","x-go-name":"ServerName"}},"x-go-name":"GetBackupJobsReport","x-go-package":"phoenix/oraclesbt/cloud/report/spec/jobs"},"OracleSBTGetRestoreJobReportResponse":{"description":"GetRestoreJobReportResponse is the response schema for GetRestoreJobReport","type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/OracleSBTGetRestoreJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The page token value for the next set of API results. The value of this parameter is NULL for the last set of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetRestoreJobReportResponse","x-go-package":"phoenix/oraclesbt/cloud/report/spec/jobs"},"OracleSBTGetRestoreJobsReport":{"description":"GetRestoreJobsReport struct holds the response for GetRestoreJobsReport api","type":"object","properties":{"backupsetID":{"description":"The ID of your backup set.","format":"int32","type":"integer","x-go-name":"BackupsetID"},"dbName":{"description":"Name of the database","type":"string","x-go-name":"DatabaseName"},"destinationServerName":{"description":"Name of the oracle server to which the restore was initiated.","type":"string","x-go-name":"DestinationServerName"},"environmentDetails":{"$ref":"#/components/schemas/OracleSBTRestoreEnvironmentStruct"},"executionDetails":{"$ref":"#/components/schemas/OracleSBTRestoreExecutionDetailsStruct"},"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"Type of the job.","type":"string","enum":["Backup","Restore","Log Request","Defreeze"],"x-go-name":"JobType"},"organizationID":{"description":"The ID of your organization.","format":"int32","type":"integer","x-go-name":"OrgID"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"sourceServerName":{"description":"Name of the oracle server on which the backup was initiated.","type":"string","x-go-name":"SourceServerName"}},"x-go-name":"GetRestoreJobsReport","x-go-package":"phoenix/oraclesbt/cloud/report/spec/jobs"},"OracleSBTGetUploadLogJobReportResponse":{"description":"GetUploadLogJobReportResponse is the response schema for GetUploadLogJobReport","type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/OracleSBTGetUploadLogJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The page token value for the next set of API results. The value of this parameter is NULL for the last set of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetUploadLogJobReportResponse","x-go-package":"phoenix/oraclesbt/cloud/report/spec/jobs"},"OracleSBTGetUploadLogJobsReport":{"description":"GetUploadLogJobsReport struct holds the response for GetUploadLogJobsReport api","type":"object","properties":{"dbName":{"description":"The name of database","type":"string","x-go-name":"DatabaseName"},"executionDetails":{"$ref":"#/components/schemas/OracleSBTUploadLogExecDetailsStruct"},"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"Type of the job.","type":"string","enum":["Backup","Restore","Log Request"],"x-go-name":"JobType"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"serverName":{"description":"Name of the server on which the backup was initiated.","type":"string","x-go-name":"ServerName"}},"x-go-name":"GetUploadLogJobsReport","x-go-package":"phoenix/oraclesbt/cloud/report/spec/jobs"},"OracleSBTRestoreEnvironmentStruct":{"type":"object","title":"RestoreEnvironmentStruct : Environment details of the job.","properties":{"diskWriteRate":{"description":"Disk write rate during the job.","type":"string","x-go-name":"DiskWriteRate"},"diskWriteRateInKBps":{"description":"Disk write rate during the job in KBps.","type":"number","format":"double","x-go-name":"DiskWriteRateInKBps"},"networkRetries":{"description":"Number of retries during the job due to network issues.","type":"integer","format":"int32","x-go-name":"NetworkRetries"},"networkRetryDuration":{"description":"Total duration of retries during the job due to network issues.","type":"string","x-go-name":"NetworkRetryDuration"},"networkRetryDurationInSeconds":{"description":"Total duration of retries during the job due to network issues in seconds.","type":"integer","format":"int64","x-go-name":"NetworkRetryDurationInSeconds"}},"x-go-name":"RestoreEnvironmentStruct","x-go-package":"phoenix/oraclesbt/cloud/report/spec/jobs"},"OracleSBTRestoreExecutionDetailsStruct":{"type":"object","title":"RestoreExecutionDetailsStruct : Execution details of the job.","properties":{"bandwidthConsumed":{"description":"Bandwidth consumed during the restore job.","type":"string","x-go-name":"BandwidthConsumed"},"bandwidthConsumedInKBps":{"description":"Bandwidth consumed during the restore job in KBps.","type":"number","format":"double","x-go-name":"BandwidthConsumedInKBps"},"endTime":{"description":"The time when the job completes. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"The error code for the failed jobs. The possible values are:\\n\\\"0\\\": If the job is successful\\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"The error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"restoredData":{"description":"Total amount of data restored.","type":"string","x-go-name":"RestoredData"},"restoredDataInBytes":{"description":"Total amount of data restored in bytes.","type":"integer","format":"uint64","x-go-name":"RestoredDataInBytes"},"restoredItems":{"description":"Files/folders restored on the server.","type":"string","x-go-name":"RestoredItems"},"scheduleTime":{"description":"The date and time when the job starts or is scheduled to start. The time is specified in UTC in the format YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"ScheduleTime"},"startTime":{"description":"The time when the job starts. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"Status of the job.","type":"string","enum":["Queued","Running","Successful","Successful with errors","Failed"],"x-go-name":"Status"}},"x-go-name":"RestoreExecutionDetailsStruct","x-go-package":"phoenix/oraclesbt/cloud/report/spec/jobs"},"OracleSBTUploadLogExecDetailsStruct":{"type":"object","title":"UploadLogExecDetailsStruct : Execution details of the job.","properties":{"endTime":{"description":"The time when the job completes. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"The error code for the failed jobs. The possible values are:\\n\\\"0\\\": If the job is successful\\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"The error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"logsExpiryTime":{"description":"Expiry time of the uploaded logs. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"LogsExpiryTime"},"logsSize":{"description":"Size of the logs.","type":"string","x-go-name":"LogsSize"},"logsSizeInBytes":{"description":"Size of the logs in bytes.","type":"integer","format":"uint64","x-go-name":"LogsSizeInBytes"},"sourceJobID":{"description":"The ID of the job for which logs are being requested.","type":"integer","format":"int32","x-go-name":"SourceJobID"},"sourceJobType":{"description":"The job type for which logs are being requested.","type":"string","x-go-name":"SourceJobLogType"},"scheduleTime":{"description":"The date and time when the job starts or is scheduled to start. The time is specified in UTC in the format YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"ScheduleTime"},"startTime":{"description":"The time when the job starts. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"Status of the job.","type":"string","enum":["Queued","Running","Successful","Successful with errors","Failed"],"x-go-name":"Status"}},"x-go-name":"UploadLogExecDetailsStruct","x-go-package":"phoenix/oraclesbt/cloud/report/spec/jobs"},"PBSBackupsetInfo":{"description":"BackupsetInfo is response schema for GetBackupsets","type":"object","properties":{"backupEnabled":{"description":"Specifies whether the backup is enabled for the backup set.","type":"boolean","x-go-name":"BackupEnabled"},"backupsetID":{"description":"The ID of the backup set.","type":"integer","format":"int32","x-go-name":"BackupsetID"},"backupMountName":{"description":"The RMAN target location where the Oracle RMAN backups are stored.","type":"string","x-go-name":"BackupMountName"},"dataLock":{"description":"The status indicating if Data Lock is enabled for the backup set","type":"boolean","x-go-name":"Immutability"},"ipWhitelist":{"description":"The list of IP addresses of the Oracle RMAN hosts that can store Oracle RMAN backups on the mount. If the IP whitelist is not set to *, it displays the list of allowed IP addresses. For more information, see IPWhitelist.","type":"string","x-go-name":"IPWhitelist"},"lastBackupDetails":{"$ref":"#/components/schemas/PBSLastBackupDetailsStruct"},"maxBandwidth":{"description":"The maximum bandwidth that each server can consume while backing up data to the Cloud.","type":"integer","format":"int32","x-go-name":"MaxBandwidth"},"organizationID":{"description":"The ID of the organization","type":"integer","format":"int32","x-go-name":"OrgID"},"organizationName":{"description":"The name of the organization in which the Phoenix Backup Store is deployed.","type":"string","x-go-name":"OrgName"},"resourceType":{"description":"The Resource type which in this case is for Phoenix Backup Store : Oracle.","type":"string","x-go-name":"ResourceType"},"oracleStoreID":{"description":"The ID of the Oracle Store","type":"integer","format":"int32","x-go-name":"OracleStoreID"},"serverName":{"description":"The name of the Oracle server host or the Phoenix Backup Store.","type":"string","x-go-name":"ServerName"},"storageId":{"description":"The unique identification number associated with the storage region.","type":"integer","format":"int32","x-go-name":"StorageID"},"storageName":{"description":"The name of the storage region where the snapshot is stored after the Phoenix Backup Store uploads the snapshot to the Druva Cloud.","type":"string","x-go-name":"StorageName"}},"x-go-name":"BackupsetInfo","x-go-package":"phoenix/pbs/cloud/report/spec/backupsets"},"PBSGetBackupsetsResponse":{"description":"GetBackupsetsResponse is response schema for GetBackupsets","type":"object","properties":{"backupsets":{"type":"array","items":{"$ref":"#/components/schemas/PBSBackupsetInfo"},"x-go-name":"Backupsets"},"nextPageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request. The value of this parameter is NULL for the last set of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetBackupsetsResponse","x-go-package":"phoenix/pbs/cloud/report/spec/backupsets"},"PBSLastBackupDetailsStruct":{"description":"LastBackupDetailsStruct is response schema for GetBackupsets","type":"object","properties":{"jobID":{"description":"The unique identification number associated with the job. This parameter will be skipped if the value is NULL.","type":"integer","format":"int32","x-go-name":"JobID"},"status":{"description":"The status of the job. This parameter can be one from the following values: Queued, Running, Successful, Successful with errors and Failed.","type":"string","x-go-name":"Status"}},"x-go-name":"LastBackupDetailsStruct","x-go-package":"phoenix/pbs/cloud/report/spec/backupsets"},"PBSBackupstoreResponse":{"description":"BackupstoreResponse is the response part of the schema for ListBackupstore","type":"object","properties":{"activationTime":{"description":"The time when the Oracle server host was activated with Enterprise Workloads.","type":"string","x-go-name":"ActivationTime"},"organizationID":{"description":"The ID of the organization","type":"integer","format":"int32","x-go-name":"OrgID"},"organizationName":{"description":"The name of the organization in which the Phoenix Backup Store is deployed.","type":"string","x-go-name":"OrganizationName"},"platform":{"description":"The operating system of the Oracle server host.","type":"string","x-go-name":"Platform"},"serverConnectionStatus":{"description":"The connection status of the Oracle server host whether Connected or Not Connected.","type":"boolean","x-go-name":"IsServerConnected"},"serverName":{"description":"The name of the Oracle server host or the Phoenix Backup Store.","type":"string","x-go-name":"ServerName"},"version":{"description":"The version the Oracle server host.","type":"string","x-go-name":"Version"}},"x-go-name":"BackupstoreResponse","x-go-package":"phoenix/pbs/cloud/report/spec/backupstores"},"PBSListBackupstoreResponse":{"description":"ListBackupstoreResponse is the response schema for ListBackupstore","type":"object","properties":{"backupstore":{"type":"array","items":{"$ref":"#/components/schemas/PBSBackupstoreResponse"},"x-go-name":"Backupstores"},"nextPageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request. The value of this parameter is NULL for the last set of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"ListBackupstoreResponse","x-go-package":"phoenix/pbs/cloud/report/spec/backupstores"},"PBSDataTransferStruct":{"type":"object","title":"DataTransferStruct : Data transfer details of the job.","properties":{"backupDuration":{"description":"The total time taken to upload data to the Cloud and CloudCache. Backup duration excludes the estimation time, network retry time, and the waiting for retry time.","type":"string","x-go-name":"BackupDuration"},"backupDurationInSeconds":{"description":"The total time taken in seconds to upload data to the Cloud and CloudCache. Backup duration excludes the estimation time, network retry time, and the waiting for retry time.","type":"integer","format":"int64","x-go-name":"BackupDurationInSeconds"},"backupSpeed":{"description":"The rate at which the source data is backed up to the Cloud.","type":"string","x-go-name":"BackupSpeed"},"backupSpeedInKBps":{"description":"The rate in Kilobytes per second at which the source data is backed up to the Cloud.","type":"number","format":"double","x-go-name":"BackupSpeedInKBps"},"bandwidthConsumed":{"description":"The bit rate to transfer data from the Cloud and CloudCache.","type":"string","x-go-name":"BandwidthConsumed"},"bandwidthConsumedInKBps":{"description":"The bit rate in Kilobytes per second to transfer data from the Cloud and CloudCache.","type":"number","format":"double","x-go-name":"BandwidthConsumedInKBps"},"dataTransferCache":{"description":"The incremental data that is uploaded to CloudCache after deduplication and compression.","type":"string","x-go-name":"DataTransferCache"},"dataTransferCacheInBytes":{"description":"The incremental data in bytes that is uploaded to CloudCache after deduplication and compression.","type":"integer","format":"uint64","x-go-name":"DataTransferCacheInBytes"},"dataTransferCloud":{"description":"The incremental data that is uploaded to the Cloud after deduplication and compression.","type":"string","x-go-name":"DataTransferCloud"},"dataTransferCloudInBytes":{"description":"The incremental data in bytes that is uploaded to the Cloud after deduplication and compression.","type":"integer","format":"uint64","x-go-name":"DataTransferCloudInBytes"}},"x-go-name":"DataTransferStruct","x-go-package":"phoenix/pbs/cloud/report/spec/jobs"},"PBSEnvironmentStruct":{"type":"object","title":"EnvironmentStruct : Environment details of the job.","properties":{"diskReadRate":{"description":"The bit rate for reading I/O by the agent. The Disk Read Rate is an average of the total data read with respect to the total time taken to read data at various intervals for all drives where data is distributed.","type":"string","x-go-name":"DiskReadRate"},"diskReadRateInKBps":{"description":"The bit rate in Kilobytes per second for reading I/O by the agent. The Disk Read Rate is an average of the total data read with respect to the total time taken to read data at various intervals for all drives where data is distributed.","type":"number","format":"double","x-go-name":"DiskReadRateInKBps"},"networkRetries":{"description":"The number of retries performed during the job execution due to network issues.","type":"integer","format":"int32","x-go-name":"NetworkRetries"},"networkRetryDuration":{"description":"The total time spent in the network retries. It represents the cumulative of all network session duration.","type":"string","x-go-name":"NetworkRetryDuration"},"networkRetryDurationInSeconds":{"description":"The total time spent in seconds in the network retries. It represents the cumulative of all network session duration.","type":"integer","format":"int64","x-go-name":"NetworkRetryDurationInSeconds"}},"x-go-name":"EnvironmentStruct","x-go-package":"phoenix/pbs/cloud/report/spec/jobs"},"PBSExecutionDetailsStruct":{"type":"object","title":"ExecutionDetailsStruct : Execution details of the job.","properties":{"endTime":{"description":"The time when the job completes. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"The error code for the failed jobs. The possible values are:\\n\\\"0\\\": If the job is successful\\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"The error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"scheduleTime":{"description":"The date and time when the job starts or is scheduled to start. The time is specified in UTC in the format YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"ScheduleTime"},"startTime":{"description":"The time when the job starts. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"The status of the job. Status can be one of the following values: Queued, Running, Successful, Successful with errors and Failed.","type":"string","x-go-name":"Status"}},"x-go-name":"ExecutionDetailsStruct","x-go-package":"phoenix/pbs/cloud/report/spec/jobs"},"PBSGetAllJobsReport":{"description":"GetAllJobsReport struct holds the response for GetAllJobsReport API","type":"object","properties":{"endTime":{"description":"The time when the job completes. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"The error code for the failed jobs. The possible values are:\\n \\\"0\\\": If the job is successful\\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"The error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"jobID":{"description":"The unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"The type of the job. JobType can be one of the following values: Backup, Restore and Log Request.","type":"string","x-go-name":"JobType"},"organizationID":{"description":"The ID of the organization","type":"integer","format":"int32","x-go-name":"OrgID"},"organizationName":{"description":"The name of the organization in which the Phoenix Backup Store is deployed.","type":"string","x-go-name":"OrgName"},"scheduleTime":{"description":"The date and time when the job starts or is scheduled to start. The time is specified in UTC in the format YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"ScheduleTime"},"serverName":{"description":"The name of the Oracle server host or the Phoenix Backup Store.","type":"string","x-go-name":"ServerName"},"startTime":{"description":"The time when the job starts. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"The status of the job. Status can be one of the following values: Queued, Running, Successful, Successful with errors and Failed.","type":"string","x-go-name":"Status"}},"x-go-name":"GetAllJobsReport","x-go-package":"phoenix/pbs/cloud/report/spec/jobs"},"PBSGetAllJobsReportResponse":{"description":"GetAllJobsReportResponse is the response schema for GetAllJobsReport","type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/PBSGetAllJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request. The value of this parameter is NULL for the last set of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetAllJobsReportResponse","x-go-package":"phoenix/pbs/cloud/report/spec/jobs"},"PBSGetBackupJobReportResponse":{"description":"GetBackupJobReportResponse is response schema for GetBackupJobReport","type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/PBSGetBackupJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The page token value for the next set of API results. The value of this parameter is NULL for the last set of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetBackupJobReportResponse","x-go-package":"phoenix/pbs/cloud/report/spec/jobs"},"PBSGetBackupJobsReport":{"description":"GetBackupJobsReport is response schema for GetBackupJobsReport API","type":"object","properties":{"backupMountName":{"description":"The RMAN target location where the Oracle RMAN backups are stored.","type":"string","x-go-name":"BackupMountName"},"backupsetID":{"description":"The ID of the backup set.","type":"integer","format":"int32","x-go-name":"BackupsetID"},"dataTransfer":{"$ref":"#/components/schemas/PBSDataTransferStruct"},"environmentDetails":{"$ref":"#/components/schemas/PBSEnvironmentStruct"},"executionDetails":{"$ref":"#/components/schemas/PBSExecutionDetailsStruct"},"jobID":{"description":"The unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"The type of the job. In this case it is Backup.","type":"string","x-go-name":"JobType"},"organizationID":{"description":"The ID of the organization","type":"integer","format":"int32","x-go-name":"OrgID"},"organizationName":{"description":"The name of the organization in which the Phoenix Backup Store is deployed.","type":"string","x-go-name":"OrgName"},"serverName":{"description":"The name of the Oracle server host or the Phoenix Backup Store.","type":"string","x-go-name":"ServerName"}},"x-go-name":"GetBackupJobsReport","x-go-package":"phoenix/pbs/cloud/report/spec/jobs"},"PBSGetRestoreJobReportResponse":{"description":"GetRestoreJobReportResponse is the response schema for GetRestoreJobReport","type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/PBSGetRestoreJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. Keep this field blank in the first request. The value of this parameter is NULL for the last set of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetRestoreJobReportResponse","x-go-package":"phoenix/pbs/cloud/report/spec/jobs"},"PBSGetRestoreJobsReport":{"description":"GetRestoreJobsReport struct holds the response for GetRestoreJobsReport api","type":"object","properties":{"backupMountName":{"description":"The RMAN target location where the Oracle RMAN backups are stored.","type":"string","x-go-name":"BackupMountName"},"backupsetID":{"description":"The ID of the backup set.","type":"integer","format":"int32","x-go-name":"BackupsetID"},"destServerName":{"description":"The name of the Oracle server host or the Phoenix Backup Store to which the restore was initiated.","type":"string","x-go-name":"DestServerName"},"environmentDetails":{"$ref":"#/components/schemas/PBSRestoreEnvironmentStruct"},"executionDetails":{"$ref":"#/components/schemas/PBSRestoreExecutionDetailsStruct"},"jobID":{"description":"The unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"The type of the job. In this case it is Restore.","type":"string","x-go-name":"JobType"},"organizationID":{"description":"The ID of the organization","type":"integer","format":"int32","x-go-name":"OrgID"},"organizationName":{"description":"The name of the organization in which the Phoenix Backup Store is deployed.","type":"string","x-go-name":"OrgName"},"sourceServerName":{"description":"The name of the Oracle server host or the Phoenix Backup Store on which the backup was initiated.","type":"string","x-go-name":"SourceServerName"}},"x-go-name":"GetRestoreJobsReport","x-go-package":"phoenix/pbs/cloud/report/spec/jobs"},"PBSRestoreEnvironmentStruct":{"type":"object","title":"RestoreEnvironmentStruct : Environment details of the job.","properties":{"diskWriteRate":{"description":"The bit rate for writing I/O by the agent. The Disk Write Rate is the average of the total data written with respect to the total time taken to write data at various intervals.","type":"string","x-go-name":"DiskWriteRate"},"diskWriteRateInKBps":{"description":"The bit rate in Kilobytes per second for writing I/O by the agent. The Disk Write Rate is the average of the total data written with respect to the total time taken to write data at various intervals.","type":"number","format":"double","x-go-name":"DiskWriteRateInKBps"},"networkRetries":{"description":"The number of retries performed during the job execution due to network issues.","type":"integer","format":"int32","x-go-name":"NetworkRetries"},"networkRetryDuration":{"description":"The total time spent in the network retries. It represents the cumulative of all network session duration.","type":"string","x-go-name":"NetworkRetryDuration"},"networkRetryDurationInSeconds":{"description":"The total time spent in seconds in the network retries. It represents the cumulative of all network session duration.","type":"integer","format":"int64","x-go-name":"NetworkRetryDurationInSeconds"}},"x-go-name":"RestoreEnvironmentStruct","x-go-package":"phoenix/pbs/cloud/report/spec/jobs"},"PBSRestoreExecutionDetailsStruct":{"type":"object","title":"RestoreExecutionDetailsStruct : Execution details of the job.","properties":{"bandwidthConsumed":{"description":"The bit rate to transfer data from the Cloud and CloudCache.","type":"string","x-go-name":"BandwidthConsumed"},"bandwidthConsumedInKBps":{"description":"The bit rate in Kilobytes per second to transfer data from the Cloud and CloudCache.","type":"number","format":"double","x-go-name":"BandwidthConsumedInKBps"},"endTime":{"description":"The time when the job completes. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"The error code for the failed jobs. The possible values are:\\n\\\"0\\\": If the job is successful\\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"The error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"restoredData":{"description":"The total amount of data restored on the Oracle server host.","type":"string","x-go-name":"RestoredData"},"restoredDataInBytes":{"description":"The total amount of data restored in bytes.","type":"integer","format":"uint64","x-go-name":"RestoredDataInBytes"},"restoredItems":{"description":"The number of files restored on the Oracle server host.","type":"string","x-go-name":"RestoredItems"},"scheduleTime":{"description":"The date and time when the job starts or is scheduled to start. The time is specified in UTC in the format YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"ScheduleTime"},"startTime":{"description":"The time when the job starts. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"The status of the job. Status can be one of the following values: Queued, Running, Successful, Successful with errors and Failed.","type":"string","x-go-name":"Status"}},"x-go-name":"RestoreExecutionDetailsStruct","x-go-package":"phoenix/pbs/cloud/report/spec/jobs"},"PBSGetUploadLogJobReportResponse":{"description":"GetUploadLogJobReportResponse is the response schema for GetUploadLogJobReport","type":"object","properties":{"jobs":{"type":"array","items":{"$ref":"#/components/schemas/PBSGetUploadLogJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The page token value for the next set of API results. The value of this parameter is NULL for the last set of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetUploadLogJobReportResponse","x-go-package":"phoenix/pbs/cloud/report/spec/jobs"},"PBSGetUploadLogJobsReport":{"description":"GetUploadLogJobsReport struct holds the response for GetUploadLogJobsReport api","type":"object","properties":{"executionDetails":{"$ref":"#/components/schemas/PBSUploadLogExecDetailsStruct"},"jobID":{"description":"The unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"The type of the job. JobType can be one of the following values: Backup, Restore and Log Request.","type":"string","x-go-name":"JobType"},"organizationID":{"description":"The ID of the organization","type":"integer","format":"int32","x-go-name":"OrgID"},"organizationName":{"description":"The name of the organization in which the Phoenix Backup Store is deployed.","type":"string","x-go-name":"OrgName"},"serverName":{"description":"The name of the Oracle server host or the Phoenix Backup Store.","type":"string","x-go-name":"ServerName"}},"x-go-name":"GetUploadLogJobsReport","x-go-package":"phoenix/pbs/cloud/report/spec/jobs"},"PBSUploadLogExecDetailsStruct":{"description":"UploadLogExecDetailsStruct struct holds the response for GetUploadLogJobsReport api","type":"object","properties":{"endTime":{"description":"The time when the job completes. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"The error code for the failed jobs. The possible values are:\\n\\\"0\\\": If the job is successful\\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"The error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"logsExpiryTime":{"description":"The expiry time of the uploaded logs. The time is specified in the UTC time zone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"LogsExpiryTime"},"logsSize":{"description":"The size of the logs.","type":"string","x-go-name":"LogsSize"},"logsSizeInBytes":{"description":"The size of the logs in bytes.","type":"integer","format":"uint64","x-go-name":"LogsSizeInBytes"},"sourceJobID":{"description":"The ID of the job of the source Oracle server host for which logs are requested.","type":"integer","format":"int32","x-go-name":"SourceJobID"},"sourceJobType":{"description":"The job type of the source Oracle server host for which logs are requested.","type":"string","x-go-name":"SourceJobLogType"},"scheduleTime":{"description":"The date and time when the job starts or is scheduled to start. The time is specified in UTC in the format YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"ScheduleTime"},"startTime":{"description":"The time when the job starts. The time is specified in the UTC timezone. The format is YYYY-MM-DDTHH:MM:SSZ.","type":"string","x-go-name":"StartTime"},"status":{"description":"The status of the job. Status can be one of the following values: Queued, Running, Successful, Successful with errors and Failed.","type":"string","x-go-name":"Status"}},"x-go-name":"UploadLogExecDetailsStruct","x-go-package":"phoenix/pbs/cloud/report/spec/jobs"},"NASBackupNowParams":{"description":"BackupNowParams request parameters for backup now","type":"object","properties":{"backupsetID":{"type":"integer","format":"int32","description":"Specify the ID of the backup set. Get the ID using the 'List backup sets' API.","x-go-name":"BackupsetID"}},"x-go-package":"phoenix/nas/cloud/configserver/spec/job"},"NASBackupNowResponse":{"description":"BackupNowResponse response schema for backup now","type":"object","properties":{"jobID":{"type":"integer","format":"int32","description":"A unique identification number associated with the job.","x-go-name":"JobID"}},"x-go-package":"phoenix/nas/cloud/configserver/spec/job"},"NASCancelJobParams":{"description":"CancelJobParams request parameters for Cancel Job","type":"object","properties":{"jobID":{"type":"integer","format":"int32","x-go-name":"JobID","description":"Specify the ID of the job that you want to cancel. Get the ID of the job using the 'List all jobs' API."}},"x-go-package":"phoenix/nas/cloud/configserver/spec/job"},"NASCancelJobResponse":{"description":"CancelJobResponse response schema for Cancel Job","type":"object","properties":{"jobID":{"type":"integer","format":"int32","x-go-name":"JobID","description":"The unique identification number associated with the job. The job ID is:
0: If the job is not successfully canceled.
: If the job was successfully canceled.
: If the job is already completed, completed with errors, was canceled, or failed before it could be canceled."}},"x-go-package":"phoenix/nas/cloud/configserver/spec/job"},"VMGetSnapshotResponse":{"description":"VMGetSnapshotResponse is the response schema for GetSnapshot API","type":"object","properties":{"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"NextPageToken"},"snapshots":{"description":"Snapshots details","type":"array","items":{"$ref":"#/components/schemas/VMSnapshotList"},"x-go-name":"Snapshots"}},"x-go-package":"phoenix/vmware/cloud/configserver/spec/backupset"},"VMRestoreOriginalParams":{"description":"VMRestoreOriginalParams is restore to original job request inputs","type":"object","properties":{"snapshotName":{"description":"Specify the name of the snapshot. Get the name of the snapshot using the 'List all snapshots' API.","type":"string","x-go-name":"SnapshotName"},"vmID":{"description":"Specify the ID of the virtual machine. Get the ID of the virtual machine using the 'List all backup sets' VMware API.","type":"integer","format":"int32","x-go-name":"VMID"}},"x-go-package":"phoenix/vmware/cloud/configserver/spec/job"},"VMRestoreOriginalResponse":{"description":"VMRestoreOriginalResponse is response to restore job request","type":"object","properties":{"jobID":{"description":"The unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"}},"x-go-package":"phoenix/vmware/cloud/configserver/spec/job"},"VMSnapshotList":{"description":"VMSnapshotList struct holds the response for GetSnapshot api","type":"object","properties":{"name":{"description":"The name of the snapshot.","type":"string","x-go-name":"SnapshotName"},"createdAt":{"description":"The creation date and time of the snapshot.","type":"string","x-go-name":"SnapshotCreationTime"},"isQuarantined":{"description":"The value is set to 'TRUE' if the snapshot is a quarantined snapshot, otherwise, it is set to 'FALSE'.","type":"boolean","x-go-name":"IsQuarantined"},"type":{"description":"The type of snapshot. The possible values for the snapshot type are: \"HOT\", \"WARM\", and \"COLD\".","type":"string","x-go-name":"SnapshotType"}},"x-go-package":"phoenix/vmware/cloud/configserver/spec/backupset"},"AHVBackupProxyInfo":{"description":"The details of backup proxies.","type":"object","properties":{"cluster":{"description":"The name of the Cluster.","type":"string","x-go-name":"ClusterName"},"backupProxyPool":{"$ref":"#/components/schemas/AHVBackupProxyPoolStruct"},"maxConcurrentBackups":{"description":"The maximum number of concurrent backup jobs supported by the backup proxy.","type":"integer","format":"int32","x-go-name":"MaxConcurrentBackups"},"name":{"description":"The name of the backup proxy.","type":"string","x-go-name":"Name"}},"x-go-name":"BackupProxyInfo","x-go-package":"phoenix/ahv/cloud/report/spec/proxies"},"AHVBackupProxyPoolStruct":{"description":"The details of the backup proxy pool.","type":"object","properties":{"name":{"description":"The name of the backup proxy pool.","type":"string","x-go-name":"Name"},"timezone":{"description":"The time zone for the backup proxy pool. Druva triggers backup of the VMs mapped to the proxy pool in this time zone.","type":"string","x-go-name":"TimeZone"}},"x-go-name":"BackupProxyPoolStruct","x-go-package":"phoenix/ahv/cloud/report/spec/proxies"},"AHVBackupsetInfo":{"description":"Details of backup sets.","type":"object","properties":{"backupEnabled":{"description":"Indicates whether the backup is enabled for the virtual machine.","type":"boolean","x-go-name":"BackupEnabled"},"backupPolicyID":{"description":"The ID of your backup policy.","type":"integer","format":"int64","x-go-name":"BackupPolicyID"},"backupPolicyName":{"description":"The name of the backup policy attached to the backup set.","type":"string","x-go-name":"BackupPolicyName"},"backupsetID":{"description":"The ID of your backup set.","type":"integer","format":"int32","x-go-name":"BackupsetID"},"clusterID":{"description":"The ID of your cluster.","type":"integer","format":"int64","x-go-name":"ClusterID"},"clusterName":{"description":"The name of the cluster.","type":"string","x-go-name":"ClusterName"},"dataLock":{"description":"Indicates whether data lock is enabled for the backup set.","type":"boolean","x-go-name":"ImmutabilityEnabled"},"lastBackupDetails":{"$ref":"#/components/schemas/AHVLastBackupDetailsStruct"},"ltrEnabled":{"description":"Indicates whether the backup is enabled for long term retention.","type":"boolean","x-go-name":"LTREnabled"},"name":{"description":"The name of your VM.","type":"string","x-go-name":"VMName"},"organizationID":{"description":"The ID of your organization.","type":"integer","format":"int32","x-go-name":"OrgID"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"vmID":{"description":"The ID of your virtual machine.","type":"integer","format":"int64","x-go-name":"VMID"},"warmTierDuration":{"description":"The duration in days for which the snapshot resides in the warm tier of the AWS storage.","type":"integer","format":"int32","x-go-name":"WarmTierDuration"}},"x-go-name":"BackupsetInfo","x-go-package":"phoenix/ahv/cloud/report/spec/backupsets"},"AHVDataTransferStruct":{"description":"The data transfer details of the job.","type":"object","properties":{"backupDuration":{"description":"The total time taken to upload data to the Druva Cloud and CloudCache. Backup duration excludes the estimation time, network retry time, and the waiting for retry time.","type":"string","x-go-name":"BackupDuration"},"backupDurationInSeconds":{"description":"The total time taken in seconds to upload data to the Druva Cloud and CloudCache. Backup duration excludes the estimation time, network retry time, and the waiting for retry time","type":"integer","format":"int64","x-go-name":"BackupDurationInSeconds"},"backupSpeed":{"description":"The rate at which the source data is backed up to the Druva Cloud.","type":"string","x-go-name":"BackupSpeed"},"backupSpeedInKBps":{"description":"The rate in kilobytes per second at which the source data is backed up to the Druva Cloud.","type":"number","format":"double","x-go-name":"BackupSpeedInKBps"},"bandwidthConsumed":{"description":"The bit rate to transfer data from the Druva Cloud and CloudCache.","type":"string","x-go-name":"BandwidthConsumed"},"bandwidthConsumedInKBps":{"description":"The bit rate in kilobytes per second to transfer data from the Druva Cloud and CloudCache.","type":"number","format":"double","x-go-name":"BandwidthConsumedInKBps"},"dataTransferCache":{"description":"The incremental data that is uploaded to CloudCache after deduplication and compression.","type":"string","x-go-name":"DataTransferCache"},"dataTransferCacheInBytes":{"description":"The incremental data in bytes that is uploaded to CloudCache after deduplication and compression.","type":"integer","format":"uint64","x-go-name":"DataTransferCacheInBytes"},"dataTransferCloud":{"description":"The incremental data that is uploaded to the Druva Cloud after deduplication and compression.","type":"string","x-go-name":"DataTransferCloud"},"dataTransferCloudInBytes":{"description":"The incremental data in bytes that is uploaded to the Druva Cloud after deduplication and compression.","type":"integer","format":"uint64","x-go-name":"DataTransferCloudInBytes"}},"x-go-name":"DataTransferStruct","x-go-package":"phoenix/ahv/cloud/report/spec/jobs"},"AHVEnvironmentStruct":{"description":"The environment details of the job.","type":"object","properties":{"diskReadRate":{"description":"The bit rate for reading I/O by the agent. The Disk Read Rate is an average of the total data read with respect to the total time taken to read data at various intervals for all drives where data is distributed.","type":"string","x-go-name":"DiskReadRate"},"diskReadRateInKBps":{"description":"The bit rate in kilobytes per second for reading I/O by the agent. The Disk Read Rate is an average of the total data read with respect to the total time taken to read data at various intervals for all drives where data is distributed.","type":"number","format":"double","x-go-name":"DiskReadRateInKBps"},"networkRetries":{"description":"The number of network retries during the job.","type":"integer","format":"int32","x-go-name":"NetworkRetries"},"networkRetryDuration":{"description":"The total time spent in the network retries. It is the cumulative of all network session durations.","type":"string","x-go-name":"NetworkRetryDuration"},"networkRetryDurationInSeconds":{"description":"The total time spent in seconds in the network retries. It is the cumulative of all network session durations.","type":"integer","format":"int64","x-go-name":"NetworkRetryDurationInSeconds"}},"x-go-name":"EnvironmentStruct","x-go-package":"phoenix/ahv/cloud/report/spec/jobs"},"AHVEstimationDetailsStruct":{"description":"The estimation details of the job.","type":"object","properties":{"dataScanned":{"description":"Total data scanned during the job.","type":"integer","format":"uint64","x-go-name":"DataScanned"},"disksAdded":{"description":"Number of VM Disks added at source during the job.","type":"integer","format":"int64","x-go-name":"DisksAdded"},"disksModified":{"description":"Number of VM Disks changed at source during the job.","type":"integer","format":"int64","x-go-name":"DisksModified"},"disksRemoved":{"description":"Number of VM Disks removed at source during the job.","type":"integer","format":"int64","x-go-name":"DisksRemoved"},"sourceDataScanned":{"description":"The data scanned in megabytes at the source for backup.","type":"string","x-go-name":"SourceDataScanned"},"sourceDataScannedInBytes":{"description":"The data scanned in bytes at the source for backup.","type":"integer","format":"uint64","x-go-name":"SourceDataScannedInBytes"}},"x-go-name":"EstimationDetailsStruct","x-go-package":"phoenix/ahv/cloud/report/spec/jobs"},"AHVExecutionDetailsStruct":{"description":"The execution details of the job.","type":"object","properties":{"endTime":{"description":"The time when the job completes.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"The error code for the failed jobs. The possible values are:\n\n \\\"0\\\": If the job is successful\n\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"The error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"startTime":{"description":"The time when the job starts.","type":"string","x-go-name":"StartTime"},"status":{"description":"Status of the job.","type":"string","x-go-name":"Status"}},"x-go-name":"ExecutionDetailsStruct","x-go-package":"phoenix/ahv/cloud/report/spec/jobs"},"AHVGetAllBackupJobsInfoResponse":{"description":"List all backup jobs response.","type":"object","properties":{"jobs":{"description":"List of all backup jobs.","type":"array","items":{"$ref":"#/components/schemas/AHVGetBackupJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetAllBackupJobsInfoResponse","x-go-package":"phoenix/ahv/cloud/report/spec/jobs"},"AHVGetAllJobsInfoResponse":{"description":"List all jobs response.","type":"object","properties":{"jobs":{"description":"List of all jobs.","type":"array","items":{"$ref":"#/components/schemas/AHVJobResponse"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetAllJobsInfoResponse","x-go-package":"phoenix/ahv/cloud/report/spec/jobs"},"AHVGetAllRestoreJobsInfoResponse":{"description":"List all restore jobs response.","type":"object","properties":{"jobs":{"description":"List of all restore jobs.","type":"array","items":{"$ref":"#/components/schemas/AHVGetRestoreJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetAllRestoreJobsInfoResponse","x-go-package":"phoenix/ahv/cloud/report/spec/jobs"},"AHVGetAllUploadLogsJobsInfoResponse":{"description":"List all upload log jobs response.","type":"object","properties":{"jobs":{"description":"List of all upload log jobs.","type":"array","items":{"$ref":"#/components/schemas/AHVGetUploadLogsJobsReport"},"x-go-name":"Jobs"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetAllUploadLogsJobsInfoResponse","x-go-package":"phoenix/ahv/cloud/report/spec/jobs"},"AHVGetBackupJobsReport":{"description":"Details of backup jobs.","type":"object","properties":{"backupPolicyID":{"description":"The ID of your backup policy.","type":"integer","format":"int32","x-go-name":"BackupPolicyID"},"backupPolicyName":{"description":"The name of the backup policy.","type":"string","x-go-name":"BackupPolicyName"},"backupProxyName":{"description":"The name of Backup Proxy.","type":"string","x-go-name":"BackupProxyName"},"backupsetID":{"description":"The ID of your backup set.","type":"integer","format":"int32","x-go-name":"BackupsetID"},"dataTransfer":{"$ref":"#/components/schemas/AHVDataTransferStruct"},"environmentDetails":{"$ref":"#/components/schemas/AHVEnvironmentStruct"},"estimationDetails":{"$ref":"#/components/schemas/AHVEstimationDetailsStruct"},"executionDetails":{"$ref":"#/components/schemas/AHVExecutionDetailsStruct"},"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"The type of job.","type":"string","x-go-name":"JobType"},"organizationID":{"description":"The ID of your organization.","type":"integer","format":"int32","x-go-name":"OrgID"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"vmName":{"description":"The name of VM.","type":"string","x-go-name":"VMName"}},"x-go-name":"GetBackupJobsReport","x-go-package":"phoenix/ahv/cloud/report/spec/jobs"},"AHVGetBackupProxiesResponse":{"description":"List all backup proxies response.","type":"object","properties":{"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"},"proxies":{"description":"The list of the backup proxies deployed and the information of each backup proxy.","type":"array","items":{"$ref":"#/components/schemas/AHVBackupProxyInfo"},"x-go-name":"BackupProxies"}},"x-go-name":"GetBackupProxiesResponse","x-go-package":"phoenix/ahv/cloud/report/spec/proxies"},"AHVGetBackupsetsResponse":{"description":"List all backup sets response.","type":"object","properties":{"backupsets":{"description":"List of backup sets.","type":"array","items":{"$ref":"#/components/schemas/AHVBackupsetInfo"},"x-go-name":"Backupsets"},"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"}},"x-go-name":"GetBackupsetsResponse","x-go-package":"phoenix/ahv/cloud/report/spec/backupsets"},"AHVGetPolicies":{"description":"Details of backup policies.","type":"object","properties":{"automaticRetry":{"description":"Indicates whether automatic retry is enabled or disabled for the job.","type":"boolean","x-go-name":"AutomaticRetry"},"dataLock":{"description":"Indicates whether Data Lock is enabled in the backup policy.","type":"boolean","x-go-name":"ImmutabilityEnabled"},"description":{"description":"The policy description.","type":"string","x-go-name":"Description"},"ignoreFirstBackupDuration":{"description":"Indicates whether the first backup duration is to be ignored or not.","type":"boolean","x-go-name":"IgnoreBackupDuration"},"maxRetryCount":{"description":"The maximum number of retries.","type":"integer","format":"int64","x-go-name":"MaxRetryCount"},"maxRetryDuration":{"description":"The wait interval before the job is retried.","type":"string","x-go-name":"MaxRetryDuration"},"maxRetryDurationInSeconds":{"description":"The wait interval in seconds before the job is retried.","type":"integer","format":"int64","x-go-name":"MaxRetryDurationInSeconds"},"policyID":{"description":"The ID of your backup policy.","type":"integer","format":"int64","x-go-name":"PolicyID"},"policyName":{"description":"The name of the policy.","type":"string","x-go-name":"PolicyName"},"policyType":{"description":"The type of the policy.","type":"string","x-go-name":"PolicyType"},"retention":{"$ref":"#/components/schemas/AHVRetentionPolicy"},"schedules":{"description":"Schedules for the backup.","type":"array","items":{"$ref":"#/components/schemas/AHVSchedules"},"x-go-name":"Schedules"}},"x-go-name":"GetPolicies","x-go-package":"phoenix/ahv/cloud/report/spec/policies"},"AHVGetPoliciesResponse":{"description":"List all policies response.","type":"object","properties":{"nextPageToken":{"description":"The token to access the next page of results. This parameter will be empty for the last page of results.","type":"string","x-go-name":"OutToken"},"policies":{"description":"List of all backup policies.","type":"array","items":{"$ref":"#/components/schemas/AHVGetPolicies"},"x-go-name":"Policies"}},"x-go-name":"GetPoliciesResponse","x-go-package":"phoenix/ahv/cloud/report/spec/policies"},"AHVGetRestoreJobsReport":{"description":"Details of restore jobs.","type":"object","properties":{"backupProxyName":{"description":"The name of the backup proxy on which the job is processed.","type":"string","x-go-name":"BackupProxyName"},"backupsetID":{"description":"The ID of your backup set.","type":"integer","format":"int32","x-go-name":"BackupsetID"},"destinationVMName":{"description":"The name of the VM on which the restore was initiated.","type":"string","x-go-name":"DestinationVMName"},"environmentDetails":{"$ref":"#/components/schemas/AHVRestoreEnvironmentStruct"},"executionDetails":{"$ref":"#/components/schemas/AHVRestoreExecutionDetailsStruct"},"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"Type of the operation.","type":"string","x-go-name":"JobType"},"organizationID":{"description":"The ID of your organization.","type":"integer","format":"int32","x-go-name":"OrgID"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"restoreType":{"description":"Type of restore.","type":"string","x-go-name":"RestoreType"},"sourceVMName":{"description":"The name of the VM for which the restore was initiated.","type":"string","x-go-name":"SourceVMName"}},"x-go-name":"GetRestoreJobsReport","x-go-package":"phoenix/ahv/cloud/report/spec/jobs"},"AHVGetUploadLogsJobsReport":{"description":"Details of upload log jobs.","type":"object","properties":{"environmentDetails":{"$ref":"#/components/schemas/AHVUploadLogsEnvironmentStruct"},"executionDetails":{"$ref":"#/components/schemas/AHVUploadLogsExecutionDetailsStruct"},"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"Type of the operation.","type":"string","x-go-name":"JobType"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"vmName":{"description":"The name of the VM.","type":"string","x-go-name":"VMName"}},"x-go-name":"GetUploadLogsJobsReport","x-go-package":"phoenix/ahv/cloud/report/spec/jobs"},"AHVJobResponse":{"description":"Details of all jobs.","type":"object","properties":{"endTime":{"description":"The time when the job completes.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"The error code for the failed jobs. The possible values are:\n\n \\\"0\\\": If the job is successful\n\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"The error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"jobID":{"description":"A unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"jobType":{"description":"The type of job.","type":"string","x-go-name":"JobType"},"organizationName":{"description":"The name of the organization.","type":"string","x-go-name":"OrgName"},"startTime":{"description":"The time when the job starts.","type":"string","x-go-name":"StartTime"},"status":{"description":"Status of the job.","type":"string","x-go-name":"Status"},"vmName":{"description":"The name of VM.","type":"string","x-go-name":"VMName"}},"x-go-name":"JobResponse","x-go-package":"phoenix/ahv/cloud/report/spec/jobs"},"AHVLastBackupDetailsStruct":{"description":"The last backup details of the backup set.","type":"object","properties":{"jobID":{"description":"The unique identification number associated with the job.","type":"integer","format":"int32","x-go-name":"JobID"},"status":{"description":"Status of the job.","type":"string","x-go-name":"Status"}},"x-go-name":"LastBackupDetailsStruct","x-go-package":"phoenix/ahv/cloud/report/spec/backupsets"},"AHVRestoreEnvironmentStruct":{"description":"The environment details of the job.","type":"object","properties":{"diskWriteRate":{"description":"Indicates the bit rate for writing I/O by the agent. The Disk Write Rate is the average of the total data written with respect to the total time taken to write data at various intervals.","type":"string","x-go-name":"DiskWriteRate"},"diskWriteRateInKBps":{"description":"Indicates the bit rate in kilobytes per second for writing I/O by the agent. The Disk Write Rate is the average of the total data written with respect to the total time taken to write data at various intervals.","type":"number","format":"double","x-go-name":"DiskWriteRateInKBps"},"networkRetries":{"description":"The number of network retries during the job.","type":"integer","format":"int32","x-go-name":"NetworkRetries"},"networkRetryDuration":{"description":"Indicates the total time spent in the network retries. It represents the cumulative of all network session durations.","type":"string","x-go-name":"NetworkRetryDuration"},"networkRetryDurationInSeconds":{"description":"Indicates the total time spent in seconds in the network retries. It represents the cumulative of all network session durations.","type":"integer","format":"int64","x-go-name":"NetworkRetryDurationInSeconds"}},"x-go-name":"RestoreEnvironmentStruct","x-go-package":"phoenix/ahv/cloud/report/spec/jobs"},"AHVRestoreExecutionDetailsStruct":{"description":"The execution details of the job.","type":"object","properties":{"bandwidthConsumed":{"description":"The bit rate to transfer data from the Druva Cloud and CloudCache.","type":"string","x-go-name":"BandwidthConsumed"},"bandwidthConsumedInKBps":{"description":"The bit rate in kilobytes per second to transfer data from the Druva Cloud and CloudCache.","type":"number","format":"double","x-go-name":"BandwidthConsumedInKBps"},"endTime":{"description":"The time when the job completes.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"The error code for the failed jobs. The possible values are:\n\n \\\"0\\\": If the job is successful\n\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"The error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"restoredData":{"description":"The total amount of data restored.","type":"string","x-go-name":"RestoredData"},"restoredDataInBytes":{"description":"The total amount of data restored in bytes.","type":"integer","format":"uint64","x-go-name":"RestoredDataInBytes"},"restoredItems":{"description":"Data items restored.","type":"string","x-go-name":"RestoredItems"},"startTime":{"description":"The time when the job starts.","type":"string","x-go-name":"StartTime"},"status":{"description":"The status of the job.","type":"string","x-go-name":"Status"}},"x-go-name":"RestoreExecutionDetailsStruct","x-go-package":"phoenix/ahv/cloud/report/spec/jobs"},"AHVRetentionPolicy":{"description":"Details of the retention policy.","type":"object","properties":{"allSnapshots":{"description":"The number of days for which daily backup recovery points are to be retained.","type":"string","x-go-name":"Daily"},"ltrEnabled":{"description":"Indicates whether the backup is enabled for long term retention.","type":"boolean","x-go-name":"LTREnabled"},"monthly":{"description":"The number of months for which monthly backup recovery points are to be retained.","type":"string","x-go-name":"Monthly"},"warmTierDuration":{"description":"The duration in days for which the snapshot resides in the warm tier of the AWS storage.","type":"integer","format":"int32","x-go-name":"WarmTierDuration"},"weekly":{"description":"The number of weeks for which weekly backup recovery points are to be retained.","type":"string","x-go-name":"Weekly"},"yearly":{"description":"The number of years for which yearly backup recovery points are to be retained.","type":"string","x-go-name":"Yearly"}},"x-go-name":"RetentionPolicy","x-go-package":"phoenix/ahv/cloud/report/spec/policies"},"AHVSchedules":{"description":"Details of schedules for the backup.","type":"object","properties":{"bandwidth":{"description":"The maximum bandwidth allowed for the backup.","type":"string","x-go-name":"Bandwidth"},"bandwidthInKBps":{"description":"The maximum bandwidth allowed for the backup in KBps.","type":"number","format":"double","x-go-name":"BandwidthInKBps"},"duration":{"description":"The duration after which you want the backup jobs to stop.","type":"string","x-go-name":"Duration"},"durationInSeconds":{"description":"The duration in seconds after which you want the backup jobs to stop.","type":"integer","format":"int64","x-go-name":"DurationInSeconds"},"repeatOn":{"$ref":"#/components/schemas/JSONStringList"},"startAt":{"description":"The scheduled start time.","type":"string","x-go-name":"StartAt"}},"x-go-name":"Schedules","x-go-package":"phoenix/ahv/cloud/report/spec/policies"},"AHVUploadLogsEnvironmentStruct":{"description":"The environment details of the job.","type":"object","properties":{"diskWriteRate":{"description":"Disk write rate during the job.","type":"string","x-go-name":"DiskWriteRate"},"networkRetries":{"description":"The number of network retries during the job.","type":"integer","format":"int32","x-go-name":"NetworkRetries"},"networkRetryDuration":{"description":"The duration of network retries during the job.","type":"string","x-go-name":"NetworkRetryDuration"}},"x-go-name":"UploadLogsEnvironmentStruct","x-go-package":"phoenix/ahv/cloud/report/spec/jobs"},"AHVUploadLogsExecutionDetailsStruct":{"description":"The execution details of the job.","type":"object","properties":{"endTime":{"description":"The time when the job completes.","type":"string","x-go-name":"EndTime"},"errorCode":{"description":"The error code for the failed jobs. The possible values are:\n\n \\\"0\\\": If the job is successful\n\n: If the job has failed","type":"string","x-go-name":"ErrorCode"},"errorMessage":{"description":"The error message for the failed jobs. This field is empty if the job is successful.","type":"string","x-go-name":"ErrorMsg"},"logsExpiryTime":{"description":"Expiry time of the uploaded logs.","type":"string","x-go-name":"LogsExpiryTime"},"logsSize":{"description":"The size of the extracted log files.","type":"string","x-go-name":"LogsSize"},"logsSizeInBytes":{"description":"The size of the extracted log files in bytes.","type":"integer","format":"uint64","x-go-name":"LogsSizeInBytes"},"sourceJobID":{"description":"The job for which logs are requested.","type":"integer","format":"int32","x-go-name":"SourceJobID"},"sourceJobLogType":{"description":"The job type for which logs are requested.","type":"string","x-go-name":"SourceJobLogType"},"startTime":{"description":"The time when the job starts.","type":"string","x-go-name":"StartTime"},"status":{"description":"The status of the job.","type":"string","x-go-name":"Status"}},"x-go-name":"UploadLogsExecutionDetailsStruct","x-go-package":"phoenix/ahv/cloud/report/spec/jobs"}}}}