Get Policy Sets (v3.0)

GET 
/v3.0/api/tenants/:tenant_id/policysets

List all the policy sets of a tenant.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

Responses

200

Successful Operation

application/json

Schema

Schema

count int32

The actual count.

id string

The ID.

tenant_id string

The tenant ID.

items PolicySet[]
Array [
bandwidth_allocation_schemes BandwidthAllocationScheme[]required
Allocate or modify the percentage of bandwidth configured for each priority and application traffic type. Can configure up to four bandwidth allocation schemes.
Array [
bandwidth_range BandwidthRange
The details of the bandwidth range.
high double
The high range of the bandwidth allocated.
low double
The low range of the bandwidth allocated.
business_priorities BusinessPriority[]
Information on the business priorities.
Array [
bandwidth_allocation double
The bandwidth allocated.
bandwidth_split_per_type BandwidthSplit
The bandwidth split per type.
bulk double
Bulk
rt_audio double
Rt Audio
rt_video double
Rt Video
transactional double
Transactional
priority_num int32
The priority number.
]
]
business_priority_names BusinessPriorityNameMapper[]required
The list of business priority names. Max size = 4.
Array [
priority_name string
The business priority name.
priority_num int32
The business priority number.
]
default_policy boolean
The default policy.
description
The description of the policy set.
id string
The policy set ID.
name stringrequired
The name of the policy set. Max size = 128.
]

Example (from schema)

{
  "count": 0,
  "id": "string",
  "tenant_id": "string",
  "items": [
    {
      "bandwidth_allocation_schemes": [
        {
          "bandwidth_range": {
            "high": 0,
            "low": 0
          },
          "business_priorities": [
            {
              "bandwidth_allocation": 0,
              "bandwidth_split_per_type": {
                "bulk": 0,
                "rt_audio": 0,
                "rt_video": 0,
                "transactional": 0
              },
              "priority_num": 0
            }
          ]
        }
      ],
      "business_priority_names": [
        {
          "priority_name": "string",
          "priority_num": 0
        }
      ],
      "default_policy": true,
      "id": "string",
      "name": "string"
    }
  ]
}

Loading...