REST API - info

appliance recovery reconciliation job: info

The info structure represents the reconciliation job information. It contains information related to current Status, any associated messages and progress as percentage. This structure was added in vSphere API 6.7

Representation:

JSON

{
    "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"
    }
}

Attributes:

Name	Type	Description
Required
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.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`.
operation	string	Name of the operation associated with the task. This attribute was added in vSphere API 6.7
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
messages	localizable_message[]	A list of localized messages. This attribute was added in vSphere API 6.7
progress	long	The progress of the job as a percentage. This attribute was added in vSphere API 6.7
Optional
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`.
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.
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.
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).
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.
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.