Get Packet List Information

This API returns the status of the packet list capture for a specific or group of packet lists, by test or by user. It is relevant for the tests currently running and for past runs. It returns the IDs as long as the packet lists are present on the local disk. Note that by default, if packet lists are present in the .ntxx file then they are being captured.

Capture status can be:

  • CAPTURING
  • NOT_CAPTURING
  • NOT_AVAILABLE (offline)

Request

JSON

Provides packet list information for all packet lists in all running tests.

URL http://ip:port/shunra/api/trafficresource/packetlist/capture
HTTP Method GET
HTTP Headers

Content-Type: application/json

Accept: application/json

Authorization: See Web Services Authentication.

Body None

Provides packet list information for all packet lists in a specific test.

URL http://ip:port/shunra/api/trafficresource/packetlist/capture/{testToken}
HTTP Method GET
HTTP Headers

Content-Type: application/json

Accept: application/json

Authorization: See Web Services Authentication.

Body None

Provides packet list information for a specifc packet list in a specific test.

URL http://ip:port/shunra/api/trafficresource/packetlist/capture/{testToken}/{plid}
HTTP Method GET
HTTP Headers

Content-Type: application/json

Accept: application/json

Authorization: See Web Services Authentication.

Body None

XML

Provides packet list information for all packet lists in all running tests.

URL http://ip:port/shunra/api/trafficresource/packetlist/capture
HTTP Method GET
HTTP Headers

Content-Type: application/xml

Accept: application/xml

Authorization: See Web Services Authentication.

Body None

Provides packet list information for all packet lists in a specific test.

URL http://ip:port/shunra/api/trafficresource/packetlist/capture/{testToken}
HTTP Method GET
HTTP Headers

Content-Type: application/xml

Accept: application/xml

Authorization: See Web Services Authentication.

Body None

Provides packet list information for a specific packet list in a specific test.

URL http://ip:port/shunra/api/trafficresource/packetlist/capture/{testToken}/{plid}
HTTP Method GET
HTTP Headers

Content-Type: application/xml

Accept: application/xml

Authorization: See Web Services Authentication.

Body None

Response

JSON

HTTP Response Code 200 - OK
HTTP Headers Content-Type: application/json; charset=UTF-8
HTTP Body
{
    "packetListsInfo": [{
        "flowId": "FLOWS_4",
        "plId": "ID_PACKET_LIST_CLIENT_FLOWS_4",
        "captureStatus": "CAPTURING"
    }, {
        "flowId": "FLOWS_5",
        "plId": "ID_PACKET_LIST_CLIENT_FLOWS_5",
        "captureStatus": "CAPTURING"
    }, {
        "flowId": "FLOWS_6",
        "plId": "ID_PACKET_LIST_CLIENT_FLOWS_6",
        "captureStatus": "CAPTURING"
    }, {
        "flowId": "FLOWS_10",
        "plId": "ID_PACKET_LIST_CLIENT_FLOWS_10",
        "captureStatus": "CAPTURING"
    }, {
        "flowId": "FLOWS_7",
        "plId": "ID_PACKET_LIST_CLIENT_FLOWS_7",
        "captureStatus": "CAPTURING"
    }, {
        "flowId": "FLOWS_30",
        "plId": "ID_PACKET_LIST_CLIENT_FLOWS_30",
        "captureStatus": "CAPTURING"
    }, {
        "flowId": "FLOWS_1",
        "plId": "ID_PACKET_LIST_CLIENT_FLOWS_1",
        "captureStatus": "CAPTURING"
    },
    globalCaptureStatus" : "CAPTURING "
}

XML

HTTP Response Code 200 - OK
HTTP Headers Content-Type: application/xml; charset=UTF-8
HTTP Body
<packetListInfoResponse>
    <packetListsInfo>
        <flowId>
            FLOWS_4
        </flowId>
        <plId>
            ID_PACKET_LIST_CLIENT_FLOWS_4
        </plId>
        <captureStatus>
            CAPTURING
        </captureStatus>
    </packetListsInfo>
    <packetListsInfo>
        <flowId>
            FLOWS_5
        </flowId>
        <plId>ID_PACKET_LIST_CLIENT_FLOWS_5
        </plId>
        <captureStatus>CAPTURING
        </captureStatus>
    </packetListsInfo>
    <packetListsInfo>
        <flowId>
            FLOWS_15
        </flowId>
        <plId>
            ID_PACKET_LIST_CLIENT_FLOWS_15
        </plId>
        <captureStatus>
            CAPTURING
        </captureStatus>
    </packetListsInfo>
    <globalCaptureStatus>
        CAPTURING
    </globalCaptureStatus>
</packetListInfoResponse>