Get Tier1 State
Returns
Request
URI
GET
https://nsxmanager.your.domain/policy/api/v1/infra/tier-1s/{tier-1-id}/state
COPY
Path Parameters
string
tier-1-id
Required
tier-1-id
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
sort_ascending
string
sort_by
Optional
Field by which records are sorted
Responses
200
OK
Returns Tier1GatewayState 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"
}
],
"tier1_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"
},
"tier1_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.
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
Not Found
Operation doesn't return any data structure
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"
}
]
}