APIRef_tm_pem_quota-mgmt_rating-group¶
mgmt/tm/pem/quota-mgmt/rating-group
PEM Rating Group
REST Endpoints
- Collection URI
/mgmt/tm/pem/quota-mgmt/rating-group- Collection Methods
OPTIONS, GET- Resource URI
/mgmt/tm/pem/quota-mgmt/rating-group/~resource id- Resource Methods
OPTIONS, GET, PUT, PATCH, DELETE, POST- Resource Natural Key
name, partition, subPath
Properties
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
appService |
string | optional | read/write | Specifies the application service that the object belongs to. | |
defaultForwardingEndpoint |
string | optional | read/write | Default forwarding endpoint if OCS has not provisioned. | |
defaultQuotaBreachAction |
string | terminate | optional | read/write | Default breach action if quota exhausted and OCS has not provisioned. |
defaultQuotaHoldingTime |
integer | 0 | optional | read/write | Specifies the default quota holding time in seconds without any quota usage after which quota is returned to OCS server. |
defaultThreshold |
integer | 0 | optional | read/write | Default threshold if not specified by the OCS server. |
defaultValidityTime |
integer | 0 | optional | read/write | Specifies the default validity time in seconds for which quota is valid after which quota is returned to OCS server. |
description |
string | optional | read/write | User defined description. | |
tmPartition |
string | Common | optional | read/write | |
ratingGroupId |
integer | required | read/write | Rating group that will be used by Gy quota managing endpoint. | |
requestOnInstall |
string | no | optional | read/write | Whether quota has to be requested when policy is installed. |
Structures
| Name | Type | Default Value | Required | Access | Description |
|---|---|---|---|---|---|
/default-quota |
array_structure | optional | read/write | ||
/default-quota/time |
array_structure | optional | read/write | ||
/default-quota/time/consumption-time |
integer | 0 | optional | read/write | Specifies the default maximum idle time in seconds that is accounted as quota usage. |
/default-quota/time/usage-time |
uint64 | 0 | optional | read/write | Specifies the default time quota in seconds. |
/default-quota/time/consumption-time |
integer | 0 | optional | read/write | Specifies the default maximum idle time in seconds that is accounted as quota usage. |
/default-quota/time/usage-time |
uint64 | 0 | optional | read/write | Specifies the default time quota in seconds. |
/default-quota/volume |
array_structure | optional | read/write | ||
/default-quota/volume/input-octets |
uint64 | 0 | optional | read/write | Specifies the default uplink traffic quota before reply from OCS server. |
/default-quota/volume/output-octets |
uint64 | 0 | optional | read/write | Specifies the default downlink traffic quota before reply from OCS server. |
/default-quota/volume/total-octets |
uint64 | 0 | optional | read/write | Specifies the default total traffic quota before reply from OCS server. |
/default-quota/volume/input-octets |
uint64 | 0 | optional | read/write | Specifies the default uplink traffic quota before reply from OCS server. |
/default-quota/volume/output-octets |
uint64 | 0 | optional | read/write | Specifies the default downlink traffic quota before reply from OCS server. |
/default-quota/volume/total-octets |
uint64 | 0 | optional | read/write | Specifies the default total traffic quota before reply from OCS server. |
/initial-quota-request |
array_structure | optional | read/write | ||
/initial-quota-request/time |
uint64 | 0 | optional | read/write | Specifies the initial quota request time in seconds. |
/initial-quota-request/volume |
array_structure | optional | read/write | ||
/initial-quota-request/volume/input-octets |
uint64 | 0 | optional | read/write | Specifies the initial uplink traffic quota to be asked from OCS server. |
/initial-quota-request/volume/output-octets |
uint64 | 0 | optional | read/write | Specifies the initial downlink traffic to be asked from OCS server. |
/initial-quota-request/volume/total-octets |
uint64 | 0 | optional | read/write | Specifies the initial total traffic to be asked from OCS server. |
/initial-quota-request/volume/input-octets |
uint64 | 0 | optional | read/write | Specifies the initial uplink traffic quota to be asked from OCS server. |
/initial-quota-request/volume/output-octets |
uint64 | 0 | optional | read/write | Specifies the initial downlink traffic to be asked from OCS server. |
/initial-quota-request/volume/total-octets |
uint64 | 0 | optional | read/write | Specifies the initial total traffic to be asked from OCS server. |
/initial-quota-request/time |
uint64 | 0 | optional | read/write | Specifies the initial quota request time in seconds. |
Copyright (c) 2016, F5 Networks Inc. All Rights Reserved.
The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.
