Sms Task Query Sms Task Info

Get detailed information about this task.

Required privileges: StorageViews.View

Request

URI

POST

https://{vcenter-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 8.0.3.0 APIs.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

TaskInfo

Returns SmsTaskInfo of type(s) application/json

This response body class contains all of the following: DataObject

{
    "_typeName": "string",
    "key": "string",
    "task": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "object": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "error": {
        "_typeName": "string",
        "faultCause": "MethodFault Object",
        "faultMessage": [
            {
                "_typeName": "string",
                "key": "string",
                "arg": [
                    {
                        "_typeName": "string",
                        "key": "string",
                        "value": {
                            "_typeName": "string"
                        }
                    }
                ],
                "message": "string"
            }
        ]
    },
    "result": {
        "_typeName": "string"
    },
    "startTime": "string",
    "completionTime": "string",
    "state": "string",
    "progress": 0
}

string

key

Required

The unique key for the task.

MoRefSmsTask

task

Required

Reference to an instance of the SmsTask managed object.

This structure may be used only with operations rendered under /sms.

ManagedObjectReference

object

Optional

The ManagedObjectReference data object type is a special-purpose data object. Commonly referred to as simply a "reference", "MoRef", "MOR", or other variations of this theme, instances of managed object references contain data that identifies specific server-side managed objects. Managed object references are typically one of the return types from a method invocation.

Managed object references are client application references to server-side managed objects. The client application uses ManagedObjectReference objects when it invokes operations on a server. A ManagedObjectReference is guaranteed to be unique and persistent during an object's lifetime. The reference persists after an object has moved within the inventory, across sessions, and across server restarts. If you remove an object, for example, a virtual machine, from the inventory, and then put it back, the reference changes.

MethodFault

error

Optional

The base data object type for all the object model faults that an application might handle.

Any

result

Optional

The base of all data types. Not to be used directly on the wire.

string As date-time As date-time

startTime

Optional

Time stamp when the task started running.