NSX-T Data Center REST API

Returns information about a particular cloud native service instance by external-id.

Returns information about a particular cloud native service instance
by external-id.

Request:

Method:

GET

URI Path(s):

/api/v1/fabric/cloud-native-service-instances/{external-id}

Request Headers:

n/a

Query Parameters:

n/a

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:

CloudNativeServiceInstance+

CloudNativeServiceInstance (schema)

Name	Description	Type	Notes
_last_sync_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_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
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
external_id	External id of cloud native service instance in the system. Id of service instance fetched from public cloud.	string	Required Readonly
resource_type	Must be set to the value CloudNativeServiceInstance	string	Required
scope	List of scopes for discovered resource Specifies list of scope of discovered resource. e.g. if VHC path is associated with principal identity, who owns the discovered resource, then scope id will be VHC path and scope type will be VHC.	array of DiscoveredResourceScope
service_type	Type of cloud native service; possible values are ELB, RDS Type of cloud native service.	string	Required Readonly
source	Reference of the public cloud gateway Reference of the public cloud gateway that reported the service instance.	ResourceReference	Required Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "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:

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