NSX-T Data Center REST API

List all InstanceEndpoints of a Service Instance.

List all InstanceEndpoints of a service instance.

Request:

Method:

GET

URI Path(s):

/api/v1/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}/instance-endpoints

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

InstanceEndpointListResult+

InstanceEndpointListResult (schema)

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	Instance End Point list List of instance endpoints.	array of InstanceEndpoint	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": "InstanceEndpoint", "id": "01dfa028-bc90-4be4-bda1-a98b4eb65856", "display_name": "Appliance 1 Endpoint 1", "service_attachment_id": "bbb60890-6f48-418d-a7d5-5aaf65fc4e5b", "service_instance_id": "79b29ea5-051a-4ab2-af85-fb6520a9f881", "endpoint_type": "LOGICAL", "target_ips": [ { "ip_addresses": [ "192.168.100.2" ], "prefix_length": 24 } ] } ] }

Required Permissions:

read

Feature:

service_insertion_config

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable