Cis Tasks get
Returns information about a task.
This operation was added in vSphere API 6.7.1.
Task identifier.
The parameter must be an identifier for the resource type: com.vmware.cis.task.
Specification on what to get for a task.
If missing or null, the behavior is equivalent to a Cis Tasks GetSpec with all properties missing or null which means only the data described in Cis Task Info will be returned and the result of the operation will be return.
Information about the specified task.
"Cis Task Info Object"Progress of the operation.
This property was added in vSphere API 6.7.
This property is optional and it is only relevant when the value of status is one of Cis Task Status.RUNNING, Cis Task Status.BLOCKED, Cis Task Status.SUCCEEDED, or Cis Task Status.FAILED.
Result of the operation.
If an operation reports partial results before it completes, this property could be set before the Cis Task CommonInfo.status has the value Cis Task Status.SUCCEEDED. The value could change as the operation progresses.
This property was added in vSphere API 6.7.
This property will be missing or null if the operation does not return a result or if the result is not available at the current step of the operation.
Description of the operation associated with the task.
This property was added in vSphere API 6.7.
Identifier of the service containing the operation.
This property was added in vSphere API 6.7.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vapi.service. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vapi.service.
Identifier of the operation associated with the task.
This property was added in vSphere API 6.7.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vapi.operation. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vapi.operation.
Parent of the current task.
This property was added in vSphere API 6.7.
This property will be missing or null if the task has no parent.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.cis.task. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.cis.task.
Identifier of the target created by the operation or an existing one the operation performed on.
This property was added in vSphere API 6.7.
This property will be missing or null if the operation has no target or multiple targets.
Status of the operation associated with the task.
For more information see: Cis Task Status.
This property was added in vSphere API 6.7.
Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses.
This property was added in vSphere API 6.7.
Description of the error if the operation status is "FAILED".
This property was added in vSphere API 6.7.
If missing or null the description of why the operation failed will be included in the result of the operation (see Cis Task Info.result).
Time when the operation is started.
This property was added in vSphere API 6.7.
This property is optional and it is only relevant when the value of status is one of Cis Task Status.RUNNING, Cis Task Status.BLOCKED, Cis Task Status.SUCCEEDED, or Cis Task Status.FAILED.
Time when the operation is completed.
This property was added in vSphere API 6.7.
This property is optional and it is only relevant when the value of status is one of Cis Task Status.SUCCEEDED or Cis Task Status.FAILED.
Name of the user who performed the operation.
This property was added in vSphere API 6.7.
This property will be missing or null if the operation is performed by the system.
if the user can not be authenticated.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
if the user doesn't have the required privileges.
"Vapi Std Errors Unauthorized Object"if the task is not found.
"Vapi Std Errors NotFound Object"Vapi Std Errors Error if the system reports an error while responding to the request.
Vapi Std Errors ResourceInaccessible if the task's state cannot be accessed.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
if the system is unable to communicate with a service to complete the request.
"Vapi Std Errors ServiceUnavailable Object" curl -H 'Authorization: <value>' https://{api_host}/api/cis/tasks/{task}