List Routers

GET 
/backend/api/openstack/routers

Host: https://core.ocplanet.cloud

Retrieve a list of routers associated with the user's instances.

Request

Query Parameters

filtering string
ordering string
page string
page_size string

Responses

200

application/json

Schema

Schema

count integerrequired
next nullrequired
previous nullrequired
objects object[]required
Array [
id stringrequired
routes arrayrequired
availability_zones string[]required
availability_hints arrayrequired
network_name string
name string
status string
admin_state_up booleanrequired
description string
external_network_id uuid
external_fixed_ips stringrequired
enable_snat booleanrequired
distributed booleanrequired
ha booleanrequired
region string
project uuid
]
totalCount integerrequired
pageNo stringrequired
permissions objectrequired
routers.list booleanrequired
routers.retrieve booleanrequired
routers.create booleanrequired
routers.update booleanrequired
routers.destroy booleanrequired
routers.add_interface booleanrequired
routers.remove_interface booleanrequired
filter_options objectrequired
status object[]required
Array [
display stringrequired
value stringrequired
]
availability_zones__contains object[]required
Array [
display stringrequired
value stringrequired
]

Example (from schema)

{
  "count": 0,
  "objects": [
    {
      "id": "string",
      "routes": [
        null
      ],
      "availability_zones": [
        "string"
      ],
      "availability_hints": [
        null
      ],
      "network_name": "string",
      "name": "string",
      "status": "string",
      "admin_state_up": true,
      "description": "string",
      "external_network_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "external_fixed_ips": "string",
      "enable_snat": true,
      "distributed": true,
      "ha": true,
      "region": "string",
      "project": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
    }
  ],
  "totalCount": 0,
  "pageNo": "string",
  "permissions": {
    "routers.list": true,
    "routers.retrieve": true,
    "routers.create": true,
    "routers.update": true,
    "routers.destroy": true,
    "routers.add_interface": true,
    "routers.remove_interface": true
  },
  "filter_options": {
    "status": [
      {
        "display": "string",
        "value": "string"
      }
    ],
    "availability_zones__contains": [
      {
        "display": "string",
        "value": "string"
      }
    ]
  }
}

409

You may not have services or there may not be funds on your balance to complete this operation.

application/json

Schema

Schema

detail stringrequired

Example (from schema)

{
  "detail": "string"
}

Example

{
  "detail": "Your client has no active OpenStack project"
}

Loading...