List Resource Info

This API provides field names of attributes in NSX types that are owned by Policy, as opposed to those owned by the enforcement point. For any type on NSX, some of the attributes of that type may be owned and set by Policy when realizing the intent, while some others may be owned and set by the enforcement point itself. This information can be used to disable updates to Policy owned attributes by the advanced networking UI, while allowing tweaking to the attributes owned by the management plane.

Request

URL

GET

https://nsxmanager.your.domain/policy/api/v1/fine-tuning/resources

Query Parameters

Required	Parameter Name	Type	Description
optional	cursor	string	Opaque cursor to be used for getting next page of records (supplied by current result page)
optional	include_mark_for_delete_objects	boolean	Include objects that are marked for deletion in results
optional	included_fields	string	Comma separated list of fields that should be included in query result
optional	page_size	integer	Maximum number of results to return in this page (server may return fewer)
optional	sort_ascending	boolean	Not available
optional	sort_by	string	Field by which records are sorted
optional	type	string	Type query

Response

Response Body

200 OK returns ResourceInfoListResult

{
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_schema": "string",
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "cursor": "string",
    "result_count": 0,
    "results": [
        {
            "fields": [
                {
                    "field_name": "string",
                    "sub_type": "PolicyFineTuningResourceInfo Object"
                }
            ],
            "resource_name": "string"
        }
    ],
    "sort_ascending": false,
    "sort_by": "string"
}

Property Name	Type	Description
_links	array of ResourceLink	The server will populate this field when returing the resource. Ignored on PUT and POST.
_schema	string	Schema for this resource
_self	SelfResourceLink	Link to this resource
cursor	string	Opaque cursor to be used for getting next page of records (supplied by current result page)
result_count	integer	Count of results found (across all pages), set only on first page
results	array of PolicyFineTuningResourceInfo	Resource info list results
sort_ascending	boolean	If true, results are sorted in ascending order
sort_by	string	Field by which records are sorted

cURL Command

curl https://nsxmanager.your.domain/policy/api/v1/fine-tuning/resources

Errors

Code	Returns	Description
503	ServiceUnavailable	The server is currently unavailable (because it is overloaded or down for maintenance).
400	BadRequest	The request cannot be fulfilled due to bad syntax.
403	Forbidden	The server understood the request, but is refusing to fulfill it.
404	Nothing	The requested resource could not be found but may be available again in the future.
412	PreconditionFailed	Not available
500	InternalServerError	The server encountered an unexpected condition which prevented it from fulfilling the request.