This API has a deprecated equivalent from v7.0U1.
Get Links
Gets information for a link. Usage beyond VMware Cloud on AWS is not supported.
Request
URLURL
https://{api_host}/api/hvc/links/{link}
Path Parameters
Path Parameters
string
link
Required
Unique identifier of the link. The parameter must be an identifier for the resource type: com.vmware.vcenter.hvc.Links.
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
HvcLinksInfo
of type application/json
Information about the link.
{
"connection_health_status": "HEALTHY",
"health_status_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"
}
}
}
}
connection_health_status
Optional
The Links.Info.HealthStatus enumerated type defines the possible states for health of a link.
HEALTHY : Connection is healthy
UNHEALTHY : Connection issues will need to be remediated
Possible values are: HEALTHY , UNHEALTHY
health_status_message
Optional
Localizable messages associated with health status This field is optional and it is only relevant when the value of Links.Info.connection-health-status is UNHEALTHY.
Errors
403
com.vmware.vapi.std.errors.unauthorized : if the user is not authorized to perform this operation.
404
com.vmware.vapi.std.errors.not_found : if the hybrid link associated with link does not exist.
500
com.vmware.vapi.std.errors.error : if the system reports an error while responding to the request. | com.vmware.vapi.std.errors.resource_busy : if the service is busy.
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-GetLinkHvc -Link "MyLink"
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/hvc/links/{link}
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/hvc/links/{link}
x-vmw-doc-operation: get
Availability
Added in 7.0U2
On This Page
Links Operations
get
post
get
delete
