GET /virtualservice/{uuid}/scaleoutstatus/

/virtualservice/{uuid}/scaleoutstatus/

Request

URI

GET

https://{api_host}/api/virtualservice/{uuid}/scaleoutstatus

COPY

Path Parameters

string

uuid

Required

UUID of the object to fetch

Header Parameters

string

X-Avi-Tenant

Optional

Avi Tenant Header

string

X-Avi-Tenant-UUID

Optional

Avi Tenant Header UUID

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.

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.

Authentication

This operation uses the following authentication methods.

basicAuth

Responses

200

Returns VirtualServiceScaleoutStatus of type(s) application/json

{
    "flow_distribution_algo": "string",
    "ipc_encap_type": "string",
    "num_vs_pkts_punted": 0,
    "scaleout_type": "string",
    "so_se_entries": [
        {
            "curr_num_local_flows": 0,
            "curr_num_remote_flows": 0,
            "has_hb_issues": false,
            "ip_address": {
                "addr": "string",
                "type": "string"
            },
            "is_primary": false,
            "num_vs_flows": 0,
            "se_uuid": "string"
        }
    ],
    "total_num_vs_flows": 0,
    "tunnel_mode": false,
    "vs_uuid": "string"
}

string

flow_distribution_algo

Optional

Algorithm used by Primary SE of l2-scaleout VS to distribute flows to secondary SE's. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

ipc_encap_type

Optional

Encapsulation used for IPC messages between primary and secondary SE's. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint64 As uint64

num_vs_pkts_punted

Optional

Number of VS packets punted to remote SE's. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

scaleout_type

Optional

Type of VS Scaleout - L2 or ECMP. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

array of object

so_se_entries

Optional

Scaleout SE entries. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint64 As uint64

total_num_vs_flows

Optional

Cumulative number of VS flows that arrived for VS on the primary SE. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean

tunnel_mode

Optional

Set to True if return traffic is tunnelled back from secondary SE to primary SE. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

string

vs_uuid

Optional

UUID of the Virtual Service. Field introduced in 20.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

401

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/virtualservice/{uuid}/scaleoutstatus

On This Page

Description

Request

Path Parameters

Header Parameters

Authentication

Response

200 Response Body

Errors

Virtual Service Operations