GET /serviceengine/{uuid}/metrics/

• Service Engine

/serviceengine/{uuid}/metrics/

Request

URI

GET

https://{api_host}/api/serviceengine/{uuid}/metrics

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

Hide Details

OK

Returns MetricsRuntimeSummary of type(s) application/json

{
    "l4_pool_met_msgs_read": 0,
    "l4_vs_met_msgs_read": 0,
    "l7_pool_met_msgs_read": 0,
    "l7_vs_met_msgs_read": 0,
    "metrics_objs": [
        {
            "connect_in_progress": false,
            "connected": false,
            "controller_ip": "string",
            "ctlr_send_interval_max_time": 0,
            "delayed_metrics_response": 0,
            "disable_server_analytics": false,
            "eastwest": false,
            "effective_controller_ip": "string",
            "last_cleared_timestamp": 0,
            "last_read_version": 0,
            "met_read_state": "string",
            "metrics_mgr_port": "string",
            "num_dos_msgs_sent": 0,
            "num_drops": 0,
            "num_metrics_msgs_sent": 0,
            "num_misses": 0,
            "num_resets": 0,
            "num_update_errors": 0,
            "rt_metrics": false,
            "status": "string",
            "timer_interval": 0,
            "type": "string",
            "uuid": "string"
        }
    ],
    "non_rt_met_batch_size": 0,
    "non_rt_met_update_timer_running": false,
    "non_rt_metrics_entities": 0,
    "non_rt_metrics_timer_interval": 0,
    "num_dos_msgs_sent": 0,
    "num_metrics_msgs_sent": 0,
    "rt_met_batch_size": 0,
    "rt_met_update_timer_running": false,
    "rt_metrics_entities": 0,
    "rt_metrics_timer_interval": 0,
    "se_met_msgs_read": 0,
    "total_entities": 0
}

integer As uint32 As uint32

l4_pool_met_msgs_read

Optional

Total number of L4 Pool-metrics messages read from shm. Field introduced in 30.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32

l4_vs_met_msgs_read

Optional

Total number of L4 VS-metrics messages read from shm. Field introduced in 30.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32

l7_pool_met_msgs_read

Optional

Total number of L7 Pool-metrics messages read from shm. Field introduced in 30.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32

l7_vs_met_msgs_read

Optional

Total number of L7 VS-metrics messages read from shm. Field introduced in 30.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

array of object

metrics_objs

Optional

Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32

non_rt_met_batch_size

Optional

Number of non-rt metrics objects processed by se_dp in one timer interval. Field introduced in 30.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean

non_rt_met_update_timer_running

Optional

Flag to indicate if metrics update timer is running on se_dp. Field introduced in 30.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32

non_rt_metrics_entities

Optional

Total number of non-real-time metrics objects. Field introduced in 21.1.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32

non_rt_metrics_timer_interval

Optional

Period in milliseconds at which non-real-time metrics is collected. Field introduced in 21.1.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint64 As uint64

num_dos_msgs_sent

Optional

Cumulative count of dos messages sent to metrics-mgr across all targets. Field introduced in 22.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint64 As uint64

num_metrics_msgs_sent

Optional

Cumulative count of metrics messages sent to metrics-mgr across all targets. Field introduced in 22.1.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32

rt_met_batch_size

Optional

Number of rt-metrics objects processed by se_dp in one timer interval. Field introduced in 30.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

boolean

rt_met_update_timer_running

Optional

Flag to indicate if rt-metrics update timer is running on se_dp. Field introduced in 30.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32

rt_metrics_entities

Optional

Total number of real-time metrics objects. Field introduced in 21.1.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32

rt_metrics_timer_interval

Optional

Period in milliseconds at which real-time metrics is collected. Field introduced in 21.1.3. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32

se_met_msgs_read

Optional

Total number of SE-metrics messages read from shm. Field introduced in 30.2.1. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

integer As uint32 As uint32

total_entities

Optional

Total number of metrics objects. Allowed with any value in Enterprise, Essentials, Basic, Enterprise with Cloud Services edition.

