GET /ratelimitconfiguration/{uuid}

GET /ratelimitconfiguration/{uuid}

/ratelimitconfiguration/{uuid}/{uuid}

Request
URI
GET
https://{api_host}/api/ratelimitconfiguration/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

string
fields
Optional

List of fields to be returned for the resource. Some fields like name, URL, uuid etc. are always returned.

boolean
include_name
Optional

All the Avi REST reference URIs have a name suffix as URI#name. It is useful to get the referenced resource name without performing get on that object.

boolean
skip_default
Optional

Default values are not set.

string
join_subresources
Optional

It automatically returns additional dependent resources like runtime. Eg. join_subresources=runtime.

Header Parameters
string
X-Avi-Tenant
Optional

Avi Tenant Header

string
X-Avi-Tenant-UUID
Optional

Avi Tenant Header UUID

string
X-Avi-Version
Required

The caller is required to set Avi Version Header to the expected version of configuration. The response from the controller will provide and accept data according to the specified version. The controller will reject POST and PUT requests where the data is not compatible with the specified version.

string
X-CSRFToken
Optional

Avi Controller may send back CSRF token in the response cookies. The caller should update the request headers with this token else controller will reject requests.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns RateLimitConfiguration of type(s) application/json 
{
    "_last_modified": "string",
    "burst": 0,
    "description": "string",
    "http_methods": [
        "string"
    ],
    "name": "string",
    "resource": "string",
    "tenant_ref": "string",
    "token_refill_rate": {
        "interval": "string",
        "refill_rate": 0
    },
    "type": "string",
    "url": "string",
    "uuid": "string"
}
string
_last_modified
Optional

UNIX time since epoch in microseconds. Units(MICROSECONDS).

integer As uint32 As uint32
burst
Optional
Constraints: default: 1

The maximum request per second(RPS) user intends to support for this category.This is not guaranteed as this will be the minimum of the RPS supported by the resources in the category and this value.If user doesn't provide then it will be minimum value of the resources in this category. Allowed values are 1-1000. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
description
Optional

Description for the Rate Limit Configuration. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

array of string
http_methods
Optional

List of HTTP method(s) of the resources that need to be rate limited. Enum options - HTTP_METHOD_GET, HTTP_METHOD_HEAD, HTTP_METHOD_PUT, HTTP_METHOD_DELETE, HTTP_METHOD_POST, HTTP_METHOD_OPTIONS, HTTP_METHOD_TRACE, HTTP_METHOD_CONNECT, HTTP_METHOD_PATCH, HTTP_METHOD_PROPFIND, HTTP_METHOD_PROPPATCH, HTTP_METHOD_MKCOL, HTTP_METHOD_COPY, HTTP_METHOD_MOVE, HTTP_METHOD_LOCK, HTTP_METHOD_UNLOCK. Field introduced in 31.2.1. Minimum of 1 items required. Maximum of 5 items allowed. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
name
Required

Name of the Rate Limit Configuration(unique). Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
resource
Required

RateLimitResource which needs to be rate limited. Enum options - RATE_LIMIT_VIRTUALSERVICE, RATE_LIMIT_POOL, RATE_LIMIT_LOGIN, RATE_LIMIT_AUTHTOKEN, RATE_LIMIT_HEALTHMONITOR. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
tenant_ref
Optional

Tenant ref for the auth Rate Limit Configuration. It is a reference to an object of type Tenant. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

object
token_refill_rate
Required

token_refill_rate

string
type
Optional
Constraints: default: RATE_LIMITER_API_CATEGORY

Type of the Rate Limiter, for now we only support api categorization based. Enum options - RATE_LIMITER_API_CATEGORY. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.

string
url
Optional

url

string
uuid
Optional

UUID of the Rate Limit Configuration. Field introduced in 31.2.1. Allowed with any value in Enterprise, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

404

object not found

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/ratelimitconfiguration/{uuid}
On This Page
Rate Limit Configuration Operations
GET
GET /ratelimitconfiguration
POST
POST /ratelimitconfiguration
GET
GET /ratelimitconfiguration/{uuid}
PUT
PUT /ratelimitconfiguration/{uuid}
PATCH
PATCH /ratelimitconfiguration/{uuid}
DELETE
DELETE /ratelimitconfiguration/{uuid}