NSX-T Data Center REST API

Get list of realized objects associated with intent object

Get list of realized entities associated with intent object,
specified by path in query parameter

Request:

Method:
GET
URI Path(s):
/policy/api/v1/infra/realized-state/realized-entities
/policy/api/v1/global-infra/realized-state/realized-entities
/policy/api/v1/orgs/{org-id}/projects/{project-id}/infra/realized-state/realized-entities
Request Headers:
n/a
Query Parameters:
IntentPathRequestParameter+
Request Body:
n/a

Example Request:

GET https://<policy-mgr>/policy/api/v1/infra/realized-state/realized-entities?intent_path=/infra/domains/d1/groups/g1

Successful Response:

Response Code:
200 OK
Response Headers:
Content-type: application/json
Response Body:
GenericPolicyRealizedResourceListResult+

Example Response:

{ "result_count": 1, "results": [ { "resource_type": "GenericPolicyRealizedResource", "id": "DOMAIN-d1-g1", "display_name": "DOMAIN-d1-g1", "path": "/infra/realized-state/enforcement-points/nsx-1/groups/nsgroups/DOMAIN-d1-g1", "parent_path": "/infra/realized-state/enforcement-points/nsx-1", "relative_path": "DOMAIN-d1-g1", "intent_reference": [ "/infra/domains/d1/groups/g1" ], "realization_specific_identifier": "22db5ae1-f1d7-4fa0-aa98-6176a3b80d0d", "alarms": [], "state": "REALIZED", "runtime_status": "UNKNOWN", "publish_status": "UNKNOWN", "operational_status" : "UNKNOWN", "extended_attributes": [ { "values": [ "/infra/realized-state/enforcement-points/nsx-1/virtual-machines/564d1fb9-f50d-5533-d189-550394ba7252", "/infra/realized-state/enforcement-points/nsx-1/virtual-machines/564d2588-5ccf-7825-32f9-d5e1f344fe40", "/infra/realized-state/enforcement-points/nsx-1/virtual-machines/564d6341-5655-5cdb-2a90-fad1b762789b", "/infra/realized-state/enforcement-points/nsx-1/virtual-machines/564d922d-f3cb-ae5c-3e3d-d76a55990905" ], "data_type": "STRING", "key": "VIRTUAL_MACHINES", "multivalue": true } ], "entity_type": "RealizedGroup", "_create_user": "system", "_create_time": 1519051314478, "_last_modified_user": "admin", "_last_modified_time": 1519057587852, "_system_owned": false, "_protection": "NOT_PROTECTED", "_revision": 5 } ] }

Required Permissions:

read

Feature:

infra_admin

Additional Errors: