NSX-T Data Center REST API

Get all Service-Instances for Service.

Returns all Service-Instance(s) for a given Service-Insertion Service.

Request:

Method:
GET
URI Path(s):
/api/v1/serviceinsertion/services/{service-id}/service-instances
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

Successful Response:

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

Example Response:

{ "result_count": 3, "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": "0ae2295d-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 }, { "resource_type": "ServiceInstance", "description": "This Service Instance is deployed at T0 router in HA Mode", "display_name": "NS Service_Instance_for_ABC_HA", "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": "ACTIVE_STANDBY", "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" } }, { "ip_address": "11.11.11.1", "nic_metadata": { "interface_label": "eth", "interface_index": 3, "interface_type": "HA1" } }, { "nic_metadata": { "interface_label": "eth", "interface_index": 4, "interface_type": "HA2" } } ] }, { "nic_infos": [{ "ip_address": "10.33.79.65", "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" } }, { "nic_metadata": { "interface_label": "eth", "interface_index": 3, "interface_type": "HA1" } }, { "nic_metadata": { "interface_label": "eth", "interface_index": 4, "interface_type": "HA2" } } ] } ] }, "on_failure_policy": "BLOCK", "service_id": "0ae2295d-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": "adklfjakldfjlkajfkl" }] }, "_create_user": "admin", "_create_time": 1525889017742, "_last_modified_user": "admin", "_last_modified_time": 1525889017742, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }, { "resource_type": "ByodServiceInstance", "id": "8e3df14c-6bda-450e-9570-61c22cfd91ad", "display_name": "NS Service_Instance_for_XYZ", "transport_type": "L3_ROUTED", "service_id": "e7b4cde6-809a-46d1-a13d-a7be93aa022d", "deployment_mode": "STAND_ALONE", "_create_time": 1525209315039, "_last_modified_user": "admin", "_system_owned": false, "_protection": "NOT_PROTECTED", "_last_modified_time": 1525209315039, "_create_user": "admin", "_revision": 0 }] }

Required Permissions:

read

Feature:

service_insertion_config

Additional Errors: