List of Clusters

GET 
https://core-pl.ocplanet.cloud/backend/api/cluster/

Host: https://core.ocplanet.cloud

Retrieve a list of Clusters.

Request

Responses

200

application/json

Schema

Schema

count integerrequired
next nullstringrequired
objects object[]required
Array [
admin_state_up booleanrequired
id stringrequired
lb_algorithm stringrequired
name stringrequired
operating_status stringrequired
protocol stringrequired
provisioning_status stringrequired
]
onePage booleanrequired
pageNo integerrequired
permissions objectrequired
lbaas-pools.create booleanrequired
lbaas-pools.destroy booleanrequired
lbaas-pools.list booleanrequired
lbaas-pools.retrieve booleanrequired
lbaas-pools.update booleanrequired
previous nullstringrequired
totalCount integerrequired

Example (from schema)

{
  "count": 0,
  "objects": [
    {
      "admin_state_up": true,
      "id": "string",
      "lb_algorithm": "string",
      "name": "string",
      "operating_status": "string",
      "protocol": "string",
      "provisioning_status": "string"
    }
  ],
  "onePage": true,
  "pageNo": 0,
  "permissions": {
    "lbaas-pools.create": true,
    "lbaas-pools.destroy": true,
    "lbaas-pools.list": true,
    "lbaas-pools.retrieve": true,
    "lbaas-pools.update": true
  },
  "totalCount": 0
}

Example

{
  "count": 7,
  "next": null,
  "previous": null,
  "objects": [
    {
      "id": "d1008e5f-4c0f-4d63-ba0b-b8f91da5fbf3",
      "name": "ffff",
      "protocol": "UDP",
      "lb_algorithm": "LEAST_CONNECTIONS",
      "operating_status": "OFFLINE",
      "provisioning_status": "ACTIVE",
      "admin_state_up": true
    },
    {
      "id": "e95eaf85-6781-4813-85be-96261775e2dd",
      "name": "ffff",
      "protocol": "UDP",
      "lb_algorithm": "LEAST_CONNECTIONS",
      "operating_status": "OFFLINE",
      "provisioning_status": "ACTIVE",
      "admin_state_up": true
    },
    {
      "id": "97eac0cd-2c2f-4f11-a59d-9a6c65b5e507",
      "name": "ffff",
      "protocol": "UDP",
      "lb_algorithm": "LEAST_CONNECTIONS",
      "operating_status": "OFFLINE",
      "provisioning_status": "ACTIVE",
      "admin_state_up": true
    }
  ],
  "totalCount": 7,
  "pageNo": 1,
  "onePage": true,
  "permissions": {
    "lbaas-pools.list": true,
    "lbaas-pools.retrieve": true,
    "lbaas-pools.create": true,
    "lbaas-pools.destroy": true,
    "lbaas-pools.update": true
  }
}

Authorization: Authorization

name: Authorizationtype: apiKeyin: headerdescription: Use 'OpenAPIToken {token}' as the value

• curl
• python
• go
• nodejs
• ruby
• csharp
• php
• java
• powershell

• CURL

curl -L -X GET 'https://core-pl.ocplanet.cloud/backend/api/cluster/' \
-H 'Accept: application/json' \
-H 'Authorization: <API_KEY_VALUE>'

Request Collapse all

Base URL

https://core-pl.ocplanet.cloud

Auth

apikey header authorization

ResponseClear

Click the Send API Request button above and see the response here!