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

vcenter content registries harbor: get

Get detailed information of the Harbor registry.

Request:

HTTP request

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

Path Parameters

Name Type Description
Required
registry string Identifier of the registry.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "creation_time" : "2015-01-01T22:13:05.651Z",
        "cluster" : "obj-103",
        "garbage_collection" : {
            "hour" : 1,
            "type" : "NONE",
            "day_of_week" : "SUNDAY",
            "minute" : 1
        },
        "namespace" : "obj-103",
        "cert_chain" : [
            "string",
            "string"
        ],
        "health" : {
            "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"
        },
        "storage" : [
            {
                "used" : 1,
                "policy" : "obj-103",
                "capacity" : 1
            },
            {
                "used" : 1,
                "policy" : "obj-103",
                "capacity" : 1
            }
        ],
        "version" : "string",
        "ui_access_url" : "http://myurl.com"
    }
}

Response Type:

Name Type Description
bold = required
value info Information about the registry.
value.cluster string Identifier of the cluster.

Optional. If unset, container registry is not created on the cluster specified by vcenter.content.registries.harbor.create_spec.cluster.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will be an identifier for the resource type: ClusterComputeResource.
value.namespace string Identifier of the Harbor namespace in case it is created in a Kubernetes environment.

Optional. If unset, no Kubernetes namespace is created for the Harbor.When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: NamespaceInstance. When operations return a value of this structure as a result, the field will be an identifier for the resource type: NamespaceInstance.
value.version string Version of the registry.
value.creation_time date_time The date and time when the harbor registry was created.
value.ui_access_url URI URL to access the UI of the registry.
value.cert_chain string[] Harbor certificate chain in base64 format.
value.garbage_collection garbage_collection Garbage collection information for the registry.
value.garbage_collection.type string Frequency of garbage collection.

Defines the supported values for how often to run a specific operation for a container registry. Value is one of:
NONE: No operation is scheduled.
DAILY: An operation occurs on a daily basis.
WEEKLY: An operation occurs on a weekly basis.
value.garbage_collection.day_of_week string Day of the week when garbage collection should run.

Describes the supported days of the week to run a specific operation for a container registry. Value is one of:
SUNDAY: Sunday.
MONDAY: Monday.
TUESDAY: Tuesday.
WEDNESDAY: Wednesday.
THURSDAY: Thursday.
FRIDAY: Friday.
SATURDAY: Saturday.Optional. It is only relevant when type has value [WEEKLY]. This field is optional and it is only relevant when the value of type is WEEKLY.
value.garbage_collection.hour long Hour at which garbage collection should run.

Optional. It is only relevant when type has value [DAILY, WEEKLY]. This field is optional and it is only relevant when the value of type is one of DAILY or WEEKLY.
value.garbage_collection.minute long Minute at which garbage collection should run.

Optional. It is only relevant when type has value [DAILY, WEEKLY]. This field is optional and it is only relevant when the value of type is one of DAILY or WEEKLY.
value.storage storage_info[] Storage information associated with the registry.
value.health info Health status of the container registry.
value.health.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.health.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.health.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.health.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.health.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.health.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.health.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
404 not_found if a Harbor registry specified by registry could not be found.
500 error if the system reports an error while responding to the request.
401 unauthenticated if the user can not be authenticated.
403 unauthorized if the user does not have System.Read privilege.