executeNodeAction

For those unfamiliar with installing and managing Gateway Nodes, this operation is a robust operation that allows several maintenance options for managing your Gateway Nodes.  For those familiar with managing Gateway Nodes, this operation is a glorified proxy for the APIGateway executable.

Environment/Instance Properties

Property NameProperty CodeRequiredDescription
Oracle API Platform AccountFDOAP_CLOUD_ACCOUNT_CODEYThe Oracle API Platform cloud account to use for this operation. 
Oracle Gateway Install HomeFDOAP_GATEWAY_INSTALL_HOMEY

Absolute location of where to install the gateway node configuration.  This is where the executable and libraries will be located.  This should be empty prior to running this operation.  

Note that this is different compared to the 'nodeInstallDir' property in the gateway-props.json

Node Weblogic UserFDOAP_NODE_WL_ADMIN_USERYWeblogic admin user to configure when creating the node.  Oracle API Platform Nodes are weblogic servers and this is your admin user.
Node Weblogic PasswordFDOAP_NODE_WL_ADMIN_PASSWORDYWeblogic admin password to configure when creating the node.

Inputs

Input NameInput CodeRequiredDescription
Gateway FileFDOAP_INP_GATEWAY_NODEPROPS_FILENoGateway node properties file to use for execution.  Relative to the artifacts directory.  If left blank then the default of 'gateway-props.json' will be used in the Gateway Install Home.
Node ActionFDOAP_INP_NODE_ACTIONYesThe node action to execute.  This can be anything from 'start' or 'stop' the node to updating oauth credentials.  

Artifacts

This operation delegates the consume/produce artifacts decision to the workflow developer.


Endpoint Selection

This operation will select all available endpoints associated to the environment instance which have resource type of Oracle API Platform Node Server.


Endpoint Execution

This operation will select all available endpoints associated to the environment instance which have resource type of Oracle API Platform Node Server.


Special Considerations

Gateway File (gateway-props.json)

Checkout the installNode Special Considerations for information on the gateway-props.json