Colocation Physical Link¶

This page describes operations you can perform on Colocation Physical Links. List, and get details for.

List Colocation Physical Link¶

List all visible Colocation Physical Links.

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

GET

HTTP Request Path¶

{endpoint}/v2.0/colocation_physical_links

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
bandwidth	query	string	-	[‘1g’, ‘10g’]	The bandwidth of Colocation Physical Link physical link	no
colocation_space_id	query	string	hyph-uuid	-	Colocation Space ID	no
description	query	string	-	-	Colocation Physical Link description	no
id	query	string	hyph-uuid	-	Colocation Physical Link unique id	no
name	query	string	-	-	Colocation Physical Link name	no
plane	query	string	-	[‘data’, ‘storage’]	Connection type (data or storage)	no
status	query	string	-	-	The Colocation Physical Link status	no
tenant_id	query	string	non-hyph-uuid	-	The owner name of Colocation Physical Link	no
type_a_physical_port_id	query	string	hyph-uuid	-	Type A Physical Port ID	no
type_a_rack_id	query	string	-	-	Type A Rack ID	no
type_b_physical_port_id	query	string	hyph-uuid	-	Type B Physical Port ID	no
type_b_rack_id	query	string	-	-	Type B Rack ID	no

Response¶

HTTP Response Code List¶

Response Code	Description
200	OK
400	Bad Request
401	UnAuthorized
404	Not Found
500	Internal Server Error

HTTP Response Parameters¶

Parameter	Type	Format	Description
colocation_physical_links	array<object>	Colocation Physical Link	-
bandwidth	string	-	The bandwidth of Colocation Physical Link physical link
colocation_space_id	string	hyph-uuid	Colocation Space ID
description	string	-	Colocation Physical Link description
id	string	hyph-uuid	Colocation Physical Link unique id
name	string	-	Colocation Physical Link name
plane	string	-	Connection type (data or storage)
segmentation_ranges	array<object>	-	Ranges of allowed VLAN tags
end	integer	-	-
start	integer	-	-
status	string	-	The Colocation Physical Link status
tags	object	-	Port tags
tenant_id	string	non-hyph-uuid	The owner name of Colocation Physical Link
type_a_physical_port_id	string	hyph-uuid	Type A Physical Port ID
type_a_rack_id	string	-	Type A Rack ID
type_b_physical_port_id	string	hyph-uuid	Type B Physical Port ID
type_b_rack_id	string	-	Type B Rack ID

Examples¶

Sample Request Body¶

This operation does not send a request body.

Sample Response Body¶

{
  "colocation_physical_links": [
    {
      "bandwidth": "10g",
      "colocation_space_id": "b33afaf9-f371-4f34-909c-b8822e3b87e1",
      "description": "Lab1 TEST",
      "id": "4b703f08-ed57-4455-8438-296ffcdff4c7",
      "name": "Lab1 colocation physical link for 10G TEST",
      "plane": "data",
      "segmentation_ranges": [
        {
          "end": 2048,
          "start": 3
        },
        {
          "end": 4093,
          "start": 2050
        }
      ],
      "status": "ACTIVE",
      "tags": {
        "keyword1": "value1",
        "keyword2": "value2"
      },
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
      "type_a_physical_port_id": "42c9e882-14fc-404b-a0fe-a72b8d7fee0e",
      "type_a_rack_id": "string formant",
      "type_b_physical_port_id": "46bb1b07-69ff-4442-8ee5-a5b7c8da1de5",
      "type_b_rack_id": "string formant"
    },
    {
      "bandwidth": "1g",
      "colocation_space_id": "b33afaf9-f371-4f34-909c-b8822e3b87e1",
      "description": "Lab1 TEST",
      "id": "b281ee4c-176d-4c77-8480-3ec7a78786b8",
      "name": "Lab1 colocation physical link for 1G TEST",
      "plane": "data",
      "segmentation_ranges": [
        {
          "end": 2048,
          "start": 3
        },
        {
          "end": 4093,
          "start": 2050
        }
      ],
      "status": "ACTIVE",
      "tags": {
        "keyword1": "value1",
        "keyword2": "value2"
      },
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
      "type_a_physical_port_id": "6076fbc7-eabc-45a9-9146-81bc645a9b07",
      "type_a_rack_id": "string formant",
      "type_b_physical_port_id": "ea237109-9acb-4560-8884-2ed1f4fbd56b",
      "type_b_rack_id": "string formant"
    }
  ]
}

Show Colocation Physical Link¶

Show details for Colocation Physical Link.