NSX-T Data Center REST API

Get Effective Profiles for an Entity

Returns the effective profiles applied to the specified Resource.

Request:

Method:

GET

URI Path(s):

/api/v1/service-configs/effective-profiles

Request Headers:

n/a

Query Parameters:

EffectiveProfileRequestParameters+

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
included_fields	Comma separated list of fields that should be included in query result Note - this parameter currently only works when used with the search APIs /policy/api/v1/search/query and /policy/api/v1/search/dsl. It is ignored for other list APIs.	string
page_size	Maximum number of results to return in this page (server may return fewer)	integer	Minimum: 0 Maximum: 1000 Default: "1000"
profile_type	Fetch effectivw profiles of the given profile_type	string
resource_id	The resource for which the effective profiles are to be fetched	string	Required
resource_type	Type of the resource for which effective profiles are to be fetched	EffectiveProfileResourceType	Required
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/service-configs/effective-profiles? resource_id=144e372b-854c-4fcc-a24e-05721ce89a60&resource_type=NSGroup

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

EffectiveProfileListResult+

Name	Description	Type	Notes
_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
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string	Readonly
result_count	Count of results found (across all pages), set only on first page	integer	Readonly
results	Paged Collection of profiles which are applied to an Entity	array of NSXProfileReference	Required
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "cursor": "00012", "sort_ascending": true, "result_count": 2, "results": [ { "profile_type":"FirewallSessionTimerProfile", "target_id":"183e372b-854c-4fcc-a24e-05721ce89a45", "target_name":"Firewall Session Timer Profile "is_valid":true }, { "profile_type":"FirewallCpuMemThresholdsProfile", "target_id":"5678372b-854c-4fcc-a24e-05721ce89a45", "target_name":"Firewall CPU Profile "is_valid":true }, ] }

NSX-T Data Center REST API

Get Effective Profiles for an Entity

Request:

EffectiveProfileRequestParameters (schema)

Example Request:

Successful Response:

EffectiveProfileListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: