REST API - list

vcenter hvc links: list

Enumerates the list of registered hybrid links. Usage beyond VMware Cloud on AWS is not supported. Warning: This operation is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Request:

HTTP request

GET https://{server}/rest/hvc/links
No request parameters

Response:

HTTP Status Code: 200

Representation:

{
    "value"[
        {
            "link""obj-103",
            "display_name""string"
        },
        {
            "link""obj-103",
            "display_name""string"
        }
    ]
}

Response Type:

Name Type Description
bold = required
value summary[] The array of hybrid link information.
value[].link string Unique identifier for the link. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: com.vmware.vcenter.hvc.Links. When operations return a value of this structure as a result, the field will be an identifier for the resource type: com.vmware.vcenter.hvc.Links.

value[].display_name string The display name is set to the domain name which was set during create. Warning: This attribute is available as Technology Preview. These are early access APIs provided to test, automate and provide feedback on the feature. Since this can change based on feedback, VMware does not guarantee backwards compatibility and recommends against using them in production environments. Some Technology Preview APIs might only be applicable to specific environments.

Errors:

HTTP Status Code Type Description
500 error if the system reports an error while responding to the request.