Inter DC Interface

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

List Interdc Interface

List all visible interdc_interfaces.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/interdc_interfaces

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
description query string - - Description of the Inter DC Interface resource no
gw_vipv4 query string ipv4 - IP version 4 address to be assigned virtual router on VRRP no
gw_vipv6 query string ipv6 - IP version 6 address to be assigned virtual router on VRRP no
id query string - - Unique ID of the Inter DC Interface resource no
interdc_gw_id query string hyph-uuid-or-empty - Inter DC Gateway to which this port is connected no
name query string - - Name of the Inter DC Interface resource no
netmask query integer - - Netmask for IPv4 addresses no
primary_ipv4 query string ipv4 - IP version 4 address to be assigned to primary device on VRRP no
primary_ipv6 query string ipv6 - IP version 6 address to be assigned to primary device on VRRP no
secondary_ipv4 query string ipv4 - IP version 4 address to be assigned to secondary device on VRRP no
secondary_ipv6 query string ipv6 - IP version 6 address to be assigned to secondary device on VRRP no
status query string - - The Inter DC Gateway Interface status. no
tenant_id query string non-hyph-uuid - Tenant ID of the owner (UUID) no
vrid query integer - - VRRP Group ID for this Inter DC Interface 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
interdc_interfaces array<object> Inter DC Interface -
description string - Description of the Inter DC Interface resource
gw_vipv4 string ipv4 IP version 4 address to be assigned virtual router on VRRP
gw_vipv6 string ipv6 IP version 6 address to be assigned virtual router on VRRP
id string - Unique ID of the Inter DC Interface resource
interdc_gw_id string hyph-uuid-or-empty Inter DC Gateway to which this port is connected
name string - Name of the Inter DC Interface resource
netmask integer - Netmask for IPv4 addresses
primary_ipv4 string ipv4 IP version 4 address to be assigned to primary device on VRRP
primary_ipv6 string ipv6 IP version 6 address to be assigned to primary device on VRRP
secondary_ipv4 string ipv4 IP version 4 address to be assigned to secondary device on VRRP
secondary_ipv6 string ipv6 IP version 6 address to be assigned to secondary device on VRRP
status string - The Inter DC Gateway Interface status.
tenant_id string non-hyph-uuid Tenant ID of the owner (UUID)
vrid integer - VRRP Group ID for this Inter DC Interface

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "interdc_interfaces": [
    {
      "description": "lab3-interdc-interface_for_tenant-sdpgui01",
      "gw_vipv4": "10.26.25.1",
      "gw_vipv6": null,
      "id": "278dfbe4-f8cc-4ce4-aa17-561401c01661",
      "interdc_gw_id": "b6d96194-f74a-4beb-97cd-727f02b0e070",
      "name": "interdc_interface_for_tenant-sdpgui01",
      "netmask": 24,
      "primary_ipv4": "10.26.25.101",
      "primary_ipv6": null,
      "secondary_ipv4": "10.26.25.102",
      "secondary_ipv6": null,
      "status": "DOWN",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
      "vrid": 7
    },
    {
      "description": "lab3-interdc-interface-for-esi_tenant",
      "gw_vipv4": "192.169.1.254",
      "gw_vipv6": null,
      "id": "82098893-b394-4d52-9d24-3df57e63d750",
      "interdc_gw_id": "07f97269-e616-4dff-a73f-ca80bc5682dc",
      "name": "lab3-test-user-interdc-interface",
      "netmask": 24,
      "primary_ipv4": "192.169.1.24",
      "primary_ipv6": null,
      "secondary_ipv4": "192.169.1.25",
      "secondary_ipv6": null,
      "status": "DOWN",
      "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
      "vrid": 7
    }
  ]
}

Create Interdc Interface

Create interdc_interface.

Synchronous / Asynchronous

  • Asynchronous

Request

HTTP Request Method

  • POST

HTTP Request Path

{endpoint}/v2.0/interdc_interfaces

HTTP Request Parameters

Parameter Style Type Format Enumeration Default Description Required
interdc_interface plain object Inter DC Interface - - - yes
description plain string - - “” Description of the Inter DC Interface resource no
gw_vipv4 plain string ipv4 - - IP version 4 address to be assigned virtual router on VRRP yes
gw_vipv6 plain string ipv6 - null IP version 6 address to be assigned virtual router on VRRP no
interdc_gw_id plain string hyph-uuid-or-empty - - Inter DC Gateway to which this port is connected yes
name plain string - - “” Name of the Inter DC Interface resource no
netmask plain integer - - - Netmask for IPv4 addresses yes
primary_ipv4 plain string ipv4 - - IP version 4 address to be assigned to primary device on VRRP yes
primary_ipv6 plain string ipv6 - null IP version 6 address to be assigned to primary device on VRRP no
secondary_ipv4 plain string ipv4 - - IP version 4 address to be assigned to secondary device on VRRP yes
secondary_ipv6 plain string ipv6 - null IP version 6 address to be assigned to secondary device on VRRP no
tenant_id plain string non-hyph-uuid - See notes. Tenant ID of the owner (UUID) no
vrid plain integer - - - VRRP Group ID for this Inter DC Interface yes

Note

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
interdc_interface object Inter DC Interface -
description string - Description of the Inter DC Interface resource
gw_vipv4 string ipv4 IP version 4 address to be assigned virtual router on VRRP
gw_vipv6 string ipv6 IP version 6 address to be assigned virtual router on VRRP
id string - Unique ID of the Inter DC Interface resource
interdc_gw_id string hyph-uuid-or-empty Inter DC Gateway to which this port is connected
name string - Name of the Inter DC Interface resource
netmask integer - Netmask for IPv4 addresses
primary_ipv4 string ipv4 IP version 4 address to be assigned to primary device on VRRP
primary_ipv6 string ipv6 IP version 6 address to be assigned to primary device on VRRP
secondary_ipv4 string ipv4 IP version 4 address to be assigned to secondary device on VRRP
secondary_ipv6 string ipv6 IP version 6 address to be assigned to secondary device on VRRP
status string - The Inter DC Gateway Interface status.
tenant_id string non-hyph-uuid Tenant ID of the owner (UUID)
vrid integer - VRRP Group ID for this Inter DC Interface

Examples

Sample Request Body

{
  "interdc_interface": {
    "description": "lab3-interdc-interface_for_tenant-sdpgui01",
    "gw_vipv4": "10.26.25.1",
    "gw_vipv6": null,
    "interdc_gw_id": "b6d96194-f74a-4beb-97cd-727f02b0e070",
    "name": "interdc_interface_for_tenant-sdpgui01",
    "netmask": 24,
    "primary_ipv4": "10.26.25.101",
    "primary_ipv6": null,
    "secondary_ipv4": "10.26.25.102",
    "secondary_ipv6": null,
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "vrid": 7
  }
}

Sample Response Body

{
  "interdc_interface": {
    "description": "lab3-interdc-interface_for_tenant-sdpgui01",
    "gw_vipv4": "10.26.25.1",
    "gw_vipv6": null,
    "id": "278dfbe4-f8cc-4ce4-aa17-561401c01661",
    "interdc_gw_id": "b6d96194-f74a-4beb-97cd-727f02b0e070",
    "name": "interdc_interface_for_tenant-sdpgui01",
    "netmask": 24,
    "primary_ipv4": "10.26.25.101",
    "primary_ipv6": null,
    "secondary_ipv4": "10.26.25.102",
    "secondary_ipv6": null,
    "status": "PENDING_CREATE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "vrid": 7
  }
}

Show Interdc Interface

Show details for interdc_interface.

Synchronous / Asynchronous

  • Synchronous

Request

HTTP Request Method

  • GET

HTTP Request Path

