This API has a deprecated equivalent from v7.0U1.
Get Registries Harbor Projects
Returns detailed information about the specified Harbor project.
Request
URLURL
https://{api_host}/api/vcenter/content/registries/harbor/{registry}/projects/{project}
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.
string
project
Required
Identifier of the Harbor project. The parameter must be an identifier for the resource type: com.vmware.vcenter.content.Registry.Harbor.Project.
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
ContentRegistriesHarborProjectsInfo
of type application/json
Detailed information about the specified Harbor project.
{
"access_url": "string",
"config_status": "PENDING",
"creation_time": "string",
"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"
}
}
},
"name": "string",
"scope": "PUBLIC",
"update_time": "string"
}
config_status
Required
The Projects.ConfigStatus enumerated type describes the status of reaching the desired configuration state for the Harbor project.
PENDING : Harbor project is being created or the configuration is being applied to the project.
REMOVING : The configuration is being removed and Harbor project is being deleted.
ERROR : Failed to create Harbor project or apply the configuration to the project, user intervention needed.
READY : Harbor project is created or configured correctly.
Possible values are: PENDING , REMOVING , ERROR , READY
string
creation_time
Required
The date and time when the harbor project creation API was triggered and project identifier generated.
string
name
Required
Name of the Harbor project. Should be between 1-63 characters long alphanumeric string and may contain the following characters: a-z,0-9, and ‘-’. Must be starting with characters or numbers, with the ‘-’ character allowed anywhere except the first or last character.
scope
Required
The Projects.Scope enumerated type in a project defines access levels of the project.
PUBLIC : A Harbor project can be accessed by everyone.
PRIVATE : A Harbor project can only be accessed by assigned users.
Possible values are: PUBLIC , PRIVATE
string
access_url
Optional
URL to access the harbor project through docker client. This field is optional and it is only relevant when the value of Projects.Info.config-status is READY.
message
Optional
Details about the ERROR project status. This field is optional and it is only relevant when the value of Projects.Info.config-status is ERROR.
string
update_time
Optional
The date and time when the harbor project purge API was triggered. In case no purge was triggered, Projects.Info.update-time is same as Projects.Info.creation-time. This field is optional and it is only relevant when the value of Projects.Info.config-status is READY.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user does not have System.Read privilege.
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-GetRegistryProjectHarbor -Registry "MyRegistry" -Project "MyProject"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/content/registries/harbor/{registry}/projects/{project}
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}/projects/{project}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
