1.3. Colocation Logical Link¶

This page describes operations you can perform on Colocation Logical Links. List, create, get details for, update, and delete.

List Colocation Logical Link¶

List all visible Colocation Logical Links.

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

{endpoint}/v2.0/colocation_logical_links

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
colocation_physical_link_id	query	string	hyph-uuid	-	Colocation Physical Link ID	no
description	query	string	-	-	Colocation Logical Link description	no
id	query	string	hyph-uuid	-	Colocation Logical Link unique id	no
name	query	string	-	-	Colocation Logical Link name	no
network_id	query	string	hyph-uuid	-	Colocation ID	no
status	query	string	-	-	The Colocation Logical Link status	no
tenant_id	query	string	non-hyph-uuid	-	The owner name of Colocation Logical Link	no
type_a_port_id	query	string	hyph-uuid	-	Type A Port ID	no
type_b_port_id	query	string	hyph-uuid	-	Type B Port ID	no
vlan_id	query	integer	-	-	Logical port vlan 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_logical_links	array<object>	datatype_colocation_logical_link	-
colocation_physical_link_id	string	hyph-uuid	Colocation Physical Link ID
description	string	-	Colocation Logical Link description
id	string	hyph-uuid	Colocation Logical Link unique id
name	string	-	Colocation Logical Link name
network_id	string	hyph-uuid	Colocation ID
status	string	-	The Colocation Logical Link status
tags	object	-	Port tags
tenant_id	string	non-hyph-uuid	The owner name of Colocation Logical Link
type_a_port_id	string	hyph-uuid	Type A Port ID
type_b_port_id	string	hyph-uuid	Type B Port ID
vlan_id	integer	-	Logical port vlan id

Examples¶

Sample Request Body¶

This operation does not send a request body.

Sample Response Body¶

{
  "colocation_logical_links": [
    {
      "colocation_physical_link_id": "4b703f08-ed57-4455-8438-296ffcdff4c7",
      "description": "Lab1 TEST",
      "id": "9ba631dc-cb35-4294-b407-3837683060a2",
      "name": "Lab1 clocation logical link for 10G TEST",
      "network_id": "3f605a7f-9766-4e0a-91df-a3bc0b7a7c9a",
      "status": "ACTIVE",
      "tags": {
        "keyword1": "value1",
        "keyword2": "value2"
      },
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
      "type_a_port_id": "9b795865-e73c-4f09-aac8-cb81e41d9fac",
      "type_b_port_id": "9b795865-e73c-4f09-aac8-cb81e41d9fac",
      "vlan_id": 123
    },
    {
      "colocation_physical_link_id": "b281ee4c-176d-4c77-8480-3ec7a78786b81",
      "description": "Lab1 TEST",
      "id": "ae26baf9-13e2-439c-9c30-052926683fff",
      "name": "Lab1 clocation logical link fo 1G TEST",
      "network_id": "6da7d10c-579a-4155-a277-411395fcf8b3",
      "status": "ACTIVE",
      "tags": {
        "keyword1": "value1",
        "keyword2": "value2"
      },
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
      "type_a_port_id": "78723337-e7b8-4ef9-8ba4-46271911db9c",
      "type_b_port_id": "78723337-e7b8-4ef9-8ba4-46271911db9c",
      "vlan_id": 234
    }
  ]
}

Create Colocation Logical Link¶

Create Colocation Logical Link.

Synchronous / Asynchronous¶

Asynchronous

Request¶

HTTP Request Method¶

POST

HTTP Request Path¶

{endpoint}/v2.0/colocation_logical_links

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Default	Description	Required
colocation_logical_link	plain	object	datatype_colocation_logical_link	-	-	-	yes
colocation_physical_link_id	plain	string	hyph-uuid	-	-	Colocation Physical Link ID	yes
description	plain	string	-	-	""	Colocation Logical Link description	no
name	plain	string	-	-	""	Colocation Logical Link name	no
network_id	plain	string	hyph-uuid	-	-	Colocation ID	yes
tags	plain	object	-	-	{}	Port tags	no
tenant_id	plain	string	non-hyph-uuid	-	See notes.	The owner name of Colocation Logical Link	no
vlan_id	plain	integer	-	-	-	Logical port vlan id	yes

注釈

tenant_id: The ID of default tenant to which user belongs.

Response¶

HTTP Response Code List¶

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

HTTP Response Parameters¶

Parameter	Type	Format	Description
colocation_logical_link	object	datatype_colocation_logical_link	-
colocation_physical_link_id	string	hyph-uuid	Colocation Physical Link ID
description	string	-	Colocation Logical Link description
id	string	hyph-uuid	Colocation Logical Link unique id
name	string	-	Colocation Logical Link name
network_id	string	hyph-uuid	Colocation ID
status	string	-	The Colocation Logical Link status
tags	object	-	Port tags
tenant_id	string	non-hyph-uuid	The owner name of Colocation Logical Link
type_a_port_id	string	hyph-uuid	Type A Port ID
type_b_port_id	string	hyph-uuid	Type B Port ID
vlan_id	integer	-	Logical port vlan id

Examples¶

Sample Request Body¶

{
  "colocation_logical_link": {
    "colocation_physical_link_id": "4b703f08-ed57-4455-8438-296ffcdff4c7",
    "description": "Lab1 TEST",
    "name": "Lab1 clocation logical link for 10G TEST",
    "network_id": "3f605a7f-9766-4e0a-91df-a3bc0b7a7c9a",
    "tags": {
      "keyword1": "value1",
      "keyword2": "value2"
    },
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "vlan_id": 123
  }
}

Sample Response Body¶

{
  "colocation_logical_link": {
    "colocation_physical_link_id": "4b703f08-ed57-4455-8438-296ffcdff4c7",
    "description": "Lab1 TEST",
    "id": "9ba631dc-cb35-4294-b407-3837683060a2",
    "name": "Lab1 clocation logical link for 10G TEST",
    "network_id": "3f605a7f-9766-4e0a-91df-a3bc0b7a7c9a",
    "status": "PENDING_CREATE",
    "tags": {
      "keyword1": "value1",
      "keyword2": "value2"
    },
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "type_a_port_id": "9b795865-e73c-4f09-aac8-cb81e41d9fac",
    "type_b_port_id": "9b795865-e73c-4f09-aac8-cb81e41d9fac",
    "vlan_id": 123
  }
}

Show Colocation Logical Link¶

Show details for Colocation Logical Link.

Synchronous / Asynchronous¶

Synchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

{endpoint}/v2.0/colocation_logical_links/{colocation_logical_link_id}

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
colocation_logical_link_id	URI	string	hyph-uuid	-	Colocation Logical Link unique id	yes

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_logical_link	object	datatype_colocation_logical_link	-
colocation_physical_link_id	string	hyph-uuid	Colocation Physical Link ID
description	string	-	Colocation Logical Link description
id	string	hyph-uuid	Colocation Logical Link unique id
name	string	-	Colocation Logical Link name
network_id	string	hyph-uuid	Colocation ID
status	string	-	The Colocation Logical Link status
tags	object	-	Port tags
tenant_id	string	non-hyph-uuid	The owner name of Colocation Logical Link
type_a_port_id	string	hyph-uuid	Type A Port ID
type_b_port_id	string	hyph-uuid	Type B Port ID
vlan_id	integer	-	Logical port vlan id

Examples¶

Sample Request Body¶

This operation does not send a request body.

Sample Response Body¶

{
  "colocation_logical_link": {
    "colocation_physical_link_id": "4b703f08-ed57-4455-8438-296ffcdff4c7",
    "description": "Lab1 TEST",
    "id": "9ba631dc-cb35-4294-b407-3837683060a2",
    "name": "Lab1 clocation logical link for 10G TEST",
    "network_id": "3f605a7f-9766-4e0a-91df-a3bc0b7a7c9a",
    "status": "ACTIVE",
    "tags": {
      "keyword1": "value1",
      "keyword2": "value2"
    },
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "type_a_port_id": "9b795865-e73c-4f09-aac8-cb81e41d9fac",
    "type_b_port_id": "9b795865-e73c-4f09-aac8-cb81e41d9fac",
    "vlan_id": 123
  }
}

Update Colocation Logical Link¶

Update Colocation Logical Link.

Synchronous / Asynchronous¶

Asynchronous

Request¶

HTTP Request Method¶

HTTP Request Path¶

{endpoint}/v2.0/colocation_logical_links/{colocation_logical_link_id}

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
colocation_logical_link_id	URI	string	hyph-uuid	-	Colocation Logical Link unique id	yes
colocation_logical_link	plain	object	datatype_colocation_logical_link	-	-	yes
description	plain	string	-	-	Colocation Logical Link description	no
name	plain	string	-	-	Colocation Logical Link name	no
tags	plain	object	-	-	Port tags	no

Response¶

HTTP Response Code List¶

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

HTTP Response Parameters¶

Parameter	Type	Format	Description
colocation_logical_link	object	datatype_colocation_logical_link	-
colocation_physical_link_id	string	hyph-uuid	Colocation Physical Link ID
description	string	-	Colocation Logical Link description
id	string	hyph-uuid	Colocation Logical Link unique id
name	string	-	Colocation Logical Link name
network_id	string	hyph-uuid	Colocation ID
status	string	-	The Colocation Logical Link status
tags	object	-	Port tags
tenant_id	string	non-hyph-uuid	The owner name of Colocation Logical Link
type_a_port_id	string	hyph-uuid	Type A Port ID
type_b_port_id	string	hyph-uuid	Type B Port ID
vlan_id	integer	-	Logical port vlan id

Examples¶

Sample Request Body¶

{
  "colocation_logical_link": {
    "description": "Lab1 TEST",
    "name": "Lab1 clocation logical link for 10G TEST",
    "tags": {
      "keyword1": "value1",
      "keyword2": "value2"
    }
  }
}

Sample Response Body¶

{
  "colocation_logical_link": {
    "colocation_physical_link_id": "4b703f08-ed57-4455-8438-296ffcdff4c7",
    "description": "Lab1 TEST",
    "id": "9ba631dc-cb35-4294-b407-3837683060a2",
    "name": "Lab1 clocation logical link for 10G TEST",
    "network_id": "3f605a7f-9766-4e0a-91df-a3bc0b7a7c9a",
    "status": "PENDING_UPDATE",
    "tags": {
      "keyword1": "value1",
      "keyword2": "value2"
    },
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "type_a_port_id": "9b795865-e73c-4f09-aac8-cb81e41d9fac",
    "type_b_port_id": "9b795865-e73c-4f09-aac8-cb81e41d9fac",
    "vlan_id": 123
  }
}

Delete Colocation Logical Link¶

Delete Colocation Logical Link.

Synchronous / Asynchronous¶

Asynchronous

Request¶

HTTP Request Method¶

DELETE

HTTP Request Path¶

{endpoint}/v2.0/colocation_logical_links/{colocation_logical_link_id}

HTTP Request Parameters¶

Parameter	Style	Type	Format	Enumeration	Description	Required
colocation_logical_link_id	URI	string	hyph-uuid	-	Colocation Logical Link unique id	yes

Response¶

HTTP Response Code List¶

Response Code	Description
204	No Content
400	Bad Request
401	UnAuthorized
404	Not Found
409	Conflict
500	Internal Server Error

HTTP Response Parameters¶

This operation does not receive a response body.

Examples¶

Sample Request Body¶

This operation does not send a request body.

Sample Response Body¶

This operation does not receive a response body.

1.2. Colocation Physical Link