Vcenter Hvc Links get
Gets information for a link. Usage beyond VMware Cloud on AWS is not supported.
This operation was added in vSphere API 8.0.1.0.
Returns an authorization error if you do not have all of the privileges described as follows:
- Operation execution requires
System.Read.
Unique identifier of the link.
The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.
Information about the link.
{
"connection_health_status": "string",
"health_status_message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
}Health status of the connection
For more information see: Vcenter Hvc Links Info HealthStatus.
This property was added in vSphere API 8.0.1.0.
Localizable messages associated with health status
This property was added in vSphere API 8.0.1.0.
This property is optional and it is only relevant when the value of connection_health_status is Vcenter Hvc Links Info HealthStatus.UNHEALTHY.
if the user is not authorized to perform this operation.
"Vapi Std Errors Unauthorized Object"if the hybrid link associated with link does not exist.
"Vapi Std Errors NotFound Object"Vapi Std Errors Error if the system reports an error while responding to the request.
Vapi Std Errors ResourceBusy if the service is busy.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
curl -H 'Authorization: <value>' https://{api_host}/api/hvc/links/{link}