{endpoint}/v2.0/interdc_interfaces/{interdc_interface_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
interdc_interface_id URI string hyph-uuid - Unique ID of the Inter DC Interface resource 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
interdc_interface object Inter DC Interface -
description string - Description of the Inter DC Interface resource
gw_vipv4 string ipv4 IP version 4 address to be assigned virtual router on VRRP
gw_vipv6 string ipv6 IP version 6 address to be assigned virtual router on VRRP
id string - Unique ID of the Inter DC Interface resource
interdc_gw_id string hyph-uuid-or-empty Inter DC Gateway to which this port is connected
name string - Name of the Inter DC Interface resource
netmask integer - Netmask for IPv4 addresses
primary_ipv4 string ipv4 IP version 4 address to be assigned to primary device on VRRP
primary_ipv6 string ipv6 IP version 6 address to be assigned to primary device on VRRP
secondary_ipv4 string ipv4 IP version 4 address to be assigned to secondary device on VRRP
secondary_ipv6 string ipv6 IP version 6 address to be assigned to secondary device on VRRP
status string - The Inter DC Gateway Interface status.
tenant_id string non-hyph-uuid Tenant ID of the owner (UUID)
vrid integer - VRRP Group ID for this Inter DC Interface

Examples

Sample Request Body

This operation does not send a request body.

Sample Response Body

{
  "interdc_interface": {
    "description": "lab3-interdc-interface_for_tenant-sdpgui01",
    "gw_vipv4": "10.26.25.1",
    "gw_vipv6": null,
    "id": "278dfbe4-f8cc-4ce4-aa17-561401c01661",
    "interdc_gw_id": "b6d96194-f74a-4beb-97cd-727f02b0e070",
    "name": "interdc_interface_for_tenant-sdpgui01",
    "netmask": 24,
    "primary_ipv4": "10.26.25.101",
    "primary_ipv6": null,
    "secondary_ipv4": "10.26.25.102",
    "secondary_ipv6": null,
    "status": "DOWN",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "vrid": 7
  }
}

Update Interdc Interface

Update interdc_interface.

Synchronous / Asynchronous

  • Asynchronous

Request

HTTP Request Method

  • PUT

HTTP Request Path

{endpoint}/v2.0/interdc_interfaces/{interdc_interface_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
interdc_interface_id URI string hyph-uuid - Unique ID of the Inter DC Interface resource yes
interdc_interface plain object Inter DC Interface - - yes
description plain string - - Description of the Inter DC Interface resource no
name plain string - - Name of the Inter DC Interface resource 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
interdc_interface object Inter DC Interface -
description string - Description of the Inter DC Interface resource
gw_vipv4 string ipv4 IP version 4 address to be assigned virtual router on VRRP
gw_vipv6 string ipv6 IP version 6 address to be assigned virtual router on VRRP
id string - Unique ID of the Inter DC Interface resource
interdc_gw_id string hyph-uuid-or-empty Inter DC Gateway to which this port is connected
name string - Name of the Inter DC Interface resource
netmask integer - Netmask for IPv4 addresses
primary_ipv4 string ipv4 IP version 4 address to be assigned to primary device on VRRP
primary_ipv6 string ipv6 IP version 6 address to be assigned to primary device on VRRP
secondary_ipv4 string ipv4 IP version 4 address to be assigned to secondary device on VRRP
secondary_ipv6 string ipv6 IP version 6 address to be assigned to secondary device on VRRP
status string - The Inter DC Gateway Interface status.
tenant_id string non-hyph-uuid Tenant ID of the owner (UUID)
vrid integer - VRRP Group ID for this Inter DC Interface

Examples

Sample Request Body

{
  "interdc_interface": {
    "description": "lab3-interdc-interface_for_tenant-sdpgui01",
    "name": "interdc_interface_for_tenant-sdpgui01"
  }
}

Sample Response Body

{
  "interdc_interface": {
    "description": "lab3-interdc-interface_for_tenant-sdpgui01",
    "gw_vipv4": "10.26.25.1",
    "gw_vipv6": null,
    "id": "278dfbe4-f8cc-4ce4-aa17-561401c01661",
    "interdc_gw_id": "b6d96194-f74a-4beb-97cd-727f02b0e070",
    "name": "interdc_interface_for_tenant-sdpgui01",
    "netmask": 24,
    "primary_ipv4": "10.26.25.101",
    "primary_ipv6": null,
    "secondary_ipv4": "10.26.25.102",
    "secondary_ipv6": null,
    "status": "PENDING_UPDATE",
    "tenant_id": "6a156ddf2ecd497ca786ff2da6df5aa8",
    "vrid": 7
  }
}

Delete Interdc Interface

Delete interdc_interface.

Synchronous / Asynchronous

  • Asynchronous

Request

HTTP Request Method

  • DELETE

HTTP Request Path

{endpoint}/v2.0/interdc_interfaces/{interdc_interface_id}

HTTP Request Parameters

Parameter Style Type Format Enumeration Description Required
interdc_interface_id URI string hyph-uuid - Unique ID of the Inter DC Interface resource 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.