NSX-T Data Center REST API

Get Service-Instance for Service.

Returns Service-Instance information for a given Service-Insertion Service.

Request:

Method:

GET

URI Path(s):

/api/v1/serviceinsertion/services/{service-id}/service-instances/{service-instance-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/serviceinsertion/services/65a60890-6f48-418d-a7d5-5aaf65fc4e5b/service-instances/79b29ea5-051a-4ab2-af85-fb6520a9f881

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ByodServiceInstance+

ByodServiceInstance (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
deployment_mode	Deployment Mode Deployment mode specifies where the partner appliance will be deployed in HA or non-HA i.e standalone mode.	string	Required Enum: STAND_ALONE, ACTIVE_STANDBY Default: "ACTIVE_STANDBY"
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
id	Unique identifier of this resource	string	Sortable
on_failure_policy	On Failure Policy Failure policy of the service instance - if it has to be different from the service. By default the service instance inherits the FailurePolicy of the service it belongs to.	string	Enum: ALLOW, BLOCK
resource_type	Must be set to the value ByodServiceInstance	ServiceInstanceResourceType	Required
service_id	Service Id The Service to which the service instance is associated.	string	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
transport_type	Transport Type Transport to be used by this service instance for deploying the Service-VM. This field is to be set Not Applicable(NA) if the service only caters to functionality EPP(Endpoint Protection) and MPS.	string	Required Enum: L2_BRIDGE, L3_ROUTED, NSH, NA

ServiceInstance+

ServiceInstance (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
attachment_point	Attachment Point Attachment point to be used by this service instance for deploying the Service-VM.	string	Required Enum: TIER0_LR, TIER1_LR, SERVICE_PLANE, HOST
deployed_to	Deployed-to object list List of resource references where service instance be deployed. Ex. Tier 0 Logical Router in case of N-S ServiceInsertion.	array of ResourceReference	Required Minimum items: 1 Maximum items: 128
deployment_mode	Deployment Mode Deployment mode specifies where the partner appliance will be deployed in HA or non-HA i.e standalone mode.	string	Required Enum: STAND_ALONE, ACTIVE_STANDBY Default: "ACTIVE_STANDBY"
deployment_spec_name	Deployment Spec Name Name of the deployment spec to be used by this service instance.	string	Required
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
id	Unique identifier of this resource	string	Sortable
implementation_type	Implementation Type Implementation to be used by this service instance for deploying the Service-VM.	string	Required Enum: NORTH_SOUTH, EAST_WEST
instance_deployment_config	Instance Deployment Config Instance Deployment Config contains the information to be injected during Service-VM deployment. This field is optional if the service only caters to functionality EPP(Endpoint Protection) and MPS.	InstanceDeploymentConfig
instance_deployment_template	Instance Deployment Template The deployment template to be used by this service instance. The attribute values specific to this instance can be added.	DeploymentTemplate	Required
on_failure_policy	On Failure Policy Failure policy of the service instance - if it has to be different from the service. By default the service instance inherits the FailurePolicy of the service it belongs to.	string	Enum: ALLOW, BLOCK
resource_type	Must be set to the value ServiceInstance	ServiceInstanceResourceType	Required
service_deployment_id	Id of the Service Deployment using which the instances were deployed Id of the Service Deployment using which the instances were deployed. Its available only for instances that were deployed using service deployment API.	string	Readonly
service_id	Service Id The Service to which the service instance is associated.	string	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
transport_type	Transport Type Transport to be used by this service instance for deploying the Service-VM. This field is to be set Not Applicable(NA) if the service only caters to functionality EPP(Endpoint Protection) and MPS.	string	Required Enum: L2_BRIDGE, L3_ROUTED, NSH, NA

VirtualServiceInstance+

VirtualServiceInstance (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
id	Unique identifier of this resource	string	Sortable
on_failure_policy	On Failure Policy Failure policy of the service instance - if it has to be different from the service. By default the service instance inherits the FailurePolicy of the service it belongs to.	string	Enum: ALLOW, BLOCK
resource_type	Must be set to the value VirtualServiceInstance	ServiceInstanceResourceType	Required
service_id	Service Id The Service to which the service instance is associated.	string	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
transport_type	Transport Type Transport to be used by this service instance for deploying the Service-VM. This field is to be set Not Applicable(NA) if the service only caters to functionality EPP(Endpoint Protection) and MPS.	string	Required Enum: L2_BRIDGE, L3_ROUTED, NSH, NA

Example Response:

{ "resource_type": "ServiceInstance", "description": "This Service Instance is deployed at T0 router", "id": "79b29ea5-051a-4ab2-af85-fb6520a9f881", "display_name": "NS Service_Instance_for_ABC", "attachment_point": "TIER0_LR", "deployed_to": [{ "is_valid": true, "target_display_name": "Active-LR", "target_id": "ea9ae885-d3ec-4acc-8194-d5d96dc569cd", "target_type": "LogicalRouter" }], "deployment_mode": "STAND_ALONE", "deployment_spec_name": "NS_DepSpec", "implementation_type": "NORTH_SOUTH", "instance_deployment_config": { "compute_id": "domain-c8", "context_id": "44a18335-e72d-4c77-a0b1-7a922c5e086c", "storage_id": "datastore-12", "vm_nic_infos": [{ "nic_infos": [{ "ip_address": "10.33.79.64", "gateway_address": "10.33.79.66", "subnet_mask": "255.255.255.252", "network_id": "network-16", "nic_metadata": { "interface_label": "eth", "interface_index": 0, "interface_type": "MANAGEMENT" } }, { "nic_metadata": { "interface_label": "eth", "interface_index": 1, "interface_type": "DATA1" } }, { "nic_metadata": { "interface_label": "eth", "interface_index": 2, "interface_type": "DATA2" } } ] }] }, "on_failure_policy": "BLOCK", "service_id": "0ae2295d-d7dc-4b62-94ef-3a02bb2bf2c0", "transport_type": "L2_BRIDGE", "instance_deployment_template": { "name": "NS_DepTemp", "attributes": [{ "attribute_type": "STRING", "display_name": "License", "key": "ABC_HA_License", "value": "adklfjakldfjlkajfkl" }] }, "_create_user": "admin", "_create_time": 1525889020946, "_last_modified_user": "admin", "_last_modified_time": 1525889025093, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 0 }

Required Permissions:

read

Feature:

service_insertion_config

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