NSX-T Data Center REST API

Get ResourceReference objects to which the given resource belongs to (Deprecated)

Returns information about resources that are associated with the given
resource. Id and type of the resource for which associated resources are
to be fetched are to be specified as query parameter in the URI. Resource
type of the associated resources must be specified as query
parameter.
Deprecated: This API is deprecated. Please use below policy API /infra/virtual-machine-group-associations?vm_external_id=<ext-id> /infra/virtual-network-interface-group-associations?vif_external_id=<ext-id> /infra/ip-address-group-associations?ip_address=10.1.19.10 /infra/group-associations?intent_path=<intent-path> to get policy groups associated with the given resource.

Request:

Method:

GET

URI Path(s):

/api/v1/associations

Request Headers:

n/a

Query Parameters:

AssociationListRequestParameters+

AssociationListRequestParameters (schema)

Name	Description	Type	Notes
associated_resource_type	Type of the associated resources	AssociationTargetType	Required
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
fetch_ancestors	Fetch complete list of associated resources considering containment and nesting If set to true, will fetch direct as well as indirect(considering containment as well as nesting) associated objects for the given source Id.	boolean	Default: "False"
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"
resource_id	The resource for which associated resources are to be fetched	string	Required
resource_type	Type of the resource for which associated resources are to be fetched	AssociationSourceType	Required
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

bf250578-c0a5-4ca0-b237-0375966d23ce&resource_type=MACSet&associated_resource_type=NSGroup

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

AssociationListResult+

AssociationListResult (schema)

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 ResourceReference	array of ResourceReference	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:

{ "sort_by": "displayName", "sort_ascending": true, "result_count": 1, "results": [ { "target_type": "NSGroup", "target_display_name": "testNSGroup", "target_id": "4f3ba7e3-4876-45ef-882a-34bdcb1a1ac8" } ] }

Required Permissions:

read

Feature:

groups_groups

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable