REST API - get
  1. Operations
  2. vcenter
  3. content
  4. registries
  5. health

vcenter content registries health: get

Returns the health information of a container registry in the vCenter.

Request:

HTTP request

GET https://{server}/rest/vcenter/content/registries/{registry}/health

Path Parameters

Name Type Description
Required
registry string Identifier of the registry.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "details" : {
            "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" : "STARTING"
    }
}

Response Type:

Name Type Description
bold = required
value info Health information of the registry.
value.status string Container registry status.

Describes the status of the container registry. Value is one of:
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.
value.details localizable_message Details about the status.

Optional. It is only relevant when status has value [WARNING, ERROR]. If unset, message details are not required for taking actions.
value.details.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.details.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.details.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.
value.details.params list Named arguments to be substituted into the message template. This attribute was added in vSphere API 7.0.0.0.

Optional. Unset means that the message template requires no arguments or positional arguments are used.
value.details.localized string Localized string value as per request requirements. This attribute was added in vSphere API 7.0.0.0.

Optional. when the client has not requested specific locale the implementation may not populate this field to conserve resources.

Errors:

HTTP Status Code Type Description
500 error if the system reports an error while responding to the request.
404 not_found if the registry does not exist.
401 unauthenticated if the user can not be authenticated.
403 unauthorized if the user is not a member of the Administrators