NSX-T Data Center REST API

Get metadata proxy status

Request:

Method:

GET

URI Path(s):

/policy/api/v1/infra/metadata-proxies/{metadata-proxy-id}/status
/policy/api/v1/global-infra/metadata-proxies/{metadata-proxy-id}/status

Request Headers:

n/a

Query Parameters:

MetadataProxyRuntimeRequestParameters+

MetadataProxyRuntimeRequestParameters (schema)

Name	Description	Type	Notes
enforcement_point_path	String Path of the enforcement point enforcement point path, forward slashes must be escaped using %2F.	string
segment_path	String Path of the segment which is associated with this metadata proxy	string
source	The data source, either realtime or cached. If not provided, cached data is returned.	DataSourceType

Request Body:

n/a

Example Request:

https://{{nsx-mgr}}/api/v1/md-proxies/8966db98-e2ca-4757-af3b-330755ca3e94/6b169af5-4579-481d-a886-9ef7846a7603/status

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

PolicyMetadataProxyStatus+

PolicyMetadataProxyStatus (schema)

Name	Description	Type	Notes
error_message	Error message, if available	string
proxy_status	UP means the metadata proxy is working fine on both transport-nodes(if configured); DOWN means the metadata proxy is is down on both transport-nodes(if configured), hence the metadata proxy will not repsond to any metadata request; Error means there is an error on transport-node(s) or no status is reported from transport-node(s). The metadata proxy may be working (or not working); NO_BACK means metadata proxy is working on one of the transport node while not in the other transport-node (if configured). If the metadata proxy on the working transport-node goes down, the metadata proxy will go down.	string	Required Enum: UP, DOWN, ERROR, NO_BACKUP
transport_nodes	ids of transport nodes where this metadata proxy is running Order of the transport nodes is insensitive because Metadata Proxy is running in Active-Active mode among target transport nodes.	array of string	Required

Example Response:

{ "transport_nodes": [ "12176406-a7c9-11ea-8166-020063c85974", "a831390e-a7c8-11ea-9102-020063e79023" ], "proxy_status": "DOWN", "error_message": "ErrorCode: INTERNAL_ERROR, Detail: backend nova server connection is broken with reason: UNKNOWN;; ErrorCode: INTERNAL_ERROR, Detail: backend nova server connection is broken with reason: UNKNOWN;" }

Required Permissions:

read

Feature:

policy_segment

Additional Errors:

• 404 Not Found
• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable