Retrieve scope associations for discovered resources

Request:

Method:

GET

URI Path(s):

/api/v1/fabric/scope-associations

Request Headers:

n/a

Query Parameters:

ScopeAssociationListRequestParameters+

ScopeAssociationListRequestParameters (schema)

Name	Description	Type	Notes
cursor	Opaque cursor to be used for getting next page of records (supplied by current result page)	string
discovered_resource_external_id	External id of the discovered resource External id of the discovered resource for which association is being queried.	string
discovered_resource_type	Type of the discovered resource Type of the discovered resource for which association is being queried.	string	Enum: VirtualMachine, ComputeCollection
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"
scope_id	Id of the associated scope Id of the scope the associations for which are being queried.	string
scope_type	Type of the associated scope Type of the scope the associations for which are being queried.	string	Enum: VPC, Project
sort_ascending		boolean
sort_by	Field by which records are sorted	string

Request Body:

n/a

Example Request:

GET https://<nsx-mgr>/api/v1/fabric/scope-associations

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

ScopeAssociationListResult+

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	List of scope associations for discovered resources	array of ScopeAssociation
sort_ascending	If true, results are sorted in ascending order	boolean	Readonly
sort_by	Field by which records are sorted	string	Readonly

Example Response:

{ "results" : [ { "scope_id" : "/tenant-root/tenants/t-1/accounts/a-1/vhcs/vhc-1", "scope_type" : "VPC", "resource_type" : "ScopeAssociation", "external_id" : "502edb00-ccd9-0cbb-b70c-cd78f1ce537f", "discovered_resource_type" : "VirtualMachine", "_create_time" : 1620392593345, "_last_modified_time" : 1620392593345, "_create_user" : "system", "_last_modified_user" : "system", "_revision" : 0 } ], "result_count" : 1 }

Retrieve scope associations for discovered resources

Request:

ScopeAssociationListRequestParameters (schema)

Example Request:

Successful Response:

ScopeAssociationListResult (schema)

Example Response:

Required Permissions:

Feature:

Additional Errors: