Get Realized Entity

Required	Parameter Name	Type	Description
required	realized_path	string	String Path of the realized object

{
    "_create_time": 0,
    "_create_user": "string",
    "_last_modified_time": 0,
    "_last_modified_user": "string",
    "_links": [
        {
            "action": "string",
            "href": "string",
            "rel": "string"
        }
    ],
    "_protection": "string",
    "_revision": 0,
    "_schema": "string",
    "_self": {
        "action": "string",
        "href": "string",
        "rel": "string"
    },
    "_system_owned": false,
    "alarms": [
        {
            "_create_time": 0,
            "_create_user": "string",
            "_last_modified_time": 0,
            "_last_modified_user": "string",
            "_links": [
                {
                    "action": "string",
                    "href": "string",
                    "rel": "string"
                }
            ],
            "_protection": "string",
            "_revision": 0,
            "_schema": "string",
            "_self": {
                "action": "string",
                "href": "string",
                "rel": "string"
            },
            "_system_owned": false,
            "description": "string",
            "display_name": "string",
            "error_details": {
                "details": "string",
                "error_code": 0,
                "error_message": "string",
                "module_name": "string",
                "related_errors": [
                    {
                        "details": "string",
                        "error_code": 0,
                        "error_message": "string",
                        "module_name": "string"
                    }
                ]
            },
            "id": "string",
            "message": "string",
            "parent_path": "string",
            "path": "string",
            "relative_path": "string",
            "resource_type": "string",
            "source_reference": "string",
            "tags": [
                {
                    "scope": "string",
                    "tag": "string"
                }
            ]
        }
    ],
    "description": "string",
    "display_name": "string",
    "entity_type": "string",
    "extended_attributes": [
        {
            "data_type": "string",
            "key": "string",
            "multivalue": false,
            "values": [
                "string"
            ]
        }
    ],
    "id": "string",
    "intent_paths": [
        "string"
    ],
    "intent_reference": [
        "string"
    ],
    "parent_path": "string",
    "path": "string",
    "realization_api": "string",
    "realization_specific_identifier": "string",
    "relative_path": "string",
    "resource_type": "string",
    "runtime_error": "string",
    "runtime_status": "string",
    "state": "string",
    "tags": [
        {
            "scope": "string",
            "tag": "string"
        }
    ]
}

Property Name	Type	Description
_create_time	integer	Timestamp of resource creation
_create_user	string	ID of the user who created this resource
_last_modified_time	integer	Timestamp of last modification
_last_modified_user	string	ID of the user who last modified this resource
_links	array of ResourceLink	The server will populate this field when returing the resource. Ignored on PUT and POST.
_protection	string	Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.
_revision	integer	The _revision property describes the current revision of the resource. To prevent clients from overwriting each other’s changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.
_schema	string	Schema for this resource
_self	SelfResourceLink	Link to this resource
_system_owned	boolean	Indicates system owned resource
alarms	array of PolicyAlarmResource	Alarm info detail
description	string	Description of this resource
display_name	string	Defaults to ID if not set
entity_type	string	Type of realized entity
extended_attributes	array of AttributeVal	Collection of type specific properties
id	string	Unique identifier of this resource
intent_paths	array of string	Collection of intent paths
intent_reference	array of string	Desire state paths of this object
parent_path	string	Path of its parent
path	string	Absolute path of this object
realization_api	string	Realization API of this object on enforcement point
realization_specific_identifier	string	Realization id of this object
relative_path	string	Path relative from its parent
resource_type	string	The type of this resource.
runtime_error	string	It define the root cause for runtime error.
runtime_status	string	Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive.
state	string	Realization state of this object Possible values are: ERROR, REALIZED, UNAVAILABLE, UNREALIZED
tags	array of Tag	Opaque identifiers meaningful to the API user

cURL Command

curl https://nsxmanager.your.domain/policy/api/v1/infra/realized-state/realized-entity?realized_path=string

Errors

Code	Returns	Description
412	PreconditionFailed	Not available
500	InternalServerError	The server encountered an unexpected condition which prevented it from fulfilling the request.
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.

Realized Entities Operations

get

Get Realized Entity

get

List Realized Entities

post

Refresh Realized Entities

Get Realized Entity

On This Page

Request

URL

Query Parameters

Response

Response Body

cURL Command

Errors

On This Page

Realized Entities Operations

Was this page helpful?