Salesforce

Java API endpoint: getEngineInstances

« Go Back
Information
Java API endpoint: getEngineInstances
000008800
Public
Product Selection
aiWare - API
Article Details

GetEngineInstancesResponse getEngineInstances(engineID, xCorrelationId, launchStartTime, launchEndTime, modifiedBefore, modifiedAfter, createdBefore, createdAfter, hostDetail)

Get information about the instances of an engine.

Example

// Import classes:
import com.veritone.aiware.ApiClient;
import com.veritone.aiware.ApiException;
import com.veritone.aiware.Configuration;
import com.veritone.aiware.auth.*;
import com.veritone.aiware.models.*;
import com.veritone.aiware.edge.EngineApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("https://api.aiware.com/edge/v1");
    
    // Configure API key authorization: api_key
    ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key");
    api_key.setApiKey("YOUR API KEY");
    // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
    //api_key.setApiKeyPrefix("Token");

    EngineApi apiInstance = new EngineApi(defaultClient);
    String engineID = "engineID_example"; // String | EngineID of node-red container request
    String xCorrelationId = "xCorrelationId_example"; // String | Correlation Id that can be passed, traced in the server and will be returned in the response if present in the request
    Long launchStartTime = 56L; // Long | The unix timestamp, describing a lower limit for the time an engine instance was launched.
    Long launchEndTime = 56L; // Long | The unix timestamp, describing an upper limit for the time an engine instance was launched.
    Long modifiedBefore = 56L; // Long | Filter by items modified before expressed as timestamp
    Long modifiedAfter = 56L; // Long | Filter by items modified after expressed as timestamp
    Long createdBefore = 56L; // Long | Filter items where created date is before this date
    Long createdAfter = 56L; // Long | Filter items where created date is after this date
    Boolean hostDetail = true; // Boolean | Get engine instances host details
    try {
      GetEngineInstancesResponse result = apiInstance.getEngineInstances(engineID, xCorrelationId, launchStartTime, launchEndTime, modifiedBefore, modifiedAfter, createdBefore, createdAfter, hostDetail);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling EngineApi#getEngineInstances");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Parameters

NameTypeDescriptionNotes
engineIDStringEngineID of node-red container request
xCorrelationIdStringCorrelation Id that can be passed, traced in the server and will be returned in the response if present in the request[optional]
launchStartTimeLongThe unix timestamp, describing a lower limit for the time an engine instance was launched.[optional]
launchEndTimeLongThe unix timestamp, describing an upper limit for the time an engine instance was launched.[optional]
modifiedBeforeLongFilter by items modified before expressed as timestamp[optional]
modifiedAfterLongFilter by items modified after expressed as timestamp[optional]
createdBeforeLongFilter items where created date is before this date[optional]
createdAfterLongFilter items where created date is after this date[optional]
hostDetailBooleanGet engine instances host details[optional]

Return type

GetEngineInstancesResponse

Authorization

api_key

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

HTTP response details

Status codeDescriptionResponse headers
200Successful operation* X-Aiware-Version -
* X-Correlation-Id -
400Invalid argument. Please see the error response for more information.* X-Aiware-Version -
* X-Correlation-Id -
401Not authorized* X-Aiware-Version -
* X-Correlation-Id -
403Forbidden* X-Aiware-Version -
* X-Correlation-Id -
404Not Found* X-Aiware-Version -
* X-Correlation-Id -
405The request is not allowed.* X-Aiware-Version -
* X-Correlation-Id -
429Too Many Requests* Retry-After -
* X-Aiware-Version -
* X-Correlation-Id -
501Not Implemented* X-Aiware-Version -
* X-Correlation-Id -
503System Unavailable* Retry-After -
* X-Aiware-Version -
* X-Correlation-Id -

 

Additional Technical Documentation Information
Properties
5/16/2025 10:23 PM
5/16/2025 10:25 PM
5/16/2025 10:25 PM
Documentation
Documentation
000008800
Translation Information
English

Powered by