Get Database

api_key

Response

Response Body

200 OK returns HealthDatabaseInfo of type application/json

Health status of the database

{
	"messages": [
		{
			"message": {
				"args": [
					"string"
				],
				"default_message": "string",
				"id": "string",
				"localized": "string",
				"params": {
					"key": {
						"d": 0,
						"dt": "string",
						"format": "SHORT_DATE",
						"i": 0,
						"l": {
							"id": "string",
							"params": "StdLocalizationParam Object"
						},
						"precision": 0,
						"s": "string"
					}
				}
			},
			"severity": "ERROR"
		}
	],
	"status": "UNHEALTHY"
}

array of HealthDatabaseMessage

messages Required

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

HealthDatabaseInfoStatus

status Required

The Database.Info.Status enumerated type describes the health of the database.
UNHEALTHY : The database is corrupted and vCenter server functionality will be impacted.
DEGRADED : The database has issues but the impact on vCenter Server is low.
HEALTHY : The database is healthy.

Possible values are: UNHEALTHY , DEGRADED , HEALTHY

Errors

Error

500

com.vmware.vapi.std.errors.error : if issue in retrieving health of the database

Error

default

‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.

Code Samples

PowerCLI Client SDK Example

Invoke-GetHealthDatabase

cURL Command

curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/appliance/health/database

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:

x-vmw-doc-operation: get

Availability

Added in 7.0.0.1

Get Database

On This Page

Request

URL

Header Parameters

vmware-api-session-id example

Authentication