Get State
Returns
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/state
Query Parameters
Query Parameters
string
cursor
Optional
Opaque cursor to be used for getting next page of records (supplied by current result page)
string
enforcement_point_path
Optional
Enforcement point path
string
included_fields
Optional
Comma separated list of fields that should be included in query result
string
interface_path
Optional
Interface path for interface specific state such as IPv6 DAD state
integer
page_size
Optional
Maximum number of results to return in this page (server may return fewer)
boolean
sort_ascending
Optional
This parameter has no documentation
string
sort_by
Optional
Field by which records are sorted
Response
Response
Response BodyResponse Body
200 OK returns
Tier0GatewayState of type(s) application/json
{
"enforcement_point_path": "string",
"ipv6_status": [
{
"dad_statuses": [
{
"ip_address": "string",
"status": "string",
"transport_node": [
{
"is_valid": false,
"target_display_name": "string",
"target_id": "string",
"target_type": "string"
}
]
}
],
"interface_id": "string"
}
],
"tier0_state": {},
"tier0_status": {
"last_update_timestamp": 0,
"logical_router_id": "string",
"per_node_status": [
{
"high_availability_status": "string",
"service_router_id": "string",
"transport_node_id": "string"
}
]
}
}
string
enforcement_point_path
Optional
String Path of the enforcement point. When not specified, routes from all enforcement-points are returned.
cURL Command
curl https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/state
Errors
BadRequest
400
The request cannot be fulfilled due to bad syntax.
Forbidden
403
The server understood the request, but is refusing to fulfill it.
404
Not Found
PreconditionFailed
412
This error has no documentation
InternalServerError
500
The server encountered an unexpected condition which prevented it from fulfilling the request.
ServiceUnavailable
503
The server is currently unavailable (because it is overloaded or down for maintenance).