Appliance Health Database get

Appliance Health Database get

Returns the health status of the database.

This operation was added in vSphere API 7.0.0.1.

Request
URI
GET
https://{api_host}/api/appliance/health/database
COPY
Authentication
This operation uses the following authentication methods.
Responses
200

Health status of the database

Returns Appliance Health Database Info of type(s) application/json 
{
    "status": "string",
    "messages": [
        {
            "severity": "string",
            "message": {
                "id": "string",
                "default_message": "string",
                "args": [
                    "string"
                ],
                "params": {
                    "params": {
                        "s": "string",
                        "dt": "string",
                        "i": 0,
                        "d": "number",
                        "l": "Vapi Std NestedLocalizableMessage Object",
                        "format": "string",
                        "precision": 0
                    }
                },
                "localized": "string"
            }
        }
    ]
}
string
status
Required

Database health status

For more information see: Appliance Health Database Info Status.

This property was added in vSphere API 7.0.0.1.

array of object
messages
Required

Messages describing any issues with the database, along with their severity.

This property was added in vSphere API 7.0.0.1.


500

if issue in retrieving health of the database

Returns Vapi Std Errors Error of type(s) application/json 
"Vapi Std Errors Error Object"
array of object
messages
Required

Stack of one or more localizable messages for human error consumers.

The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.

Each subsequent message in the stack describes the "cause" of the prior message.

object
data
Optional

Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.

Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.

The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.

Some operations will not set this property when reporting errors.

string
error_type
Required

Discriminator field to help API consumers identify the structure type.

For more information see: Vapi Std Errors Error Type.

This property was added in vSphere API 6.7.2.

Can be missing or null for compatibility with preceding implementations.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/appliance/health/database
On This Page
Appliance Operations
GET
Appliance Health Database get