NSX-T Data Center REST API

Get NSgroups for a given ServiceProfile. (Deprecated)

Returns list of NSGroups used in Service Insertion rules for a given Service Profile.
Deprecated: This API has been deprecated, for East-West service insertion and chaining at the edge, please use below Policy API
GET /policy/api/v1/infra/service-references/<service-reference-id>/service-profiles/<service-profile-id>/group-associations

Request:

Method:

GET

URI Path(s):

/api/v1/serviceinsertion/services/{service-id}/service-profiles/{service-profile-id}/nsgroups

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

n/a

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ServiceProfileNSGroups+

ServiceProfileNSGroups (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
nsroups	NSGroup List List of NSGroups Used in ServiceInsertion Rules.	array of NSGroupInfo	Readonly
resource_type	Must be set to the value ServiceProfileNSGroups	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "resource_type": "ServiceProfileNSGroups", "id": "SP-34ab3b14-5b73-424b-b521-6d1cabd7c151", "display_name": "SP-34ab3b14-5b73-424b-b521-6d1cabd7c151", "nsgroups":[ { "nsgroup":{ "target_display_name":"Grp1", "is_valid":true, "target_type":"NSGroup", "target_id":"d4ecb8de-57e7-4809-b93a-f2f6991ad5ad" }, "nsgroup_policy_path":"/infra/domains/cgw/groups/multiple-expr-1" } ], "_create_time": 1530770939580, "_last_modified_user": "admin", "_system_owned": false, "_protection": "NOT_PROTECTED", "_create_user": "admin", "_last_modified_time": 1530770939345, "_revision": 2 }

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