NSX-T Data Center REST API

Get observations for the Traceflow round (Deprecated)

Request:

Method:

GET

URI Path(s):

/api/v1/traceflows/<traceflow-id>/observations

Request Headers:

n/a

Query Parameters:

TraceflowObservationListParameters+

TraceflowObservationListParameters (schema)

Name	Description	Type	Notes
component_name	Observations having the given component name will be listed. Observations of all component names will be listed if not given.	string
component_type	Observations having the given component type will be listed. Observations of all component types will be listed if not given.	TraceflowComponentType
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
resource_type	The type of observations that will be listed. Prefix matching; e.g. TraceflowObservationReceived will also matches TraceflowObservationReceivedLogical. Observations of all types will be listed if not given.	TraceflowObservationType
sort_ascending		boolean
sort_by	Field by which records are sorted	string
transport_node_name	Observations having the given transport node name will be listed. Observations of all transport node names will be listed if not given.	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1traceflows/4899e762-d8d4-4445-ab34-85dd80d9d042/observations

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

TraceflowObservationListResult+

TraceflowObservationListResult (schema)

Name	Description	Type	Notes
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	TraceflowObservation list results	array of TraceflowObservation (Abstract type: pass one of the following concrete types) PolicyTraceflowObservationDelivered PolicyTraceflowObservationDropped PolicyTraceflowObservationDroppedLogical PolicyTraceflowObservationForwardedLogical PolicyTraceflowObservationReceivedLogical PolicyTraceflowObservationRelayedLogical TraceflowObservationDelivered TraceflowObservationDropped TraceflowObservationDroppedLogical TraceflowObservationForwarded TraceflowObservationForwardedLogical TraceflowObservationReceived TraceflowObservationReceivedLogical TraceflowObservationRelayedLogical TraceflowObservationReplicationLogical
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "cursor": "000217", "sort_ascending": true, "sort_by": "timestamp", "result_count": 17, "results": [ { "component_type": "PHYSICAL", "component_name": "Physical", "resource_type": "TraceflowObservationReceived", "transport_node_id": "ed4d2f98-4373-4d67-9706-5ec3af7fcba1", "sequence_no": 5, "transport_node_name": "node-comp-01b", "timestamp": 1458585011051 }, { "component_type": "LS", "component_name": "app-tier-01", "resource_type": "TraceflowObservationForwardedLogical", "transport_node_id": "ed4d2f98-4373-4d67-9706-5ec3af7fcba1", "sequence_no": 7, "transport_node_name": "node-comp-01b", "timestamp": 1458585011061, "component_id": "5091f6ac-ada1-428c-b521-630bc0d55574" }, { "component_type": "LR", "component_name": "overlay-router", "resource_type": "TraceflowObservationReceivedLogical", "transport_node_id": "ed4d2f98-4373-4d67-9706-5ec3af7fcba1", "sequence_no": 9, "transport_node_name": "node-comp-01b", "timestamp": 1458585011073, "vni": 41866, "component_id": "723c1e3e-c82c-4243-bba0-2e1ef4815143", "lport_id": "87db83ed-9a73-436b-91f1-a2a793ffaa31", "src_component_name": "app-tier-01", "src_component_type": "LS", "src_component_id": "5091f6ac-ada1-428c-b521-630bc0d55574", "lport_name": "app-tier router" }, { "component_type": "DFW", "component_name": "Distributed Firewall", "resource_type": "TraceflowObservationReceivedLogical", "transport_node_id": "ed4d2f98-4373-4d67-9706-5ec3af7fcba1", "sequence_no": 11, "transport_node_name": "node-comp-01b", "timestamp": 1458585011085, "vni": 41866, "lport_id": "dd83f49f-a043-493f-847f-2bc0206afd5f", "lport_name": "dd83f49f-a043-493f-847f-2bc0206afd5f" }, { "component_type": "DFW", "component_name": "Distributed Firewall", "resource_type": "TraceflowObservationForwardedLogical", "transport_node_id": "ed4d2f98-4373-4d67-9706-5ec3af7fcba1", "sequence_no": 13, "transport_node_name": "node-comp-01b", "timestamp": 1458585011097, "vni": 41866, "lport_id": "dd83f49f-a043-493f-847f-2bc0206afd5f", "acl_rule_id": 2, "lport_name": "dd83f49f-a043-493f-847f-2bc0206afd5f" }, { "component_type": "PHYSICAL", "component_name": "Physical", "resource_type": "TraceflowObservationDelivered", "transport_node_id": "ed4d2f98-4373-4d67-9706-5ec3af7fcba1", "sequence_no": 15, "transport_node_name": "node-comp-01b", "timestamp": 1458585011109, "lport_id": "dd83f49f-a043-493f-847f-2bc0206afd5f", "lport_name": "dd83f49f-a043-493f-847f-2bc0206afd5f" }, { "component_type": "PHYSICAL", "component_name": "Physical", "resource_type": "TraceflowObservationReceived", "transport_node_id": "9e2c8d44-6a21-47e4-97a7-e62d6d0ea56f", "sequence_no": 6, "transport_node_name": "node-comp-02b", "timestamp": 1458613715205 }, { "component_type": "DFW", "component_name": "Distributed Firewall", "resource_type": "TraceflowObservationReceivedLogical", "transport_node_id": "9e2c8d44-6a21-47e4-97a7-e62d6d0ea56f", "sequence_no": 8, "transport_node_name": "node-comp-02b", "timestamp": 1458613715216, "vni": 41866, "lport_id": "65b9eb3d-0daa-42fc-a17d-15671d3f4ed3", "lport_name": "65b9eb3d-0daa-42fc-a17d-15671d3f4ed3" }, { "component_type": "DFW", "component_name": "Distributed Firewall", "resource_type": "TraceflowObservationForwardedLogical", "transport_node_id": "9e2c8d44-6a21-47e4-97a7-e62d6d0ea56f", "sequence_no": 10, "transport_node_name": "node-comp-02b", "timestamp": 1458613715228, "vni": 41866, "lport_id": "65b9eb3d-0daa-42fc-a17d-15671d3f4ed3", "acl_rule_id": 2, "lport_name": "65b9eb3d-0daa-42fc-a17d-15671d3f4ed3" }, { "component_type": "LS", "component_name": "app-tier-01", "resource_type": "TraceflowObservationForwardedLogical", "transport_node_id": "9e2c8d44-6a21-47e4-97a7-e62d6d0ea56f", "sequence_no": 12, "transport_node_name": "node-comp-02b", "timestamp": 1458613715240, "component_id": "5091f6ac-ada1-428c-b521-630bc0d55574" }, { "component_type": "LR", "component_name": "overlay-router", "resource_type": "TraceflowObservationReceivedLogical", "transport_node_id": "9e2c8d44-6a21-47e4-97a7-e62d6d0ea56f", "sequence_no": 14, "transport_node_name": "node-comp-02b", "timestamp": 1458613715252, "vni": 41866, "component_id": "723c1e3e-c82c-4243-bba0-2e1ef4815143", "lport_id": "87db83ed-9a73-436b-91f1-a2a793ffaa31", "src_component_name": "app-tier-01", "src_component_type": "LS", "src_component_id": "5091f6ac-ada1-428c-b521-630bc0d55574", "lport_name": "app-tier router" }, { "component_type": "PHYSICAL", "component_name": "Physical", "resource_type": "TraceflowObservationForwarded", "transport_node_id": "9e2c8d44-6a21-47e4-97a7-e62d6d0ea56f", "sequence_no": 16, "transport_node_name": "node-comp-02b", "timestamp": 1458613715264, "remote_ip_address": "192.168.250.100", "context": 4503694159291136 }, { "component_type": "PHYSICAL", "component_name": "Physical", "resource_type": "TraceflowObservationForwarded", "transport_node_id": "9e2c8d44-6a21-47e4-97a7-e62d6d0ea56f", "sequence_no": 17, "transport_node_name": "node-comp-02b", "timestamp": 1458613715276, "remote_ip_address": "192.168.250.102", "context": 4503694159291136 }, { "component_type": "PHYSICAL", "component_name": "Physical", "resource_type": "TraceflowObservationReceived", "transport_node_id": "4fa0d456-627d-4b62-9bfe-585d585dab1a", "sequence_no": 1, "transport_node_name": "node-nsx-edge2", "timestamp": 1458613780641 }, { "component_type": "EDGE_TUNNEL", "component_name": "Edge Tunnel", "resource_type": "TraceflowObservationReceivedLogical", "transport_node_id": "4fa0d456-627d-4b62-9bfe-585d585dab1a", "sequence_no": 2, "transport_node_name": "node-nsx-edge2", "timestamp": 1458613780641, "component_id": "736a80e3-23f6-5a2d-81d6-bbefb2786666", "lport_id": "77958239-5276-56ad-b320-cdf02a3286f1" }, { "component_type": "LR", "component_name": "overlay-router", "resource_type": "TraceflowObservationReceivedLogical", "transport_node_id": "4fa0d456-627d-4b62-9bfe-585d585dab1a", "sequence_no": 3, "transport_node_name": "node-nsx-edge2", "timestamp": 1458613780641, "vni": 41866, "component_id": "723c1e3e-c82c-4243-bba0-2e1ef4815143", "lport_id": "87db83ed-9a73-436b-91f1-a2a793ffaa31", "lport_name": "app-tier router" }, { "component_type": "LR", "component_name": "overlay-router", "resource_type": "TraceflowObservationDroppedLogical", "transport_node_id": "4fa0d456-627d-4b62-9bfe-585d585dab1a", "sequence_no": 4, "transport_node_name": "node-nsx-edge2", "timestamp": 1458613780641, "reason": "UNKNOWN", "lport_id": "87db83ed-9a73-436b-91f1-a2a793ffaa31", "lport_name": "app-tier router", "component_id": "723c1e3e-c82c-4243-bba0-2e1ef4815143" } ] }

Required Permissions:

read

Feature:

tools_traceflow

Additional Errors:

• 404 Not Found
• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable