Get Hub Clusters (v3.0)

GET 
/v3.0/api/tenants/:tenant_id/sites/:site_id/hubclusters

List all the hub clusters.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

site_id stringrequired

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

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

id string

The ID.

tenant_id string

The tenant ID.

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
The subscription factor.
]

Example (from schema)

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

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

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

Example

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

Loading...