NSX-T Data Center REST API

Get Service-Instance status for Service.

Returns status of one instance of a deployed partner service using service insertion framework.
By default this API would return cached status. Caching happens every 3 minutes.
For realtime status, query parameter "source=realtime" needs to be passed.

Request:

Method:
GET
URI Path(s):
/api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/status
Request Headers:
n/a
Query Parameters:
DataSourceParameters+
Request Body:
n/a

Example Request:

GET https://<nsx-mgr>/api/v1/serviceinsertion/services/65a60890-6f48-418d-a7d5-5aaf65fc4e5b/service-instances/79b29ea5-051a-4ab2-af85-fb6520a9f881/status?source=realtime

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
ServiceInstanceStatus+

Example Response:

{ "instance_deployment_status": { "deployment_status": "DEPLOYMENT_SUCCESSFUL" }, "instance_health_status": { "is_sva_mux_incompatible": false, "connect_timestamp": "169882258", "solution_status": "UP", "mux_incompatible_version": "", "mux_connected_status": "CONNECTED", "solution_version": "1.5.3" } }

Required Permissions:

read

Feature:

service_insertion_deployment

Additional Errors: