GetEngineInstanceListResponse GetEngineInstanceList(ctx, optional)
Get engines instances with filtering
Required Parameters
| Name | Type | Description | Notes |
|---|
| ctx | context.Context | context for authentication, logging, cancellation, deadlines, tracing, etc. | |
| optional | *GetEngineInstanceListOpts | optional parameters | nil if no parameters |
Optional Parameters
Optional parameters are passed through a pointer to a GetEngineInstanceListOpts structÂ
|
| Name | Type | Description | Notes |
|---|
| xCorrelationId | optional.String | Correlation Id that can be passed, traced in the server and will be returned in the response if present in the request | |
| engineInstanceIDs | optional.String | Field to provide the input to get engine instances by ID list. Separated by commas | |
| engineIDs | optional.String | Field to provide the input to get engines by Engine ID list. Separated by commas | |
| hostIDs | optional.Interface of string | Filtering engine instances by host IDs. Separated by commas | |
| workRequestIDs | optional.Interface of string | Filters engine instances by workrequest IDs. Separated by commas | |
| status | optional.Interface of EngineStatusEnum | Field to match the current status | |
| drain | optional.Bool | Filter by drain | |
| launchStartTime | optional.Int64 | The unix timestamp, describing a lower limit for the time an engine instance was launched. | |
| launchEndTime | optional.Int64 | The unix timestamp, describing an upper limit for the time an engine instance was launched. | |
| modifiedBefore | optional.Int64 | Filter by items modified before expressed as timestamp | |
| modifiedAfter | optional.Int64 | Filter by items modified after expressed as timestamp | |
| createdBefore | optional.Int64 | Filter items where created date is before this date | |
| createdAfter | optional.Int64 | Filter items where created date is after this date | |
| offset | optional.Int64 | the number of data to skip before getting the result set | |
| limit | optional.Int64 | the number of items to return. | [default to 10] |
| direction | optional.String | the sort order. ASC or DESC. | [default to DESC] |
| orderBy | optional.String | It should be in [engineID, hostID, status, createdTime, modifiedTime, lastUpdateTime, launchTime] |
Return type
GetEngineInstanceListResponse
Authorization
api_key
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