401

Hide Details

log in failed

Operation doesn't return any data structure

404

Hide Details

object not found

Operation doesn't return any data structure

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/api/serviceengine/{uuid}/metrics
                

On This Page

Description

Request

Path Parameters

Header Parameters

Authentication

Response

200 Response Body

Errors

Service Engine Operations

GET

GET /serviceengine

GET

GET /serviceengine/{uuid}

PUT

PUT /serviceengine/{uuid}

PATCH

PATCH /serviceengine/{uuid}

DELETE

DELETE /serviceengine/{uuid}

POST

POST /serviceengine/{uuid}/reboot

POST

POST /serviceengine/{uuid}/forcedelete

POST

POST /serviceengine/{uuid}/switchover

POST

POST /serviceengine/clear

GET

GET /serviceengine/{uuid}/runtime/

GET

GET /serviceengine/{uuid}/runtime/detail/

GET

GET /serviceengine/{uuid}/internal/

GET

GET /serviceengine/{uuid}/ipstat/

GET

GET /serviceengine/{uuid}/arpstat/

GET

GET /serviceengine/{uuid}/icmpstat/

GET

GET /serviceengine/{uuid}/mbufstats/

GET

GET /serviceengine/{uuid}/mallocstats/

GET

GET /serviceengine/{uuid}/shmallocstats/

GET

GET /serviceengine/{uuid}/seassertstats/dp/

GET

GET /serviceengine/{uuid}/seassertstats/ag/

GET

GET /serviceengine/{uuid}/sevshbstats/

GET

GET /serviceengine/{uuid}/sevssplacement/

GET

GET /serviceengine/{uuid}/cpu/

GET

GET /serviceengine/{uuid}/cpu/detail/

GET

GET /serviceengine/{uuid}/meminfo/

GET

GET /serviceengine/{uuid}/interface/

GET

GET /serviceengine/{uuid}/systeminfo/

GET

GET /serviceengine/{uuid}/hugepageinfo/

GET

GET /serviceengine/{uuid}/bgp/

GET

GET /serviceengine/{uuid}/bgp/debug/

GET

GET /serviceengine/{uuid}/bgp/advertised_routes/

GET

GET /serviceengine/{uuid}/bgp/peer_status/

GET

GET /serviceengine/{uuid}/bgp/peer_info/

GET

GET /serviceengine/{uuid}/bgp/running_config/

GET

GET /serviceengine/{uuid}/bgp/peer_state/

GET

GET /serviceengine/{uuid}/bfd/running_config/

GET

GET /serviceengine/{uuid}/bfd/session_status/

GET

GET /serviceengine/{uuid}/interfacesummary/

GET

GET /serviceengine/{uuid}/interface/lacp/

GET

GET /serviceengine/{uuid}/lldp/

GET

GET /serviceengine/{uuid}/route/

GET

GET /serviceengine/{uuid}/ip6route/

GET

GET /serviceengine/{uuid}/arptable/

GET

GET /serviceengine/{uuid}/httpstats/

GET

GET /serviceengine/{uuid}/seruminsertionstats/

GET

GET /serviceengine/{uuid}/selogstats/

GET

GET /serviceengine/{uuid}/seauthstats/

GET

GET /serviceengine/{uuid}/vnicdb/

GET

GET /serviceengine/{uuid}/vnicdbhistory/

GET

GET /serviceengine/{uuid}/graphdb/

GET

GET /serviceengine/{uuid}/seagent/

GET

GET /serviceengine/{uuid}/resourcemap/

GET

GET /serviceengine/{uuid}/consistenthash/

GET

GET /serviceengine/{uuid}/appmap/

GET

GET /serviceengine/{uuid}/shardclientevents/

GET

GET /serviceengine/{uuid}/qatinfo/

GET

GET /serviceengine/{uuid}/rteringstat/

GET

GET /serviceengine/{uuid}/sehmprobedisable/

GET

GET /serviceengine/{uuid}/flowtablestat/

GET

GET /serviceengine/{uuid}/flowtable/

