This provides a list of hosts in the system
Example
aiware getHosts X-Correlation-Id:value offset=value limit=value direction=value isactive=value type=value serverType=value startCreatedTime=value endCreatedTime=value startLastUpdateTime=value endLastUpdateTime=value startTerminatedTime=value endTerminatedTime=value startExpireTime=value endExpireTime=value orderBy=value drain=value serverTypeID=value ip=value excludeCommit=value
Parameters
| Name | Type | Description | Notes |
|---|
| xCorrelationId | string | Correlation Id that can be passed, traced in the server and will be returned in the response if present in the request | [optional] [default to null] |
| offset | integer | the number of data to skip before getting the result set | [optional] [default to null] |
| limit | integer | the number of items to return. | [optional] [default to 10] |
| direction | string | the sort order. ASC or DESC. | [optional] [default to DESC] |
| isactive | boolean | Filter for active or inactive hosts | [optional] [default to null] |
| type | RunModeEnum | Filter for hosts by type | [optional] [default to null] |
| serverType | string | Filter for server type. Currently it should be in [physical, virtual]. It can expand in the future | [optional] [default to null] |
| startCreatedTime | integer | The unix timestamp | [optional] [default to null] |
| endCreatedTime | integer | The unix timestamp | [optional] [default to null] |
| startLastUpdateTime | integer | The unix timestamp | [optional] [default to null] |
| endLastUpdateTime | integer | The unix timestamp | [optional] [default to null] |
| startTerminatedTime | integer | The unix timestamp | [optional] [default to null] |
| endTerminatedTime | integer | The unix timestamp | [optional] [default to null] |
| startExpireTime | integer | The unix timestamp | [optional] [default to null] |
| endExpireTime | integer | The unix timestamp | [optional] [default to null] |
| orderBy | string | It should be in [createdTime, terminatedTime, expireTime] | [optional] [default to null] |
| drain | boolean | Filter by drain | [optional] [default to null] |
| serverTypeID | string | Filter by serverTypeID | [optional] [default to null] |
| ip | string | Filter by IP | [optional] [default to null] |
| excludeCommit | string | commit hash to exclude | [optional] [default to null] |
Return type
AdminHostsGetResponse
Authorization
api_key
- Content-Type: Not Applicable
- Accept: application/json
