This API has a deprecated equivalent from v7.0U1.
Get Registries Health
Returns the health information of a container registry in the vCenter.
Request
URLURL
https://{api_host}/api/vcenter/content/registries/{registry}/health
Path Parameters
Path Parameters
string
registry
Required
Identifier of the registry. The parameter must be an identifier for the resource type: com.vmware.vcenter.content.Registry.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
ContentRegistriesHealthInfo
of type application/json
Health information of the registry.
{
"details": {
"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"
}
}
},
"status": "STARTING"
}
status
Required
The Health.Status enumerated type describes the status of the container registry.
STARTING : Container registry is starting.
RUNNING : Container registry is running.
WARNING : Container registry is running with some warning, for example, storage reaches the threshold configuration.
ERROR : Container registry failed to start or stopped with fatal error.
DELETING : Container registry is being deleted.
Possible values are: STARTING , RUNNING , WARNING , ERROR , DELETING
details
Optional
Details about the status. If unset, message details are not required for taking actions.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user is not a member of the Administrators
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request.
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-GetRegistryRegistriesHealth -Registry "MyRegistry"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/content/registries/{registry}/health
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: get
x-vmw-doc-deprecated-path: /rest/vcenter/content/registries/{registry}/health
x-vmw-doc-operation: get
Availability
Added in 7.0U2
