Get Realized Entity
Get realized entity uniquely identified by realized path, specified by query parameter
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/realized-state/realized-entity
Query Parameters
Query Parameters
string
realized_path
Required
String Path of the realized object
Response
Response
Response BodyResponse Body
200 OK returns
GenericPolicyRealizedResource
{
"_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"
}
]
}
integer
_create_time
Optional
Timestamp of resource creation
string
_create_user
Optional
ID of the user who created this resource
integer
_last_modified_time
Optional
Timestamp of last modification
string
_last_modified_user
Optional
ID of the user who last modified this resource
array of
ResourceLink
_links
Optional
The server will populate this field when returing the resource. Ignored on PUT and POST.
string
_protection
Optional
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.
integer
_revision
Optional
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.
string
_schema
Optional
Schema for this resource
boolean
_system_owned
Optional
Indicates system owned resource
string
description
Optional
Description of this resource
string
display_name
Optional
Defaults to ID if not set
string
entity_type
Optional
Type of realized entity
string
id
Optional
Unique identifier of this resource
array of
string
intent_paths
Optional
Collection of intent paths
array of
string
intent_reference
Optional
Desire state paths of this object
string
parent_path
Optional
Path of its parent
string
path
Optional
Absolute path of this object
string
realization_api
Optional
Realization API of this object on enforcement point
string
realization_specific_identifier
Optional
Realization id of this object
string
relative_path
Optional
Path relative from its parent
string
resource_type
Optional
The type of this resource.
string
runtime_error
Optional
It define the root cause for runtime error.
string
runtime_status
Optional
Possible values could be UP, DOWN, UNKNOWN, DEGRADED This list is not exhaustive.
string
state
Optional
Realization state of this object
Possible values are: UNAVAILABLE, UNREALIZED, REALIZED, ERROR
cURL Command
curl https://nsxmanager.your.domain/policy/api/v1/infra/realized-state/realized-entity?realized_path=string
Errors
404
The requested resource could not be found but may be available again in the future.
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
503
The server is currently unavailable (because it is overloaded or down for maintenance).
