Vcenter V Storage Object Manager Vstorage Object V Center Query Changed Disk Areas

Vcenter V Storage Object Manager Vstorage Object V Center Query Changed Disk Areas

Get a list of areas of a virtual disk that have been modified since a well-defined point in the past.

The beginning of the change interval is identified by "changeId", while the end of the change interval is implied by the snapshot ID passed in.

Note that the result of this function may contain "false positives" (i.e: flag areas of the disk as modified that are not). However, it is guaranteed that no changes will be missed.

Required privileges: System.View

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/VcenterVStorageObjectManager/{moId}/VstorageObjectVCenterQueryChangedDiskAreas
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 VcenterVStorageObjectManager/{moId}.

string
release
Required

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


Request Body
Required

Show optional properties

{
    "id": {
        "id": "string"
    },
    "datastore": {},
    "snapshotId": {
        "id": "string"
    },
    "startOffset": 0,
    "changeId": "string"
}
{
    "id": {
        "_typeName": "string",
        "id": "string"
    },
    "datastore": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "snapshotId": {
        "_typeName": "string",
        "id": "string"
    },
    "startOffset": 0,
    "changeId": "string"
}
id
Required

This data object type describes an identifier class which is globally unique to identify the associated object.

datastore
Required

Reference to an instance of the Datastore managed object.

snapshotId
Required

This data object type describes an identifier class which is globally unique to identify the associated object.

integer As int64 As int64
startOffset
Required

Start Offset in bytes at which to start computing changes. Typically, callers will make multiple calls to this function, starting with startOffset 0 and then examine the "length" property in the returned DiskChangeInfo structure, repeatedly calling queryChangedDiskAreas until a map for the entire virtual disk has been obtained.

string
changeId
Required

Identifier referring to a point in the past that should be used as the point in time at which to begin including changes to the disk in the result. A typical use case would be a backup application obtaining a changeId from a virtual disk's backing info when performing a backup. When a subsequent incremental backup is to be performed, this change Id can be used to obtain a list of changed areas on disk.

Authentication
This operation uses the following authentication methods.
Responses
200

Returns a data structure specifying extents of the virtual disk that have changed since the thime the changeId string was obtained.

Returns DiskChangeInfo of type(s) application/json
This response body class contains all of the following: DataObject
{
    "_typeName": "string",
    "startOffset": 0,
    "length": 0,
    "changedArea": [
        {
            "_typeName": "string",
            "start": 0,
            "length": 0
        }
    ]
}
integer As int64 As int64
startOffset
Required

Start offset (in bytes) of disk area described by this data structure.

integer As int64 As int64
length
Required

Length (in bytes) of disk area described by this data structure.

changedArea
Optional

Modified disk areas.

Might be empty if no parts of the disk between startOffset and startOffset + length were modified.


500

InvalidDatastore: If the operation cannot be performed on the datastore.

NotFound: If specified virtual storage object or snapshot cannot be found.

FileFault: if the virtual disk files cannot be accessed/queried.

InvalidState: if change tracking is not supported for this particular disk.

InvalidArgument: if startOffset is beyond the end of the virtual disk or changeId is invalid.

Returns MethodFault of type(s) application/json
This response body class contains all of the following: Any
{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}
faultCause
Optional

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

faultMessage
Optional

Message which has details about the error Message can also contain a key to message catalog which can be used to generate better localized messages.


Virtual Infrastructure Operations
POST
Vcenter V Storage Object Manager Attach Tag To V Storage Object
POST
Vcenter V Storage Object Manager Clear V Storage Object Control Flags
POST
Vcenter V Storage Object Manager Clone V Storage Object Task
POST
Vcenter V Storage Object Manager Create Disk Task
POST
Vcenter V Storage Object Manager Create Disk From Snapshot Task
POST
Vcenter V Storage Object Manager Delete Snapshot Task
POST
Vcenter V Storage Object Manager Delete V Storage Object Task
POST
Vcenter V Storage Object Manager Delete V Storage Object Ex Task
POST
Vcenter V Storage Object Manager Detach Tag From V Storage Object
POST
Vcenter V Storage Object Manager Extend Disk Task
POST
Vcenter V Storage Object Manager Inflate Disk Task
POST
Vcenter V Storage Object Manager List Tags Attached To V Storage Object
POST
Vcenter V Storage Object Manager List V Storage Object
POST
Vcenter V Storage Object Manager List V Storage Objects Attached To Tag
POST
Vcenter V Storage Object Manager Query Virtual Disk Uuid Ex
POST
Vcenter V Storage Object Manager Reconcile Datastore Inventory Task
POST
Vcenter V Storage Object Manager Register Disk
POST
Vcenter V Storage Object Manager Relocate V Storage Object Task
POST
Vcenter V Storage Object Manager Rename V Storage Object
POST
Vcenter V Storage Object Manager Rename V Storage Object Ex
POST
Vcenter V Storage Object Manager Retrieve Snapshot Details
POST
Vcenter V Storage Object Manager Retrieve Snapshot Info
POST
Vcenter V Storage Object Manager Retrieve V Storage Infrastructure Object Policy
POST
Vcenter V Storage Object Manager Retrieve V Storage Object
POST
Vcenter V Storage Object Manager Retrieve V Storage Object Associations
POST
Vcenter V Storage Object Manager Retrieve V Storage Object State
POST
Vcenter V Storage Object Manager Revert V Storage Object Task
POST
Vcenter V Storage Object Manager Revert V Storage Object Ex Task
POST
Vcenter V Storage Object Manager Schedule Reconcile Datastore Inventory
POST
Vcenter V Storage Object Manager Set Virtual Disk Uuid Ex Task
POST
Vcenter V Storage Object Manager Set V Storage Object Control Flags
POST
Vcenter V Storage Object Manager Update V Storage Infrastructure Object Policy Task
POST
Vcenter V Storage Object Manager Update V Storage Object Crypto Task
POST
Vcenter V Storage Object Manager Update V Storage Object Policy Task
POST
Vcenter V Storage Object Manager V Center Update V Storage Object Metadata Ex Task
POST
Vcenter V Storage Object Manager V Storage Object Create Snapshot Task
POST
Vcenter V Storage Object Manager V Storage Object Create Snapshot Ex Task
POST
Vcenter V Storage Object Manager V Storage Object Delete Snapshot Ex Task
POST
Vcenter V Storage Object Manager V Storage Object Extend Disk Ex Task
POST
Vcenter V Storage Object Manager Vstorage Object V Center Query Changed Disk Areas