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

vcenter content registries harbor projects: get

Returns detailed information about the specified Harbor project.

Request:

HTTP request

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

Path Parameters

Name Type Description
Required
registry string Identifier of the registry.
project string Identifier of the Harbor project.

Response:

HTTP Status Code: 200

Representation:

{
    "value" : {
        "creation_time" : "2015-01-01T22:13:05.651Z",
        "update_time" : "2015-01-01T22:13:05.651Z",
        "scope" : "PUBLIC",
        "access_url" : "http://myurl.com",
        "name" : "string",
        "message" : {
            "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"
                }
            ]
        },
        "config_status" : "PENDING"
    }
}

Response Type:

Name Type Description
bold = required
value info Detailed information about the specified Harbor project.
value.name string 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.
value.config_status string The status of the Harbor project.

Describes the status of reaching the desired configuration state for the Harbor project. Value is one of:
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.
value.scope string The access type of a Harbor project.

In a project defines access levels of the project. Value is one of:
PUBLIC: A Harbor project can be accessed by everyone.
PRIVATE: A Harbor project can only be accessed by assigned users.
value.creation_time date_time The date and time when the harbor project creation API was triggered and project identifier generated.
value.update_time date_time The date and time when the harbor project purge API was triggered. In case no purge was triggered, update_time is same as creation_time.

Optional. It is only relevant when config_status has value [READY]. This field is optional and it is only relevant when the value of config_status is READY.
value.access_url URI URL to access the harbor project through docker client.

Optional. It is only relevant when config_status has value [READY]. This field is optional and it is only relevant when the value of config_status is READY.
value.message localizable_message Details about the ERROR project status.

Optional. It is only relevant when config_status has value [ERROR]. This field is optional and it is only relevant when the value of config_status is ERROR.
value.message.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.message.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.message.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.message.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.message.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 registry or project cannot 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.