List all service paths

List all service paths for the given service chain for the given service chain id

Request:

Method:

GET

URI Path(s):

/api/v1/serviceinsertion/service-chains/<service-chain-id>/service-paths

Request Headers:

n/a

Query Parameters:

ListRequestParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/serviceinsertion/service-chains/4427205b-689d-453e-8644-c6db96f9f53a/service-paths

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ServicePathListResult+

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 Path list List of homogenous service paths	array of ServicePath	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:

{ "results": [ { "forward_path": [ { "unidir_service_path_id": 11, "host_cross_count": 0, "is_active": true, "in_maintenance_mode": false, "hops": [ { "mac_address":"02:50:56:56:44:52", "vif": "f18c629b-1037-4d16-98b3-fdfb5ce8534d", "is_active_from_mp": true, "in_maintenance_mode": false, "is_active_from_dp": true, "is_active_from_ccp": true, "nsh_liveness_support": true, "can_decrement_si": true, "action": "COPY", } ] } ], "reverse_path": [ { "unidir_service_path_id": 12, "host_cross_count": 0, "is_active": true, "in_maintenance_mode": false, "hops": [ { "mac_address":"02:50:56:56:44:52", "vif": "f18c629b-1037-4d16-98b3-fdfb5ce8534d", "is_active_from_mp": true, "in_maintenance_mode": false, "is_active_from_dp": true, "is_active_from_ccp": true, "nsh_liveness_support": true, "can_decrement_si": true, "action": "COPY", } ] } ], "service_path_id": 1001, "service_chain_uuid": "4427205b-689d-453e-8644-c6db96f9f53a", "service_chain_id": 1 } ], "result_count": 1 }

List all service paths

Request:

ListRequestParameters (schema)

Example Request:

Successful Response:

ServicePathListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: