Network Edge APIs | Equinix Product Documentation

Get Device Link By Uuid

Request

This API will return a device link by its unique Id. Authorization checks are performed on the users of this API.

Security

BearerAuth

Path

uuidstringrequired

Unique Id of a device link group.

Example:6ea5a0e4-2bf7-45c2-9aa7-e846a8cd5567

Payload

// No request payload

Responses

Bodyapplication/json

uuidstring

Unique Id of the linked group.

Example:"6ea5a0e4-2bf7-45c2-9aa7-e846a8cd5567"

groupNamestring

The name of the linked group

Example:"my-new-link"

subnetstring

Subnet of the link group.

Example:"10.0.0.0/27"

redundancyTypestring

Whether the connection is through Fabric's primary or secondary port.

Enum:"PRIMARY""SECONDARY"

Example:"SECONDARY"

statusstring

Status of the linked group

Enum:"PROVISIONED""PROVISIONING""DEPROVISIONED""DEPROVISIONING""FAILED"

Example:"PROVISIONING"

createdBystring

Created by username.

Example:"nfv-sit1"

createdDateTimestring, (date-time)

Created date.

Example:"2019-09-15T10:30:31Z"

lastUpdatedBystring

Last updated by user

Example:"reg2-acc1"

lastUpdatedDateTimestring, (date-time)

Last updated date

Example:"2019-09-16T10:30:31Z"

metroLinksArray of objects(LinkInfoResponse)

An array of links between metros.

linkDevicesArray of objects(LinkDeviceResponse)

An array of metros and the devices in the metros belonging to the group.

Example:

[
  {
    "deviceUuid": "4cfb5675-5c3f-4275-adba-0c9e3c26c96b",
    "deviceName": "Cisco Router1",
    "metroCode": "DA",
    "metroName": "Dallas",
    "deviceTypeCode": "C8000V",
    "category": "ROUTER",
    "ipAssigned": "10.0.0.0/27",
    "interfaceId": 5,
    "status": "PROVISIONING",
    "deviceManagementType": "SELF-CONFIGURED",
    "networkScope": "TENANT",
    "isDeviceAccessible": true
  },
  {
    "deviceUuid": "5cfb5675-5c3f-4275-adba-0c9e3c26c96c",
    "deviceName": "Cisco Router2",
    "metroCode": "DA",
    "metroName": "Dallas",
    "deviceTypeCode": "C8000V",
    "category": "ROUTER",
    "ipAssigned": "10.0.0.0/27",
    "interfaceId": 5,
    "status": "PROVISIONING",
    "deviceManagementType": "SELF-CONFIGURED",
    "networkScope": "TENANT",
    "isDeviceAccessible": true
  }
]

Response

{
  "uuid": "6ea5a0e4-2bf7-45c2-9aa7-e846a8cd5567",
  "groupName": "my-new-link",
  "subnet": "10.0.0.0/27",
  "redundancyType": "SECONDARY",
  "status": "PROVISIONING",
  "createdBy": "nfv-sit1",
  "createdDateTime": "2019-09-15T10:30:31Z",
  "lastUpdatedBy": "reg2-acc1",
  "lastUpdatedDateTime": "2019-09-16T10:30:31Z",
  "metroLinks": [
    { … }
  ],
  "linkDevices": [
    { … },
    { … }
  ]
}