NSX-T Data Center REST API

Returns information about a particular AWS serivce endpoint

Returns information about an AWS serivce endpoint like
service_endpoint_type, status and corresponding cidrs. NSX supported
services are currently limited to Simple Storage Service (S3),
Relational Database Service (RDS), DynamoDB and Elastic Load Balancing.

Request:

Method:

GET

URI Path(s):

/api/v1/csm/aws/vpcs/<vpc-id>/service-endpoints/<service-endpoint-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-csm>/api/v1/csm/aws/vpcs//service-endpoints/

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

AwsServiceEndpoint+

AwsServiceEndpoint (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
cidrs	CIDRs Array of CIDRs associated to an AWS service.	array of string	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
nsx_security_groups	NSX security groups array Stores an array of NSX security groups associated to this cloud service endpoint.	array of SecurityGroup	Readonly
resource_type	Must be set to the value AwsServiceEndpoint	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_endpoint_id	Service Endpoint ID Cloud provided ID of the service endpoint.	string	Readonly
service_endpoint_type	Service Endpoint Type Cloud provided type of the service endpoint.	string	Readonly
service_name	Service Name Name of the cloud service the endpoint is associated with.	string	Readonly
service_type	Service type Stores the type of AWS service corresponding to this endpoint. AWS_RDS - Amazon Relational Database Service AWS_DYNAMODB - Amazon DynamoDB AWS_S3 - Amazon Simple Storage Service AWS_ELB - Amazon Elastic Load Balancer	string	Readonly Enum: AWS_RDS, AWS_DYNAMODB, AWS_S3, AWS_ELB
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Required Permissions:

read

Feature:

cloud_resources

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