GET /serviceengine/{uuid}/meminfo/

/serviceengine/{uuid}/meminfo/

Request

URI

GET

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

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 MeminfoRuntime of type(s) application/json

{
    "hugepage_memory_stats": {
        "hugepage_size_mb": 0,
        "se_hugepages_reserved": 0,
        "se_qat_hugepages_allocated": 0,
        "se_qat_hugepages_reserved": 0,
        "socket_usage": [
            {
                "alloc_count": 0,
                "free_count": 0,
                "greatest_free_size": 0,
                "heap_alloc_bytes": 0,
                "heap_free_bytes": 0,
                "heap_mbufs_alloc_bytes": 0,
                "heap_total_bytes": 0,
                "socket_id": 0
            }
        ],
        "system_hugepages_allocated": 0,
        "system_hugepages_free": 0
    },
    "memory_config": {
        "chunk_size": 0,
        "number_of_arenas": 0,
        "number_of_CPUs": 0,
        "page_size": 0,
        "pointer_size": 0,
        "quantum_size": 0
    },
    "memory_usage": {
        "config_below_soft_limit": false,
        "heap_additional_config_mem": 0,
        "heap_config_hard_limit": 0,
        "heap_config_memory_status": "string",
        "heap_config_soft_limit": 0,
        "heap_config_usage": 0,
        "heap_conn_usage": 0,
        "heap_memory_summary": "string",
        "heap_min_conn_mem": 0,
        "heap_min_req_config": 0,
        "shared_memory_summary": "string",
        "shm_additional_config_mem": 0,
        "shm_config_hard_limit": 0,
        "shm_config_memory_status": "string",
        "shm_config_soft_limit": 0,
        "shm_config_usage": 0,
        "shm_conn_usage": 0,
        "shm_min_conn_mem": 0,
        "shm_min_req_config": 0,
        "shm_total_memory_usage": 0
    },
    "proc_id": "string",
    "process_memory_stats": {
        "bytes_allocated": 0,
        "bytes_free": 0,
        "bytes_mapped": 0
    },
    "protobuf_memory_stats": {
        "current_usage": 0,
        "max_mem_usage": 0,
        "memory_mapped": 0
    },
    "se_uuid": "string",
    "shared_memory_stats": {
        "alloc_count": 0,
        "bytes_active": 0,
        "bytes_allocated": 0,
        "bytes_allocated_huge": 0,
        "bytes_allocated_large": 0,
        "bytes_allocated_small": 0,
        "bytes_mapped": 0,
        "defrags": 0,
        "large": {
            "bytes_allocated": 0,
            "number_of_dallocs": 0,
            "number_of_mallocs": 0,
            "number_of_requests": 0
        },
        "overhead_percent": "number",
        "page_stats": {
            "madvise": 0,
            "page_active": 0,
            "page_dirty": 0,
            "purged": 0,
            "sweep": 0
        },
        "small": {
            "bytes_allocated": 0,
            "number_of_dallocs": 0,
            "number_of_mallocs": 0,
            "number_of_requests": 0
        },
        "total": {
            "bytes_allocated": 0,
            "number_of_dallocs": 0,
            "number_of_mallocs": 0,
            "number_of_requests": 0
        },
        "utilization_percent": "number"
    }
}

object

hugepage_memory_stats

Optional

hugepage_memory_stats

object

memory_config

Optional

memory_config

object

memory_usage

Optional

memory_usage

string

proc_id

Optional

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

object

process_memory_stats

Optional

process_memory_stats

object

protobuf_memory_stats

Optional

protobuf_memory_stats

string

se_uuid

Optional

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

object

shared_memory_stats

Optional

shared_memory_stats

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/serviceengine/{uuid}/meminfo

On This Page

Description

Request

Path Parameters

Header Parameters

Authentication

Response

200 Response Body

Errors

Service Engine Operations