Appliance Recovery Backup Schedules get
Returns an existing schedule information based on id
This operation was added in vSphere API 6.7.
Identifier of the schedule
The parameter must be an identifier for the resource type: com.vmware.appliance.recovery.backup.schedule.
Info Structure
{
"parts": [
"string"
],
"location": "string",
"location_user": "string",
"enable": false,
"recurrence_info": {
"minute": 0,
"hour": 0,
"days": [
"string"
]
},
"retention_info": {
"max_count": 0
},
"fast_backup": false
}List of optional parts that will be included in backups based on this schedule details. Use the GET /appliance/recovery/backup/parts operation to get information about the supported parts.
This property was added in vSphere API 6.7.
URL of the backup location.
This property was added in vSphere API 6.7.
Username for the given location.
This property was added in vSphere API 6.7.
If missing or null location user will not be used.
Enable or disable a schedule, by default when created a schedule will be enabled.
This property was added in vSphere API 6.7.
Recurrence information for the schedule.
This property was added in vSphere API 6.7.
If missing or null backup job is not scheduled. See Appliance Recovery Backup Schedules RecurrenceInfo
Retention information for the schedule.
This property was added in vSphere API 6.7.
If missing or null all the completed backup jobs are retained forever. See Appliance Recovery Backup Schedules RetentionInfo
Option to enable Postgres DB/ VCDB fast backup
This property was added in vSphere API 6.7.
If missing or null backup will proceed at slow rate
if schedule associated with id does not exist.
"Vapi Std Errors NotFound Object"if any error occurs during the execution of the operation.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
curl -H 'Authorization: <value>' https://{api_host}/api/appliance/recovery/backup/schedules/{schedule}