appliance recovery backup job details: info
The
info
structure contains information about a backup job. This structure was added in vSphere API 6.7Representation:
{
"cancelable": true,
"description": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"duration": 1,
"end_time": "2015-01-01T22:13:05.651Z",
"error": {},
"location": "http://myurl.com",
"location_user": "string",
"messages": [
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
}
],
"operation": "obj-103",
"parent": "obj-103",
"progress": {
"completed": 1,
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"total": 1
},
"service": "obj-103",
"size": 1,
"start_time": "2015-01-01T22:13:05.651Z",
"status": "PENDING",
"target": {
"id": "obj-103",
"type": "string"
},
"type": "SCHEDULED",
"user": "string"
}
"cancelable": true,
"description": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"duration": 1,
"end_time": "2015-01-01T22:13:05.651Z",
"error": {},
"location": "http://myurl.com",
"location_user": "string",
"messages": [
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
{
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
}
],
"operation": "obj-103",
"parent": "obj-103",
"progress": {
"completed": 1,
"message": {
"args": [
"string",
"string"
],
"default_message": "string",
"id": "string"
},
"total": 1
},
"service": "obj-103",
"size": 1,
"start_time": "2015-01-01T22:13:05.651Z",
"status": "PENDING",
"target": {
"id": "obj-103",
"type": "string"
},
"type": "SCHEDULED",
"user": "string"
}
Attributes:
Name | Type | Description |
---|---|---|
Required | ||
location | URI | URL of the backup location. This attribute was added in vSphere API 6.7 |
location_user | string | The username for the remote backup location. This attribute was added in vSphere API 6.7 |
type | string | Type of the backup job. Indicates whether the backup was started manually or as a scheduled backup. This attribute was added in vSphere API 6.7 Defines the type of backup job. This enumeration was added in vSphere API 6.7 Value is one of: SCHEDULED: Job type is Scheduled. This constant was added in vSphere API 6.7 MANUAL: Job type is Manual. This constant was added in vSphere API 6.7 |
messages | localizable_message[] | List of any info/warning/error messages returned by the backup job. This attribute was added in vSphere API 6.7 |
description | localizable_message | Description of the operation associated with the task. This attribute was added in vSphere API 6.7 |
service | string | Name of the service containing the operation. This attribute was added in vSphere API 6.7 When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vapi.service . When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vapi.service . |
operation | string | Name of the operation associated with the task. This attribute was added in vSphere API 6.7 When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vapi.operation . When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vapi.operation . |
status | string | Status of the operation associated with the task. This attribute was added in vSphere API 6.7 Defines the status values that can be reported for an operation. This enumeration was added in vSphere API 6.7 Value is one of: PENDING: The operation is in pending state. This constant was added in vSphere API 6.7 RUNNING: The operation is in progress. This constant was added in vSphere API 6.7 BLOCKED: The operation is blocked. This constant was added in vSphere API 6.7 SUCCEEDED: The operation completed successfully. This constant was added in vSphere API 6.7 FAILED: The operation failed. This constant was added in vSphere API 6.7 |
cancelable | boolean | Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses. This attribute was added in vSphere API 6.7 |
Optional | ||
duration | long | Time in seconds since the backup job was started or the time it took to complete the backup job. This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [SUCCEEDED, FAILED, RUNNING]. This field is optional and it is only relevant when the value of #status is one of SUCCEEDED, FAILED, or RUNNING. |
size | long | Size of the backup data transferred to remote location. This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [SUCCEEDED, FAILED, RUNNING]. This field is optional and it is only relevant when the value of #status is one of SUCCEEDED, FAILED, or RUNNING. |
progress | progress | Progress of the job. This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [SUCCEEDED, FAILED, RUNNING]. This field is optional and it is only relevant when the value of #status is one of SUCCEEDED, FAILED, or RUNNING. |
parent | string | Parent of the current task. This attribute was added in vSphere API 6.7 Optional. This field will be unset if the task has no parent.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.cis.task . When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.cis.task . |
target | dynamic_ID | Identifier of the target created by the operation or an existing one the operation performed on. This attribute was added in vSphere API 6.7 Optional. This field will be unset if the operation has no target or multiple targets. |
error | exception | Description of the error if the operation status is "FAILED". This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [FAILED]. If unset the description of why the operation failed will be included in the result of the operation (see cis.task.info.result). |
start_time | date_time | Time when the operation is started. This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [RUNNING, BLOCKED, SUCCEEDED, FAILED]. This field is optional and it is only relevant when the value of status is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED. |
end_time | date_time | Time when the operation is completed. This attribute was added in vSphere API 6.7 Optional. It is only relevant when status has value [SUCCEEDED, FAILED]. This field is optional and it is only relevant when the value of status is one of SUCCEEDED or FAILED. |
user | string | Name of the user who performed the operation. This attribute was added in vSphere API 6.7 Optional. This field will be unset if the operation is performed by the system. |