Get Hub Cluster Members (v3.0)

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

List all the hub cluster members.

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.

hub_cluster_id stringrequired

ID of the hub cluster.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

deleted_count int64

The deleted number.

deleted_ids string[]

The deleted IDs.

description

Description of the query. Max size = 256.

id string

The ID.

next_query object

Details of the next query.

tenant_id string

The tenant ID.

total_count int64

Total number.

items HubClusterMemberScreen[]
Array [
headend1_site_ids string[]
Headend1 Site Ids
headend2_site_ids string[]
Headend2 Site Ids
hub_element_id string
Hub Element Id
id string
Id
load_factors LoadFactor[]
Load Factors
Array [
alarm_threshold int32
Alarm Threshold
allocated int64
Allocated
subscription_factor double
Subscription Factor
threshold ThresholdConfig
Threshold
critical_alarm int32
Critical Alarm
major_alarm int32
Major Alarm
subscription_factor double
Subscription Factor
type string
Possible values: [forwarding-capacity, flow]
Type
]
]

Example (from schema)

{
  "count": 0,
  "deleted_count": 0,
  "deleted_ids": [
    "string"
  ],
  "id": "string",
  "next_query": {},
  "tenant_id": "string",
  "total_count": 0,
  "items": [
    {
      "headend1_site_ids": [
        "string"
      ],
      "headend2_site_ids": [
        "string"
      ],
      "hub_element_id": "string",
      "id": "string",
      "load_factors": [
        {
          "alarm_threshold": 0,
          "allocated": 0,
          "subscription_factor": 0,
          "threshold": {
            "critical_alarm": 0,
            "major_alarm": 0,
            "subscription_factor": 0
          },
          "type": "forwarding-capacity"
        }
      ]
    }
  ]
}

Loading...