NSX-T Data Center REST API

Get a particular ServiceProfile for a Service. (Deprecated)

Returns detailed service profile information for a given Service.
Deprecated: This API has been deprecated, please use below Policy API
GET /policy/api/v1/infra/service-references/<service-reference-id>/service-profiles/<service-profile-id>

Request:

Method:

GET

URI Path(s):

/api/v1/serviceinsertion/services/<service-id>/service-profiles/<service-profile-id>

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/serviceinsertion/services/103ca1c3-ef39-4473-aaec-9a8d764a9392/service-profiles/38b87e06-cb4d-4568-9be0-59be8ab12df9

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

BaseServiceProfile+

BaseServiceProfile (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
resource_type	Must be set to the value BaseServiceProfile	string	Required
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

GiServiceProfile+

GiServiceProfile (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
resource_type	Must be set to the value GiServiceProfile	string	Required
service_id	Service Id The service to which the service profile belongs.	string	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
vendor_template_id	Vendor template Id ID of the vendor template, created by partner while registering the service.	string	Required
vendor_template_key	Vendor template key Different VMs in data center can have Different protection levels as specified by administrator in the policy. The identifier for the policy with which the partner appliance identifies this policy. This identifier will be passed to the partner appliance at runtime to specify which protection level is applicable for the VM being protected.	string	Readonly

ServiceInsertionServiceProfile+

ServiceInsertionServiceProfile (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
attributes	Service profile attributes List of attributes specific to a partner for which the service is created. These attributes are passed on to the partner appliance and are opaque to the NSX Manager. If a vendor template exposes configurables, then the values are specified here.	array of Attribute	Maximum items: 128
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
redirection_action	Redirection action The redirection action represents if the packet is exclusively redirected to the service, or if a copy is forwarded to the service. The service insertion profile inherits the redirection action if already specified at the vendor template. However the service profile cannot overide the action specified at the vendor template.	string	Enum: PUNT, COPY Default: "PUNT"
resource_type	Must be set to the value ServiceInsertionServiceProfile	string	Required
service_id	Service Id The service to which the service profile belongs.	string	Readonly
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30
vendor_template_id	Vendor template id Id of the vendor template to be used by the servive profile.	string	Required

Example Response:

{ "vendor_template_id": "e8420012-6861-4c41-b13c-1aba8c98f007", "attributes": [ { "key": "Key 2", "display_name": "attribute2", "value": "Name 2", "attribute_type": "STRING" }, { "key": "Key 1", "display_name": "attribute1", "value": "Name 1", "attribute_type": "STRING" } ], "redirection_action": "PUNT", "service_id": "103ca1c3-ef39-4473-aaec-9a8d764a9392", "resource_type": "ServiceInsertionServiceProfile", "id": "38b87e06-cb4d-4568-9be0-59be8ab12df9", "display_name": "Service_Profile_1", "description": "ABC Company Service Profile 1", "_create_user": "admin", "_create_time": 1546634208000, "_last_modified_user": "admin", "_last_modified_time": 1546634208000, "_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