Returns the List of cloud native service instances

Returns information about all cloud native service instances.

Request:

Method:

GET

URI Path(s):

/api/v1/fabric/cloud-native-service-instances

Request Headers:

n/a

Query Parameters:

CloudNativeServiceInstanceListRequestParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
display_name	Display Name of the cloud native service instance Name of cloud native service instance.	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"
service_type	Type of cloud native service; possible values are ELB, RDS Type of cloud native service.	string
sort_ascending		boolean
sort_by	Field by which records are sorted	string
source	NSX node id of the public cloud gateway that reported the service instance NSX node id of the public cloud gateway that reported the service instance.	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/fabric/cloud-native-service-instances

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

CloudNativeServiceInstanceListResult+

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	CloudNativeServiceInstance list results List of cloud native service instances	array of CloudNativeServiceInstance	Required
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" : [ { "display_name" : "RDS-1", "resource_type" : "CloudNativeServiceInstance", "external_id" : "420e72c9-55e7-a4f7-81bf-673a2af1a6cf", "source" : "55e7-673a2-a4f7-72c9-81bf", "service_type" : "RDS" } ] }

Required Permissions:

read

Feature:

cloud_objects_inventory

Additional Errors:

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