Overview | Service | Command |
Queries the status of the most recent HSM session. Status information for a given HSM
session is available until the next time HSM runs or until the server is restarted.
Notes:
Network edition only API | TRUE |
Authorization token required | true |
Admin Authorization token required | true |
<GetHsmStatusRequest /> ## GetHsmStatusRequest
<GetHsmStatusResponse running="(0|1)" [startDate="{start-date-millis} (Long)"] [endDate="{end-date-millis} (Long)"]
[wasAborted="{was-aborted} (0|1)"] [aborting="{abort-in-progress} (0|1)"]
[error="{error-text}"] [numBlobsMoved="{num-blobs-moved} (Integer)"]
[numBytesMoved="{num-bytes-moved} (Long)"]
[numMailboxes="{num-mailboxes-processed} (Integer)"]
[totalMailboxes="{total-mailboxes} (Integer)"] [destVolumeId="{dest-volume-id} (Short)"]
[query="{search-query}"] /> ## GetHsmStatusResponse
The following table describes elements and attributes you can define within a
<GetHsmStatusResponse>
element:
XPath | Required / Optional | Description |
@running | Required (only 1) | Type:0|1 1 (true) if an HSM session is currently running, 0 (false) if the information returned applies to the last completed HSM session |
@startDate | Optional (0 or 1) | Type:Long the start date of the HSM session in milliseconds |
@endDate | Optional (0 or 1) | Type:Long the end date of the HSM session in milliseconds |
@wasAborted | Optional (0 or 1) | Type:0|1 1 (true) if the HSM session was aborted |
@aborting | Optional (0 or 1) | Type:0|1 1 (true) if the HSM session is in the process of aborting |
@error | Optional (0 or 1) | Type:String The error message, if an error occurred while processing the last <HsmRequest> |
@numBlobsMoved | Optional (0 or 1) | Type:Integer The number of blobs that were moved |
@numBytesMoved | Optional (0 or 1) | Type:Long The number of bytes that were moved |
@numMailboxes | Optional (0 or 1) | Type:Integer The number of mailboxes that have been processed |
@totalMailboxes | Optional (0 or 1) | Type:Integer Total number of mailboxes that should be processed by the HSM session |
@destVolumeId | Optional (0 or 1) | Type:Short The ID of the volume to which messages are being moved |
@query | Optional (0 or 1) | Type:String The query that is used to find messages to move |