GET /poolgroup

GET /poolgroup

/poolgroup

Request
URI
GET
https://{api_host}/api/poolgroup
COPY
Query Parameters
string
name
Optional

object name

string
refers_to
Optional

Filter to request all objects that refers to another Avi resource. Its syntax is refers_to= : . Eg. get all virtual services referring to pool p1 will be refers_to=pool:pool_p1_uuid

string
referred_by
Optional

Filter to request all objects that are referred by another Avi resource. Its syntax is referred_by= : . Eg. get all pools referred_by virtual service vs1 - referred_by=virtualservice:vs_vs1_uuid

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.

string
cloud_uuid
Optional

Filter to get objects that belongs to a specific cloud using its uuid. Eg. cloud_uuid=cloud-xyz.

string
cloud_ref.name
Optional

Filter to get objects that belongs to a specific cloud usings its name. This uses cloud name rather than uuid. Eg. cloud_ref.name=Default-Cloud.

string
cloud_ref.uuid
Optional

Filter to get objects that belongs to a specific cloud using its uuid. Eg. cloud_ref.uuid=cloud_uuid.

string
name.contains
Optional

Filter to get objects with name that contains the parameter. This is a case sensitive search. Eg. name.contains=pool-.

string
name.icontains
Optional

Filter to get objects with name that contains the parameter. This is a case insensitive search. Eg. name.icontains=pool-.

string
name.in
Optional

Filter to get objects that have a uuid matching any of the values in the parameter list. Each value for this parameter is to comma separated. Eg. name.in=pool-1,pool-12.

string
uuid.in
Optional

Filter to get objects that have a uuid matching any of the values in the parameter list. Each value for this parameter is to comma separated. Eg. uuid.in= , .

string
search
Optional

Filter to get objects that contains the search string as value for any of its fields. Eg. search=LEAST_CONN. The search filter can also be used to search under a specific field. This is achieved by sending the parameter as ?search=( , )|( , ). Eg. search=(name,vs-pool-).

string
isearch
Optional

Filter to get objects that contains case insensitive search string. Eg. isearch=(name,Vs-Pool-).

string
limit_by
Optional

Filter to limit the number of objects in the response data. Eg. limit_by=3.

string
exclude
Optional

Filter to exclude the uuid(s) contained in the parameter. Eg. uuid.in= , &exclude=uuid.in.

string
sort
Optional

Parameter to sort the results with respect to a field. Eg. sort=name.

string
page_size
Optional

Parameter to specify the maximum number of results to be returned per page. The page_size can range from 1 to 200. Eg. page_size=5.

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.

Responses
200

OK

Returns PoolGroupApiResponse of type(s) application/json 
{
    "count": 0,
    "results": [
        {
            "_last_modified": "string",
            "cloud_config_cksum": "string",
            "cloud_ref": "string",
            "configpb_attributes": {
                "version": 0
            },
            "created_by": "string",
            "deactivate_primary_pool_on_down": false,
            "deployment_policy_ref": "string",
            "description": "string",
            "enable_http2": false,
            "fail_action": {
                "local_rsp": {
                    "file": {
                        "content_type": "string",
                        "file_content": "string",
                        "file_length": 0
                    },
                    "status_code": "string"
                },
                "redirect": {
                    "host": "string",
                    "path": "string",
                    "protocol": "string",
                    "query": "string",
                    "status_code": "string"
                },
                "type": "string"
            },
            "implicit_priority_labels": false,
            "markers": [
                {
                    "key": "string",
                    "values": [
                        "string"
                    ]
                }
            ],
            "members": [
                {
                    "deployment_state": "string",
                    "pool_ref": "string",
                    "priority_label": "string",
                    "ratio": 0
                }
            ],
            "min_servers": 0,
            "name": "string",
            "priority_labels_ref": "string",
            "service_metadata": "string",
            "tenant_ref": "string",
            "url": "string",
            "uuid": "string"
        }
    ],
    "next": "string"
}
integer As int32 As int32
count
Required

count

array of object
results
Required

results

string
next
Optional

next


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY 
                    curl -H 'Authorization: <value>' https://{api_host}/api/poolgroup
On This Page
Pool Group Operations
GET
GET /poolgroup
POST
POST /poolgroup
GET
GET /poolgroup/{uuid}
PUT
PUT /poolgroup/{uuid}
PATCH
PATCH /poolgroup/{uuid}
DELETE
DELETE /poolgroup/{uuid}
POST
POST /poolgroup/clear
GET
GET /poolgroup/{uuid}/runtime/detail/
POST
POST /poolgroup/{uuid}/enable_primary_pool/clear