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+

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/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+

Name	Description	Type	Notes
configuration_issue	Collection of configuration issues during service instance deployment This object contains the list of issues which might come during post deployment configuration for a particular service instance.	SVMConfigureIssue	Readonly
instance_deployment_status	Deployment status of a Service Instance Deployment status of NXGI Partner Service-VM.	ServiceDeploymentStatus	Readonly
instance_health_status	Health status of a Service Instance Health status of NXGI components on Partner Service-VM.	ServiceInstanceHealthStatus	Readonly
service_instance_id	Service instance id Id of an instantiation of a registered service.	string	Readonly

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" } }

Get Service-Instance status for Service.

Request:

DataSourceParameters (schema)

Example Request:

Successful Response:

ServiceInstanceStatus (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: