Get Hub Clusters (v3.0)

List all the hub clusters.

Path Parameters

• tenant_id string required

  The tenant ID.

• site_id string required

  ID of the site. More details on the site can be retrieved by querying the sites API.

Responses

• 200
• 400

---

Successful Operation

application/json

• Schema
• Example (from schema)

---

Schema

• count int32

  The number of responses.

• id string

  The ID of the response.

• tenant_id string
• items HubCluster[]

  Array [

  admin_up boolean

  The hub cluster admin state.

  id string

  The ID.

  load_alarm_threshold int32

  The load alarm threshold.

  name string

  The resource name (Max size = 128).

  subscription_factor float

  Subscription Factor: Digits(fraction = 1, integer = 1, ) ValidateDecimal(allowZero = false, increment = 5, max = 5, error = INVALID_VALUE_RANGE: Invalid value range., min = 5)

  ]

{
  "count": 0,
  "id": "string",
  "tenant_id": "string",
  "items": [
    {
      "admin_up": true,
      "id": "string",
      "load_alarm_threshold": 0,
      "name": "string",
      "subscription_factor": 0
    }
  ]
}

Bad Request

application/json

• Schema
• Example (from schema)
• Example

---

Schema

• _error ErrorResponse[]

  Array [

  code string

  message string

  ]

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

{
  "value": {
    "_error": [
      {
        "code": "INVALID_VALUE_RANGE"
      },
      {
        "code": "NAME_EXCEEDS_LIMIT"
      }
    ]
  }
}

Loading...