GET /qni/stacking/stacks/{stack_id}

Retrieve a QNI stack by ID.

Table 1. GET /qni/stacking/stacks/{stack_id} resource details
MIME Type
application/json

Table 2. GET /qni/stacking/stacks/{stack_id} request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
stack_id	path	Required	Number (Integer)	text/plain	null
fields	query	Optional	String	text/plain	Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

Table 3. GET /qni/stacking/stacks/{stack_id} response codes
HTTP Response Code	Unique Code	Description
200		The requested QNI stack has been retrieved.
404	1002	The stack ID is not found.
500	1020	An error occurred attempting to retrieve QNI stack.

Response Description

QNI stack. A stack contains the following fields:

stack_id - Long - ID of the QNI stack.
hosts - List<Host> - List of QNI managed hosts in the stack.
name - String - Name of the QNI stack..
ports_type - enum - Port configuration type for the QNI stack.
inspection_level - Optional - Enumeration - Depth of content inspection. The possible values are:
- BASIC - Lowest level of inspection. Flows are detected by 5-tuple, and the number of bytes and packets that are flowing in each direction are counted.
- ENRICHED - Each flow is identified and inspected by one of the protocol or domain inspectors, and many kinds of attributes can be generated from that inspection.
- ADVANCED - The highest level of inspection. It does everything that the Enriched Flows levels does, but it also scans and inspects the content of the files that it finds.
- DEFAULT - indicates that QNI host is set to use globally set inspection level setting.
raw_payload - Optional - Long - The maximum amount (Bytes) of data the QFlow Collector is set to capture and retain in the flow payload. Possible values are:
- -1: QNI host is set to use globally set raw payload setting
- 0: Turn off payload
- 1 - 32768: Number of Bytes

Response Sample


{
    "hosts": [
        {
            "host_id": 42,
            "host_ip": "String",
            "primary": true
        }
    ],
    "inspection_level": "String <one of: BASIC, ADVANCED, ENRICHED, DEFAULT>",
    "name": "String",
    "ports_type": "String <one of: IN_4, IN_2_OUT_2, IN_1_OUT_1, IN_1_OUT_3, IN_3_OUT_1>",
    "raw_payload": 42,
    "stack_id": 42
}