NSX-T Data Center Global Manager REST API

Read traceflow status

Read traceflow status with id traceflow-id.
Traceflow configuration will be cleaned up by the system after
two hours of inactivity.
Enforcement point path is not required for Federation setup.

Request:

Method:

GET

URI Path(s):

/global-manager/api/v1/global-infra/traceflows/<traceflow-id>/status

Request Headers:

n/a

Query Parameters:

TraceflowStatusRequest+

TraceflowStatusRequest (schema)

Name	Description	Type	Notes
enforcement_point_path	Enforcement point path Policy path of enforcement point on which traceflow session was created.	string

Request Body:

n/a

Example Request:

https://<policy-mgr>/global-manager/api/v1/global-infra/traceflows/t1/status?enforcement_point_path=/global-infra/sites/default/enforcement-points/default

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

Traceflow+

Traceflow (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
analysis	Traceflow result analysis notes	array of string	Readonly
counters	observation counters	TraceflowObservationCounters	Readonly
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
id	The id of the traceflow round	string	Required Readonly
logical_counters	counters of observations from logical components	TraceflowObservationCounters	Readonly
lport_id	id of the source logical port used for injecting the traceflow packet	string	Readonly
operation_state	Represents the traceflow operation state	string	Required Readonly Enum: IN_PROGRESS, FINISHED, FAILED
request_status	Traceflow request status The status of the traceflow RPC request. SUCCESS - The traceflow request is sent successfully. TIMEOUT - The traceflow request gets timeout. SOURCE_PORT_NOT_FOUND - The source port of the request cannot be found. DATA_PATH_NOT_READY - The datapath component cannot be ready to receive request. CONNECTION_ERROR - There is connection error on datapath component. UNKNOWN - The status of traceflow request cannot be determined.	string	Readonly Enum: SUCCESS, TIMEOUT, SOURCE_PORT_NOT_FOUND, DATA_PATH_NOT_READY, CONNECTION_ERROR, UNKNOWN
resource_type	Must be set to the value Traceflow	string
result_overflowed	A flag, when set true, indicates some observations were deleted from the result set.	boolean	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
timeout	Timeout (in ms) for traceflow observations result list Maximum time (in ms) the management plane will be waiting for this traceflow round. Upper limit for federation case is 90000, for non-federation case is 15000, the maximum is set to 90000 as the higher of the two cases.	integer	Readonly Minimum: 5000 Maximum: 90000

Example Response:

{ "id": "/infra/traceflows/t1", "lport_id": "/infra/tier-1s/production_t1/segments/production-t1-seg/ports/default:13405ded-e4f7-4776-b0fe-16d0ba685f6c", "timeout": 10, "operation_state": "FINISHED", "result_overflowed": false, "counters": { "received_count": 1, "delivered_count": 0, "dropped_count": 0, "forwarded_count": 0 }, "logical_counters": { "received_count": 0, "delivered_count": 0, "dropped_count": 0, "forwarded_count": 0 }, "analysis": [], "request_status": "SUCCESS", "_protection": "NOT_PROTECTED" }

Required Permissions:

read

Feature:

policy_traceflow

Additional Errors:

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