Add an InstanceEndpoint for a Service Instance

Adds a new instance endpoint. It belongs to one service instance and is attached
to one service attachment. It represents a redirection target for a Rule.

Request:

Method:

POST

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:

InstanceEndpoint+

InstanceEndpoint (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	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
endpoint_type	Instance Endpoint Type LOGICAL - It must be created with a ServiceAttachment and identifies a destination connected to the Service Port of the ServiceAttachment, through the ServiceAttachment's Logical Switch. VIRTUAL - It represents a L3 destination the router can route to but does not provide any further information about its location in the network. Virtual InstanceEndpoints are used for redirection targets that are not connected to Service Ports, such as the next-hop routers on the Edge uplinks.	string	Enum: LOGICAL, VIRTUAL Default: "LOGICAL"
id	Unique identifier of this resource	string	Sortable
link_ids	Link Id list Link Ids are mandatory for VIRTUAL Instance Endpoint. Even though VIRTUAL, the Instance Endpoint should be connected/accessible through an NSX object. The link id is this NSX object id. Example - For North-South Service Insertion, this is the LogicalRouter Id through which the targetIp/L3 destination accessible.	array of ResourceReference	Minimum items: 1 Maximum items: 1
resource_type	Must be set to the value InstanceEndpoint	string
service_attachments	Service Attachment list Id(s) of the Service Attachment where this enndpoint is connected to. Service Attachment is mandatory for LOGICAL Instance Endpoint.	array of ResourceReference	Minimum items: 1 Maximum items: 1
service_instance_id	Service instance Id The Service instancee with which the instance endpoint is associated.	string	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
target_ips	Target IPs Target IPs on an interface of the Service Instance.	array of IPInfo	Required Minimum items: 1 Maximum items: 1

Example Request:

POST https://<nsx-mgr>/api/v1/services/65a60890-6f48-418d-a7d5-5aaf65fc4e5b/service-instances/79b29ea5-051a-4ab2-af85-fb6520a9f881/instance-endpoints { "service_attachment_id": "bbb60890-6f48-418d-a7d5-5aaf65fc4e5b", "endpoint_type": "LOGICAL", "display_name": "Appliance 1 Endpoint 1", "target_ips": [ { "ip_addresses": [ "192.168.100.2" ], "prefix_length": 24 } ] }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

InstanceEndpoint+

InstanceEndpoint (schema)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_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
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	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
endpoint_type	Instance Endpoint Type LOGICAL - It must be created with a ServiceAttachment and identifies a destination connected to the Service Port of the ServiceAttachment, through the ServiceAttachment's Logical Switch. VIRTUAL - It represents a L3 destination the router can route to but does not provide any further information about its location in the network. Virtual InstanceEndpoints are used for redirection targets that are not connected to Service Ports, such as the next-hop routers on the Edge uplinks.	string	Enum: LOGICAL, VIRTUAL Default: "LOGICAL"
id	Unique identifier of this resource	string	Sortable
link_ids	Link Id list Link Ids are mandatory for VIRTUAL Instance Endpoint. Even though VIRTUAL, the Instance Endpoint should be connected/accessible through an NSX object. The link id is this NSX object id. Example - For North-South Service Insertion, this is the LogicalRouter Id through which the targetIp/L3 destination accessible.	array of ResourceReference	Minimum items: 1 Maximum items: 1
resource_type	Must be set to the value InstanceEndpoint	string
service_attachments	Service Attachment list Id(s) of the Service Attachment where this enndpoint is connected to. Service Attachment is mandatory for LOGICAL Instance Endpoint.	array of ResourceReference	Minimum items: 1 Maximum items: 1
service_instance_id	Service instance Id The Service instancee with which the instance endpoint is associated.	string	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
target_ips	Target IPs Target IPs on an interface of the Service Instance.	array of IPInfo	Required Minimum items: 1 Maximum items: 1

Example Response:

{ "resource_type": "InstanceEndpoint", "id": "01dfa028-bc90-4be4-bda1-a98b4eb65856", "service_attachment_id": "bbb60890-6f48-418d-a7d5-5aaf65fc4e5b", "service_instance_id": "79b29ea5-051a-4ab2-af85-fb6520a9f881", "display_name": "Appliance 1 Endpoint 1", "endpoint_type": "LOGICAL", "target_ips": [ { "ip_addresses": [ "192.168.100.2" ], "prefix_length": 24 } ] }

Add an InstanceEndpoint for a Service Instance

Request:

InstanceEndpoint (schema)

Example Request:

Successful Response:

InstanceEndpoint (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: