appliance recovery backup job details: list
Returns detailed information about the current and historical backup jobs. This operation was added in vSphere API 6.7.
Request:
HTTP request
GET https://{server}/rest/appliance/recovery/backup/job/details
?filter.jobs.1=obj-103
&filter.jobs.2=obj-103
?filter.jobs.1=obj-103
&filter.jobs.2=obj-103
Request Query Parameters:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| filter | filter_spec | Optional. Specification of matching backup jobs for which information should be returned. |
| filter.jobs | string[] | Identifiers of backup jobs that can match the filter. This attribute was added in vSphere API 6.7. Optional. If unset the filter will match all the backup jobs.When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: com.vmware.appliance.recovery.backup.job. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: com.vmware.appliance.recovery.backup.job. |
Response:
HTTP Status Code: 200
Representation:
{
"value" : [
{
"value" : {
"parent" : "obj-103",
"cancelable" : true,
"end_time" : "2015-01-01T22:13:05.651Z",
"description" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"error" : {},
"type" : "SCHEDULED",
"target" : {
"id" : "obj-103",
"type" : "string"
},
"duration" : 1,
"start_time" : "2015-01-01T22:13:05.651Z",
"size" : 1,
"build" : {
"version_name" : "string",
"build_number" : "string",
"version" : "string"
},
"service" : "obj-103",
"progress" : {
"total" : 1,
"completed" : 1,
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"messages" : [
{
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
{
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
],
"location" : "http://myurl.com",
"operation" : "obj-103",
"user" : "string",
"status" : "PENDING",
"location_user" : "string"
},
"key" : "obj-103"
}
]
}
"value" : [
{
"value" : {
"parent" : "obj-103",
"cancelable" : true,
"end_time" : "2015-01-01T22:13:05.651Z",
"description" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
"error" : {},
"type" : "SCHEDULED",
"target" : {
"id" : "obj-103",
"type" : "string"
},
"duration" : 1,
"start_time" : "2015-01-01T22:13:05.651Z",
"size" : 1,
"build" : {
"version_name" : "string",
"build_number" : "string",
"version" : "string"
},
"service" : "obj-103",
"progress" : {
"total" : 1,
"completed" : 1,
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"messages" : [
{
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
},
{
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
],
"location" : "http://myurl.com",
"operation" : "obj-103",
"user" : "string",
"status" : "PENDING",
"location_user" : "string"
},
"key" : "obj-103"
}
]
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | list | Map of backup job identifier to Info Structure.List of {"key": string, "value": info} |
| value[].key | string | |
| value[].value | info | |
| value[].value.location | URI | URL of the backup location. This attribute was added in vSphere API 6.7. |
| value[].value.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. |
| value[].value.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. |
| value[].value.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. |
| value[].value.progress.total | long | Total amount of the work for the operation. This attribute was added in vSphere API 6.7. |
| value[].value.progress.completed | long | The amount of work completed for the operation. The value can only be incremented. This attribute was added in vSphere API 6.7. |
| value[].value.progress.message | localizable_message | Message about the work progress. This attribute was added in vSphere API 6.7. |
| value[].value.progress.message.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
| value[].value.progress.message.default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
| value[].value.progress.message.args | string[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 500 | error | if any error occurs during the execution of the operation. |