Get operational status for an interface

Returns operational status of a specified interface

Request:

Method:

GET

URI Path(s):

/api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/instance-runtimes/<instance-runtime-id>/interfaces/<interface_index>/status

Request Headers:

n/a

Query Parameters:

DataSourceParameters+

Name	Description	Type	Notes
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/serviceinsertion/services/564dab50-63a0-8b4f-a1f8-20e4d36efc3b/service-instances/564dab50-63a0-8b4f-a1f8-20e4d36efc3c/instance-runtimes/564dab50-63a0-8b4f-a1f8-20e4d36efc3d/interfaces/1/status

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

RuntimeInterfaceOperationalStatus+

Name	Description	Type	Notes
interface_index	Index of the interface	integer	Required Readonly
last_update_timestamp	Timestamp when the data was last updated; unset if data source has never updated the data.	EpochMsTimestamp	Readonly
status	The Operational status of the interface	string	Required Enum: UP, DOWN, UNKNOWN

Example Response:

{ "interface_index": 1, "last_update_timestamp": 1453764613211, "status": "UP" }

Required Permissions:

read

Feature:

service_insertion

Additional Errors:

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