appliance recovery reconciliation job: get

Get reconciliation job progress/result. This operation was added in vSphere API 6.7

Request:

HTTP request

GET https://{server}/rest/appliance/recovery/reconciliation/job
No request parameters

Response:

HTTP Status Code: 200

Representation:

{
    "value"{
        "cancelable"true,
        "description"{
            "args"[
                "string",
                "string"
            ],
            "default_message""string",
            "id""string"
        },
        "end_time""2015-01-01T22:13:05.651Z",
        "error"{},
        "messages"[
            {
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "id""string"
            },
            {
                "args"[
                    "string",
                    "string"
                ],
                "default_message""string",
                "id""string"
            }
        ],
        "operation""string",
        "parent""obj-103",
        "progress"1,
        "service""obj-103",
        "start_time""2015-01-01T22:13:05.651Z",
        "status""NONE",
        "target"{
            "id""obj-103",
            "type""string"
        }
    }
}

Response Type:

Name Type Description
bold = required
value info Info Structure.
value.description localizable_message Description of the operation associated with the task. This attribute was added in vSphere API 6.7

value.description.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.description.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.description.args string[] Arguments to be substituted into a message template.

value.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.appliance.recovery.reconciliation.job. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.appliance.recovery.reconciliation.job.

value.operation string Name of the operation associated with the task. This attribute was added in vSphere API 6.7

value.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.appliance.recovery.reconciliation.job. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.appliance.recovery.reconciliation.job.

value.target dynamic_ID Identifier of the target resource the operation modifies. This attribute was added in vSphere API 6.7

Optional. This field will be unset if the task has multiple targets or no target.

value.target.type string The type of resource being identified (for example com.acme.Person).

Services that contain operations for creating and deleting resources typically contain a constant specifying the resource type for the resources being created and deleted. The API metamodel metadata services include a service that allows retrieving all the known resource types.

value.target.id string The identifier for a resource whose type is specified by vapi.std.dynamic_ID.type.

When clients pass a value of this structure as a parameter, the field type must contain the actual resource type. When operations return a value of this structure as a result, the field type will contain the actual resource type.

value.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:
NONE: The operation is not running. This constant was added in vSphere API 6.7
RUNNING: The operation is in progress. 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

value.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. If unset, the operation cannot be canceled.

value.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 Info#result).

value.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, SUCCEEDED, FAILED]. This field is optional and it is only relevant when the value of status is one of RUNNING, SUCCEEDED, or FAILED.

value.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.

value.messages localizable_message[] A list of localized messages. This attribute was added in vSphere API 6.7

value.messages[].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.messages[].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.messages[].args string[] Arguments to be substituted into a message template.

value.progress long The progress of the job as a percentage. This attribute was added in vSphere API 6.7

Errors:

HTTP Status Code Type Description
404 not_found if there is no running reconciliation job.
500 error if any error occurs during the execution of the operation.