NSX-T Data Center REST API

Get Service-Instance state for Service.

Returns configuration state of one instance of a deployed partner service using service insertion framework.

Request:

Method:
GET
URI Path(s):
/api/v1/serviceinsertion/services/<service-id>/service-instances/<service-instance-id>/state
Request Headers:
n/a
Query Parameters:
n/a
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/state

Successful Response:

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

Example Response:

{ "details": [ { "sub_system_id": "79b29ea5-051a-4ab2-af85-fb6520a9f881", "sub_system_type": "ServiceInstanceId", "failure_message": "VM powered off. Agent VM is expected to be powered on. \nCause : XXX uninitialized", "failure_code": 31622 } ] }

Required Permissions:

read

Feature:

service_insertion_deployment

Additional Errors: