This API has a deprecated equivalent from v7.0U1.
Get Import History
Get the current status of the vCenter historical data import.
Request
URLURL
https://{api_host}/api/vcenter/deployment/history
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
DeploymentImportHistoryInfo
of type application/json
Info structure containing the status information about the historical data import status.
{
"cancelable": false,
"description": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"end_time": "string",
"error": {},
"operation": "string",
"parent": "string",
"progress": {
"completed": 0,
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"total": 0
},
"result": {
"errors": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"time": "string"
}
],
"info": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"time": "string"
}
],
"warnings": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": {
"key": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
},
"time": "string"
}
]
},
"service": "string",
"start_time": "string",
"status": "enum",
"target": {
"id": "string",
"type": "string"
},
"user": "string"
}
boolean
cancelable
Required
Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses.
string
service
Required
Identifier of the service containing the operation. 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.
string
operation
Required
Identifier of the operation associated with the task. 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.
progress
Optional
The progress info of this task. This field is optional and it is only relevant when the value of CommonInfo#status is one of RUNNING, FAILED, BLOCKED, or SUCCEEDED.
string
parent
Optional
Parent of the current task. 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.
result
Optional
Result of the operation. If an operation reports partial results before it completes, this field could be set before the com.vmware.cis.task.CommonInfo#status has the value SUCCEEDED. The value could change as the operation progresses. This field will be unset if result is not available at the current step of the operation.
object
error
Optional
Description of the error if the operation status is “FAILED”. If unset the description of why the operation failed will be included in the result of the operation (see Info.result).
string
start_time
Optional
Time when the operation is started. This field is optional and it is only relevant when the value of CommonInfo.status is one of RUNNING, BLOCKED, SUCCEEDED, or FAILED.
string
end_time
Optional
Time when the operation is completed. This field is optional and it is only relevant when the value of CommonInfo.status is one of SUCCEEDED or FAILED.
target
Optional
Identifier of the target created by the operation or an existing one the operation performed on. This field will be unset if the operation has no target or multiple targets.
string
user
Optional
Name of the user who performed the operation. This field will be unset if the operation is performed by the system.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the caller is not authorized to perform the operation.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
Invoke-GetDeploymentHistory
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/deployment/history
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/deployment/history
x-vmw-doc-operation: get
Availability
Added in 7.0U2
On This Page
Import History Operations
post
post
