Sms Task Query Sms Task Info

Sms Task Query Sms Task Info

Get detailed information about this task.

Required privileges: StorageViews.View

Request
URI
POST
https://{api_host}/sdk/vim25/{release}/sms/SmsTask/{moId}/QuerySmsTaskInfo
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case SmsTask/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 9.0.0.0 APIs.

Authentication
This operation uses the following authentication methods.
Responses
200

TaskInfo

Returns SmsTaskInfo of type(s) application/json 
"SmsTaskInfo Object"
string
key
Required

The unique key for the task.

task
Required

The managed object that represents this task.

object
Optional

Managed Object to which the operation applies.

error
Optional

If the task state is "error", then this property contains the fault code.

result
Optional

If the task state is "success", then this property may be used to hold a return value.

string As date-time As date-time
startTime
Optional

Time stamp when the task started running.

string As date-time As date-time
completionTime
Optional

Time stamp when the task was completed (whether success or failure).

string
state
Required

Runtime status of the task.

Possible values are SmsTaskStateEnum

integer As int32 As int32
progress
Optional

If the task state is "running", then this property contains a progress measurement, expressed as percentage completed, from 0 to 100.

If this property is not set, then the command does not report progress.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' https://{api_host}/sdk/vim25/{release}/sms/SmsTask/{moId}/QuerySmsTaskInfo
On This Page
Storage Monitoring Service Operations
POST
Sms Task Query Sms Task Info
POST
Sms Task Query Sms Task Result