Developer Documentation
Get State
Returns
Request
URLURL
https://nsxmanager.your.domain/policy/api/v1/infra/tier-0s/{tier-0-id}/state
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Not available |
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| optional |
|
string | Opaque cursor to be used for getting next page of records (supplied by current result page) |
| optional |
|
string | Enforcement point path |
| optional |
|
string | Comma separated list of fields that should be included in query result |
| optional |
|
string | Interface path for interface specific state such as IPv6 DAD state |
| optional |
|
integer | Maximum number of results to return in this page (server may return fewer) |
| optional |
|
boolean | Not available |
| optional |
|
string | Field by which records are sorted |
Response
Response
Response BodyResponse Body
200 OK returns
Tier0GatewayState
{
"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": {
"details": [
{
"failure_code": 0,
"failure_message": "string",
"state": "string",
"sub_system_address": "string",
"sub_system_id": "string",
"sub_system_type": "string"
}
],
"failure_code": 0,
"failure_message": "string",
"state": "string"
},
"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"
}
]
}
}| Property Name | Type | Description |
|---|---|---|
| enforcement_point_path | string |
String Path of the enforcement point. When not specified, routes from all enforcement-points are returned. |
| ipv6_status | array of IPv6Status |
IPv6 DAD status for interfaces configured on Tier0 |
| tier0_state | LogicalRouterState |
Detailed realized state information for Tier0 |
| tier0_status | LogicalRouterStatus |
Detailed realized status information for Tier0 |
Errors
| Code | Returns | Description |
|---|---|---|
| 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 | Not Found |
| 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). |