GET

GET /serviceengine/{uuid}/vshash/

GET

GET /serviceengine/{uuid}/flowtable_remote/

GET

GET /serviceengine/{uuid}/tcp-flows/

GET

GET /serviceengine/{uuid}/sctp-flows/

GET

GET /serviceengine/{uuid}/tcp-flows/detail/

GET

GET /serviceengine/{uuid}/sctp-flows/detail/

GET

GET /serviceengine/{uuid}/metrics/

GET

GET /serviceengine/{uuid}/metrics/detail/

GET

GET /serviceengine/{uuid}/metrics/debug/

GET

GET /serviceengine/{uuid}/metrics/debug/summary/

GET

GET /serviceengine/{uuid}/dosstat/

GET

GET /serviceengine/{uuid}/memdist/

POST

POST /serviceengine/{uuid}/faultinject/exhaust_mbuf/clear

POST

POST /serviceengine/{uuid}/faultinject/exhaust_mcl/clear

POST

POST /serviceengine/{uuid}/faultinject/exhaust_mcl_small/clear

POST

POST /serviceengine/{uuid}/faultinject/exhaust_conn/clear

POST

POST /serviceengine/{uuid}/faultinject/exhaust_shm_conn/clear

POST

POST /serviceengine/{uuid}/faultinject/exhaust_cfg/clear

POST

POST /serviceengine/{uuid}/faultinject/exhaust_shm_cfg/clear

POST

POST /serviceengine/{uuid}/faultinject/sefault/clear

GET

GET /serviceengine/{uuid}/placement/

GET

GET /serviceengine/{uuid}/reservedvs/

GET

GET /serviceengine/{uuid}/microservice/

GET

GET /serviceengine/{uuid}/ndtable/

GET

GET /serviceengine/{uuid}/ip6stat/

GET

GET /serviceengine/{uuid}/icmp6stat/

GET

GET /serviceengine/{uuid}/natstat/

GET

GET /serviceengine/{uuid}/nat-flows/

GET

GET /serviceengine/{uuid}/network-service/

GET

GET /serviceengine/{uuid}/natpolicystats/

GET

GET /serviceengine/{uuid}/vrf-ip-info/

GET

GET /serviceengine/{uuid}/ratelimiting/rl/internal/

GET

GET /serviceengine/{uuid}/ratelimiting/msf/internal/

GET

GET /serviceengine/{uuid}/routestat/

GET

GET /serviceengine/{uuid}/route-flows/

GET

GET /serviceengine/{uuid}/objsync/

GET

GET /serviceengine/{uuid}/resolverdb/

GET

GET /serviceengine/{uuid}/resolverdbsummary/

GET

GET /serviceengine/{uuid}/seagent_sedatastore_download_fail_obj_list/

GET

GET /serviceengine/{uuid}/botuacacheruntime/

GET

GET /serviceengine/{uuid}/botuacachestatsruntime/

GET

GET /serviceengine/{uuid}/placement/summary/

GET

GET /serviceengine/{uuid}/placement/detail/

GET

GET /serviceengine/{uuid}/adaptiveevents/

GET

GET /serviceengine/{uuid}/dpmetrics/

GET

GET /serviceengine/{uuid}/objsync_stats/

GET

GET /serviceengine/{uuid}/diameter/connections/

GET

GET /serviceengine/{uuid}/dump_objsync_stats/

GET

GET /serviceengine/{uuid}/qatstats/

GET

GET /serviceengine/{uuid}/flowtablestat6/

GET

GET /serviceengine/{uuid}/selogagentstats/

GET

GET /serviceengine/{uuid}/selogagentoperstats/

GET

GET /serviceengine/{uuid}/selogagentcontrollerinterfacestats/

GET

GET /serviceengine/{uuid}/selogagentnetworkstreamstats/

GET

GET /serviceengine/{uuid}/sessionkeyforwarderstats/

GET

GET /serviceengine/{uuid}/sessionkeyforwarderstats/details/

GET

GET /serviceengine/{uuid}/nicinfo/