Get all Service-Instances present in system

Returns all Service-Instance(s) of all Services present in system.
When request parameter (deployed_to or service_deployment_id) is provided as a part of request,
it will filter out Service-Instances accordingly.

Request:

Method:

GET

URI Path(s):

/api/v1/serviceinsertion/service-instances

Request Headers:

n/a

Query Parameters:

ServiceInstanceQueryParameters+

Name	Description	Type	Notes
deployed_to	Deployed_to referenced by service instances present in system The deployed_to attribute in Service Instance. Currently only Logical Router id is supported as deployed_to value. Single value is supported in current release.	string
service_deployment_id	Service Deployment Id using which the instances were deployed Service Deployment Id using which the instances were deployed. Single value is supported in current release.	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/serviceinsertion/service-instances?deployed_to=ea9ae885-d3ec-4acc-8194-d5d96dc569cd

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ServiceInstanceListResult+

Name	Description	Type	Notes
_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
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Service-Instance list List of the Service-Insertion ServicesInstances. The list has to be homogenous.	array of BaseServiceInstance (Abstract type: pass one of the following concrete types) ByodServiceInstance ServiceInstance VirtualServiceInstance	Required Readonly
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "result_count": 1, "results": [{ "resource_type": "ServiceInstance", "description": "This Service Instance is deployed at T0 router", "id": "79b29ea5-051a-4ab2-af85-fb6520a9f881", "display_name": "NS Service_Instance_for_ABC", "attachment_point": "TIER0_LR", "deployed_to": [{ "is_valid": true, "target_display_name": "Active-LR", "target_id": "ea9ae885-d3ec-4acc-8194-d5d96dc569cd", "target_type": "LogicalRouter" }], "deployment_mode": "STAND_ALONE", "deployment_spec_name": "NS_DepSpec", "implementation_type": "NORTH_SOUTH", "instance_deployment_config": { "compute_id": "domain-c8", "context_id": "44a18335-e72d-4c77-a0b1-7a922c5e086c", "storage_id": "datastore-12", "vm_nic_infos": [{ "nic_infos": [{ "ip_address": "10.33.79.64", "gateway_address": "10.33.79.66", "subnet_mask": "255.255.255.252", "network_id": "network-16", "nic_metadata": { "interface_label": "eth", "interface_index": 0, "interface_type": "MANAGEMENT" } }, { "nic_metadata": { "interface_label": "eth", "interface_index": 1, "interface_type": "DATA1" } }, { "nic_metadata": { "interface_label": "eth", "interface_index": 2, "interface_type": "DATA2" } } ] }] }, "on_failure_policy": "ALLOW", "service_id": "aaaaaaaa-d7dc-4b62-94ef-3a02bb2bf2c0", "transport_type": "L2_BRIDGE", "instance_deployment_template": { "name": "NS_DepTemp", "attributes": [{ "attribute_type": "STRING", "display_name": "License", "key": "ABC_HA_License", "value": "eiou14345u897lihs23!" }] }, "_create_user": "admin", "_create_time": 1525889020946, "_last_modified_user": "admin", "_last_modified_time": 1525889125046, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 1 }] }

Get all Service-Instances present in system

Request:

ServiceInstanceQueryParameters (schema)

Example Request:

Successful Response:

ServiceInstanceListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: