appliance health database: get
Returns the health status of the database. Warning: This operation is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented.
Request:
HTTP request
GET https://{server}/rest/appliance/health/database
No request parameters
Response:
HTTP Status Code: 200
Representation:
{
"value" : {
"messages" : [
{
"severity" : "ERROR",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
{
"severity" : "ERROR",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
}
],
"status" : "UNHEALTHY"
}
}
"value" : {
"messages" : [
{
"severity" : "ERROR",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
{
"severity" : "ERROR",
"message" : {
"args" : [
"string",
"string"
],
"default_message" : "string",
"localized" : "string",
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"value" : {
"dt" : "2015-01-01T22:13:05.651Z",
"s" : "string",
"d" : 1.5,
"precision" : 1,
"format" : "SHORT_DATE",
"i" : 1,
"l" : {
"id" : "string",
"params" : [
{
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
},
"key" : "string"
}
]
}
}
],
"status" : "UNHEALTHY"
}
}
Response Type:
| Name | Type | Description |
|---|---|---|
| bold = required | ||
| value | info | Health status of the database. |
| value.status | string | Database health status. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Describes the health of the database. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of: UNHEALTHY: The database is corrupted and vCenter server functionality will be impacted. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. DEGRADED: The database has issues but the impact on vCenter Server is low. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. HEALTHY: The database is healthy. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| value.messages | message[] | Messages describing any issues with the database, along with their severity. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| value.messages[].severity | string | Severity of the message. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Defines the levels of severity for a message. Warning: This enumeration is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. Value is one of: ERROR: Error message. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. WARNING: Warning message. Warning: This constant is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| value.messages[].message | localizable_message | Message describing the issue with the database. Warning: This attribute is part of a new feature in development. It may be changed at any time and may not have all supported functionality implemented. |
| value.messages[].message.id | string | Unique identifier of the localizable string or message template. This identifier is typically used to retrieve a locale-specific string or message template from a message catalog. |
| value.messages[].message.default_message | string | The value of this localizable string or message template in the en_US (English) locale. If vapi.std.localizable_message.id refers to a message template, the default message will contain the substituted arguments. This value can be used by clients that do not need to display strings and messages in the native language of the user. It could also be used as a fallback if a client is unable to access the appropriate message catalog. |
| value.messages[].message.args | string[] | Positional arguments to be substituted into the message template. This list will be empty if the message uses named arguments or has no arguments. |
Errors:
| HTTP Status Code | Type | Description |
|---|---|---|
| 500 | error | if issue in retrieving health of the database |