This API has a deprecated equivalent from v7.0U1.
Get Registries Harbor
Get detailed information of the Harbor registry.
Request
URLURL
https://{api_host}/api/vcenter/content/registries/harbor/{registry}
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
ContentRegistriesHarborInfo
of type application/json
Information about the registry.
{
"cert_chain": [
"string"
],
"cluster": "string",
"creation_time": "string",
"garbage_collection": {
"day_of_week": "SUNDAY",
"hour": 0,
"minute": 0,
"type": "NONE"
},
"health": {
"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"
},
"namespace": "string",
"storage": [
{
"capacity": 0,
"policy": "string",
"used": 0
}
],
"ui_access_url": "string",
"version": "string"
}
array of
string
cert_chain
Required
Harbor certificate chain in base64 format.
string
ui_access_url
Required
URL to access the UI of the registry.
string
creation_time
Required
The date and time when the harbor registry was created.
garbage_collection
Required
Garbage collection information for the registry.
array of
ContentRegistriesHarborStorageInfo
storage
Required
Storage information associated with the registry.
string
version
Required
Version of the registry.
string
namespace
Optional
Identifier of the Harbor namespace in case it is created in a Kubernetes environment. 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.
string
cluster
Optional
Identifier of the cluster. If unset, container registry is not created on the cluster specified by Harbor.CreateSpec.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.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege.
404
com.vmware.vapi.std.errors.not_found : if a Harbor registry specified by registry could not be found.
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-GetRegistryRegistriesHarbor -Registry "MyRegistry"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/content/registries/harbor/{registry}
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/harbor/{registry}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
On This Page
Registries Harbor Operations
delete
