Ports
List all ports.
get/v1/ports
Query parameters
limitinteger
Requests a page size of items. Returns a number of items up to a limit value. Use the limit parameter to make an initial limited request and use the ID of the last-seen item from the response as the marker parameter value in a subsequent limited request.
offsetinteger
Used in conjunction with limit to return a slice of items. offset is where to start in the list.
sortstring
Example:sort=name:desc,id:asc
Comma-separated list of sort keys and optional sort directions in the form of key:val
namestring
The port name
idstring
Database ID created for a port.
native_port_idstring
Actual ID of the port in the storage backend.
storage_idstring
Database ID created for a storage backend.
connection_status'connected' | 'disconnected' | 'unknown'
The port connection_status
health_status'normal' | 'abnormal' | 'unknown'
The port health_status
Response
List port query was success
Example response
{
"ports": [
{
"id": "084bf71e-a102-11e7-88a8-e31fe6d52248",
"created_at": "2017-07-10T14:36:58.014Z",
"updated_at": "2017-07-10T14:36:58.014Z",
"storage_id": "084bf71e-a102-11e7-88a8-e31fe6d52248",
"native_port_id": "Port_A",
"native_parent_id": "Controller_A"
}
]
}