Get Vsan Hcl Attributes

Get Vsan Hcl Attributes

Attributes of vSAN HCL data such as timestamp of last update

Request
URI
GET
https://{api_host}/v1/vsan-hcl/attributes
COPY
Responses
200

Ok

Returns VsanHclAttributes of type(s) application/json
{
    "remoteDataTimestamp": 0,
    "localDataTimestamp": 0,
    "lastError": "string",
    "isLocalDataMissing": false,
    "isNewDataAvailable": false,
    "isWarningThresholdExceeded": false,
    "isErrorThresholdExceeded": false,
    "localDataTime": "string"
}
integer As int64 As int64
remoteDataTimestamp
Required

Timestamp of vSAN HCL data (in seconds) from remote vSAN HCL service as determined by periodic polling

integer As int64 As int64
localDataTimestamp
Required

Timestamp of vSAN HCL data (in seconds) saved on SDDC Manager

string
lastError
Optional

Details of last error in case of failure in updating vSAN HCL data on SDDC Manager

boolean
isLocalDataMissing
Optional

True if vSAN HCL data is missing on SDDC Manager

boolean
isNewDataAvailable
Optional

True if timestamp of vSAN HCL data on SDDC Manager is older than timestamp fetched via periodic polling

boolean
isWarningThresholdExceeded
Optional

True if age of vSAN HCL data on SDDC Manager is older than threshold set for warning level

boolean
isErrorThresholdExceeded
Optional

True if age of vSAN HCL data on SDDC Manager is older than threshold set for error level

string
localDataTime
Optional

Last update time of vSAN HCL data in SDDC Manager


404

vSAN HCL attributes not found

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


500

InternalServerError

Returns Error of type(s) application/json
"Error Object"
string
errorCode
Optional

The minor error code

string
errorType
Optional

The error type

array of string
arguments
Optional

The arguments used to localize the message, Can be used by scripts to automate the error processing.

object
context
Optional

The error context (e.g. the component where it occurred).

string
message
Optional

The localized error message

string
remediationMessage
Optional

The localized remediation error message

array of object
causes
Optional

The underlying cause exceptions.

array of Error
nestedErrors
Optional

The nested errors when the error is a composite one

string
referenceToken
Optional

A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/v1/vsan-hcl/attributes