Salesforce

Bash API endpoint: getEngineInstanceList

Printable View
« Go Back
Information
Bash API endpoint: getEngineInstanceList
000007408
Public
Product Selection
aiWare - API
Article Details

Get engines instances with filtering

Example

aiware getEngineInstanceList X-Correlation-Id:value  engineInstanceIDs=value  engineIDs=value  hostIDs=value  workRequestIDs=value  status=value  drain=value  launchStartTime=value  launchEndTime=value  modifiedBefore=value  modifiedAfter=value  CreatedBefore=value  CreatedAfter=value  offset=value  limit=value  direction=value  orderBy=value

Parameters

NameTypeDescriptionNotes
xCorrelationIdstringCorrelation 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]
engineInstanceIDsstringField to provide the input to get engine instances by ID list. Separated by commas[optional] [default to null]
engineIDsstringField to provide the input to get engines by Engine ID list. Separated by commas[optional] [default to null]
hostIDsstringFiltering engine instances by host IDs. Separated by commas[optional] [default to null]
workRequestIDsstringFilters engine instances by workrequest IDs. Separated by commas[optional] [default to null]
statusEngineStatusEnumField to match the current status[optional] [default to null]
drainbooleanFilter by drain[optional] [default to null]
launchStartTimeintegerThe unix timestamp, describing a lower limit for the time an engine instance was launched.[optional] [default to null]
launchEndTimeintegerThe unix timestamp, describing an upper limit for the time an engine instance was launched.[optional] [default to null]
modifiedBeforeintegerFilter by items modified before expressed as timestamp[optional] [default to null]
modifiedAfterintegerFilter by items modified after expressed as timestamp[optional] [default to null]
createdBeforeintegerFilter items where created date is before this date[optional] [default to null]
createdAfterintegerFilter items where created date is after this date[optional] [default to null]
offsetintegerthe number of data to skip before getting the result set[optional] [default to null]
limitintegerthe number of items to return.[optional] [default to 10]
directionstringthe sort order. ASC or DESC.[optional] [default to DESC]
orderBystringIt should be in [engineID, hostID, status, createdTime, modifiedTime, lastUpdateTime, launchTime][optional] [default to null]

Return type

GetEngineInstanceListResponse

Authorization

api_key

HTTP request headers

  • Content-Type: Not Applicable
  • Accept: application/json
Additional Technical Documentation Information
Properties
2/3/2025 7:40 PM
2/3/2025 7:41 PM
2/3/2025 7:41 PM
Documentation
Documentation
000007408
Translation Information
English
Powered by