PATCH /pool-inventory/{uuid}

PATCH /pool-inventory/{uuid}

/pool-inventory/{uuid}

Request
URI
PATCH
https://{api_host}/api/pool-inventory/{uuid}
COPY
Path Parameters
string
uuid
Required

UUID of the object to fetch

Query Parameters
string
name
Optional

object name

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.


Request Body

PoolInventory object creation

PoolInventory of type(s) application/json
Optional
{
    "_last_modified": "string",
    "alert": {
        "level": "string"
    },
    "app_profile_type": "string",
    "config": {
        "cloud_ref": "string",
        "created_by": "string",
        "default_server_port": 0,
        "enabled": false,
        "gslb_sp_enabled": false,
        "name": "string",
        "ref": "string",
        "tenant_ref": "string",
        "url": "string",
        "vrf_ref": "string"
    },
    "health_score": {
        "anomaly_penalty": 0,
        "health_score": "number",
        "performance_score": {
            "application_performance": {
                "reason": "string",
                "reason_attr": "string",
                "ref": "string",
                "virtualservice_performance_scores": [
                    {
                        "hs_entity": {
                            "entity_uuid": "string",
                            "metrics_entity": "string",
                            "pool_ref": "string",
                            "server": "string"
                        },
                        "reason": "string",
                        "score_data": {
                            "apdexc": "number",
                            "apdexr": "number",
                            "avg_pool_performance_score": "number",
                            "oper_state": "string",
                            "pool_performance_scores": [
                                {
                                    "hs_entity": {
                                        "entity_uuid": "string",
                                        "metrics_entity": "string",
                                        "pool_ref": "string",
                                        "server": "string"
                                    },
                                    "reason": "string",
                                    "score_data": {
                                        "apdexc": "number",
                                        "apdexr": "number",
                                        "oper_state": "string",
                                        "pool_ref": "string",
                                        "reason": "string",
                                        "reason_attr": "string",
                                        "ref": "string",
                                        "sum_finished_conns": "number"
                                    },
                                    "value": "number"
                                }
                            ],
                            "reason": "string",
                            "reason_attr": "string",
                            "ref": "string",
                            "rum_apdexr": "number",
                            "sum_finished_conns": "number",
                            "vs_uptime": "number"
                        },
                        "value": "number"
                    }
                ]
            },
            "pool_performance": {
                "apdexc": "number",
                "apdexr": "number",
                "oper_state": "string",
                "pool_ref": "string",
                "reason": "string",
                "reason_attr": "string",
                "ref": "string",
                "sum_finished_conns": "number"
            },
            "reason": "string",
            "reason_attr": "string",
            "server_performance": {
                "apdexc": "number",
                "apdexr": "number",
                "oper_state": "string",
                "pool_uuid": "string",
                "reason": "string",
                "reason_attr": "string",
                "ref": "string",
                "server": "string",
                "sum_finished_conns": "number"
            },
            "serviceengine_performance": {
                "oper_state": "string",
                "reason": "string",
                "reason_attr": "string",
                "ref": "string"
            },
            "value": "number",
            "virtualservice_performance": {
                "apdexc": "number",
                "apdexr": "number",
                "avg_pool_performance_score": "number",
                "oper_state": "string",
                "pool_performance_scores": [
                    {
                        "hs_entity": {
                            "entity_uuid": "string",
                            "metrics_entity": "string",
                            "pool_ref": "string",
                            "server": "string"
                        },
                        "reason": "string",
                        "score_data": {
                            "apdexc": "number",
                            "apdexr": "number",
                            "oper_state": "string",
                            "pool_ref": "string",
                            "reason": "string",
                            "reason_attr": "string",
                            "ref": "string",
                            "sum_finished_conns": "number"
                        },
                        "value": "number"
                    }
                ],
                "reason": "string",
                "reason_attr": "string",
                "ref": "string",
                "rum_apdexr": "number",
                "sum_finished_conns": "number",
                "vs_uptime": "number"
            }
        },
        "resources_penalty": 0,
        "security_penalty": 0
    },
    "metrics": {
        "data": {
            "value": "number"
        },
        "headers": {
            "statistics": {
                "max": "number",
                "mean": "number",
                "min": "number",
                "num_samples": 0
            }
        }
    },
    "runtime": {
        "num_servers": 0,
        "num_servers_enabled": 0,
        "num_servers_up": 0,
        "oper_status": {
            "last_changed_time": {
                "secs": 0,
                "usecs": 0
            },
            "reason": [
                "string"
            ],
            "reason_code": 0,
            "reason_code_string": "string",
            "state": "string"
        },
        "percent_servers_up_enabled": 0,
        "percent_servers_up_total": 0
    },
    "url": "string",
    "uuid": "string",
    "virtualservices": [
        {
            "ref": "string"
        }
    ]
}
Responses
200

OK

Returns PoolInventory of type(s) application/json
"PoolInventory Object"
string
_last_modified
Optional

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

object
alert
Optional

alert

string
app_profile_type
Optional

Application type of the VS. Enum options - APPLICATION_PROFILE_TYPE_L4, APPLICATION_PROFILE_TYPE_HTTP, APPLICATION_PROFILE_TYPE_SYSLOG, APPLICATION_PROFILE_TYPE_DNS, APPLICATION_PROFILE_TYPE_SSL, APPLICATION_PROFILE_TYPE_SIP. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

object
config
Optional

config

object
health_score
Optional

health_score

object
metrics
Optional

metrics

object
runtime
Optional

runtime

string
url
Optional

url

string
uuid
Optional

UUID of the pool. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.

array of object
virtualservices
Optional

Virtual services the pool is assigned to. Field introduced in 22.1.1. Allowed in Enterprise edition with any value, Enterprise with Cloud Services edition.


401

log in failed

Operation doesn't return any data structure

Code Samples
COPY
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'