Read Intent Status

Read Intent Status

Get Consolidated Status of an intent object (with or without enforcement specific status details). The request is evaluated as follows:

: the request is evaluated on all enforcement points for the given intent without enforcement point specific details.
<intent_path, include_enforced_status>: the request is evaluated on all enforcement points for the given intent with enforcement point specific details.

Request

URI

GET

https://nsxmanager.your.domain/policy/api/v1/infra/realized-state/status

COPY

Query Parameters

boolean

include_enforced_status

Optional

Include Enforced Status Flag

string

intent_path

Required

Policy Path of the intent object

Authentication

This operation uses the following authentication methods.

BasicAuth

Responses

200

OK

Returns ConsolidatedRealizedStatus of type(s) application/json

This response body class contains all of the following: AggregatePolicyRuntimeInfo , InlineConsolidatedRealizedStatus1

{
    "intent_path": "string",
    "consolidated_status": {
        "consolidated_status": "string"
    },
    "consolidated_status_per_enforcement_point": [
        {
            "alarm": {
                "error_details": {
                    "related_errors": [
                        {
                            "details": "string",
                            "error_code": 0,
                            "error_message": "string",
                            "module_name": "string"
                        }
                    ]
                },
                "error_id": "string",
                "message": "string"
            },
            "enforcement_point_path": "string",
            "consolidated_status": {
                "consolidated_status": "string"
            },
            "enforcement_point_id": "string"
        }
    ]
}

400

Returns BadRequest of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

403

Returns Forbidden of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

404

Returns NotFound of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

412

Returns PreconditionFailed of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

500

Returns InternalServerError of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

503

Returns ServiceUnavailable of type(s) application/json

This response body class contains all of the following: RelatedApiError , InlineApiError1

{
    "details": "string",
    "error_code": 0,
    "error_message": "string",
    "module_name": "string",
    "related_errors": [
        {
            "details": "string",
            "error_code": 0,
            "error_message": "string",
            "module_name": "string"
        }
    ]
}

On This Page

Request

Query Parameters

200 Response Body

Errors

Realized State Operations

Read Intent Status